From 2965e066dc432e04418fe18d1fbcc5ad3e9e713b Mon Sep 17 00:00:00 2001 From: Cyrille L Date: Sun, 27 Mar 2022 19:19:26 +0200 Subject: [PATCH] fix: help + readme --- README.md | 55 ++++++++++++++++++++++++++++++++++++++ usr/local/bin/gsl | 2 +- var/lib/gsl/README.md | 55 ++++++++++++++++++++++++++++++++++++++ var/lib/gsl/helps/gsl_help | 4 +-- 4 files changed, 113 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ff588d5..5d656ca 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ can easily get, in your webserver. - bash - coreutils - curl (to check Posts links response) +- rsync # GSL: Installation @@ -242,3 +243,57 @@ Let's start a list 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 +``` diff --git a/usr/local/bin/gsl b/usr/local/bin/gsl index a122264..9ee259d 100755 --- a/usr/local/bin/gsl +++ b/usr/local/bin/gsl @@ -399,7 +399,7 @@ case "$1" in gsl_www_act="$2" case "$2" in add) - gsl_ask="! Put online ALL wip posts (y|N)? " + gsl_ask="! Put online ALL wip posts (yes|N)? " ;; remove) gsl_ask="! REMOVE ALL www posts (yes|N)? " diff --git a/var/lib/gsl/README.md b/var/lib/gsl/README.md index ff588d5..5d656ca 100644 --- a/var/lib/gsl/README.md +++ b/var/lib/gsl/README.md @@ -12,6 +12,7 @@ can easily get, in your webserver. - bash - coreutils - curl (to check Posts links response) +- rsync # GSL: Installation @@ -242,3 +243,57 @@ Let's start a list 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 +``` diff --git a/var/lib/gsl/helps/gsl_help b/var/lib/gsl/helps/gsl_help index ea2fa0d..04ff795 100644 --- a/var/lib/gsl/helps/gsl_help +++ b/var/lib/gsl/helps/gsl_help @@ -24,8 +24,8 @@ $ gsl [ARG] db [FILE] : Show DB statuses from [FILE] sync [OPT] : Sync Templates to www and wip - wip : Only to wip server - www : Only to www server + 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]