fix: help + readme

This commit is contained in:
Cyrille L 2022-03-27 19:19:26 +02:00
parent bf7069ae59
commit 2965e066dc
4 changed files with 113 additions and 3 deletions

View File

@ -12,6 +12,7 @@ can easily get, in your webserver.
- bash - bash
- coreutils - coreutils
- curl (to check Posts links response) - curl (to check Posts links response)
- rsync
# GSL: Installation # GSL: Installation
@ -242,3 +243,57 @@ Let's start a list
This list is ended This list is ended
) )
``` ```
# HELP COMMAND
```
$ gsl [ARG]
readme : Show README.md instructions
help | -h [OPT] : This Help
install : Show process installation
new : Adding a DOMAIN
write | -w : How to write a Post
new | -N : Add and configure a new DOMAIN
log | -L [OPTS] : Show logs from all sessions
clean | -C : Logs saved to {DATE}.gsl.log and cleaned
-i | -w | -e : from levels (infos, warnings, errors)
-s : from last session only
[TERM] : [TERM] : case insensitive, regex 'T1.*T2'
(i.e. $ gsl log -e -s code)
author | -A [OPT] : List authors from DOMAIN set in PWD folder
add : Add author(s) for DOMAIN
remove : Remove author(s) for DOMAIN
edit | -E [FILE] [APP] : Open in default EDITOR [FILE] or with APP
db [FILE] : Show DB statuses from [FILE]
sync [OPT] : Sync Templates to www and wip
wip : Only to wip server (also done with make)
www : Only to www server (also done with www)
check | -C [OPT] [FILE] : Check Posts errors from PWD folder or [FILE]
-F : Force check again
make | -M [OPT] [FILE] : Convert Posts from PWD folder or [FILE]
to HTML file in server
-F : Force Make again
post-list [OPT] [FILE] : Add post again from [FILE] to Last-Posts List
(When converting new post, it will be added)
Pin : Set Post from [FILE] to first in Last-Posts List
Add : Add Post from [FILE] to last in Last-Posts List
www [OPT1] [OPT2] : Add/Remove Post from www server
[OPT1]:
add : Add all/[FILE] to www server
rmove : remove all/[FILE] from www server
[OPT2]:
all : Select all post with wip statuses
[FILE] : Select specific post (if wip status)
version | -v : Show local versionn
-vv : Shown local and repo Versions
```

View File

@ -399,7 +399,7 @@ case "$1" in
gsl_www_act="$2" gsl_www_act="$2"
case "$2" in case "$2" in
add) add)
gsl_ask="! Put online ALL wip posts (y|N)? " gsl_ask="! Put online ALL wip posts (yes|N)? "
;; ;;
remove) remove)
gsl_ask="! REMOVE ALL www posts (yes|N)? " gsl_ask="! REMOVE ALL www posts (yes|N)? "

View File

@ -12,6 +12,7 @@ can easily get, in your webserver.
- bash - bash
- coreutils - coreutils
- curl (to check Posts links response) - curl (to check Posts links response)
- rsync
# GSL: Installation # GSL: Installation
@ -242,3 +243,57 @@ Let's start a list
This list is ended This list is ended
) )
``` ```
# HELP COMMAND
```
$ gsl [ARG]
readme : Show README.md instructions
help | -h [OPT] : This Help
install : Show process installation
new : Adding a DOMAIN
write | -w : How to write a Post
new | -N : Add and configure a new DOMAIN
log | -L [OPTS] : Show logs from all sessions
clean | -C : Logs saved to {DATE}.gsl.log and cleaned
-i | -w | -e : from levels (infos, warnings, errors)
-s : from last session only
[TERM] : [TERM] : case insensitive, regex 'T1.*T2'
(i.e. $ gsl log -e -s code)
author | -A [OPT] : List authors from DOMAIN set in PWD folder
add : Add author(s) for DOMAIN
remove : Remove author(s) for DOMAIN
edit | -E [FILE] [APP] : Open in default EDITOR [FILE] or with APP
db [FILE] : Show DB statuses from [FILE]
sync [OPT] : Sync Templates to www and wip
wip : Only to wip server (also done with make)
www : Only to www server (also done with www)
check | -C [OPT] [FILE] : Check Posts errors from PWD folder or [FILE]
-F : Force check again
make | -M [OPT] [FILE] : Convert Posts from PWD folder or [FILE]
to HTML file in server
-F : Force Make again
post-list [OPT] [FILE] : Add post again from [FILE] to Last-Posts List
(When converting new post, it will be added)
Pin : Set Post from [FILE] to first in Last-Posts List
Add : Add Post from [FILE] to last in Last-Posts List
www [OPT1] [OPT2] : Add/Remove Post from www server
[OPT1]:
add : Add all/[FILE] to www server
rmove : remove all/[FILE] from www server
[OPT2]:
all : Select all post with wip statuses
[FILE] : Select specific post (if wip status)
version | -v : Show local versionn
-vv : Shown local and repo Versions
```

View File

@ -24,8 +24,8 @@ $ gsl [ARG]
db [FILE] : Show DB statuses from [FILE] db [FILE] : Show DB statuses from [FILE]
sync [OPT] : Sync Templates to www and wip sync [OPT] : Sync Templates to www and wip
wip : Only to wip server wip : Only to wip server (also done with make)
www : Only to www server www : Only to www server (also done with www)
check | -C [OPT] [FILE] : Check Posts errors from PWD folder or [FILE] check | -C [OPT] [FILE] : Check Posts errors from PWD folder or [FILE]