Adding variables CONTEXT_HELP and SEQ_PROFILE_NAME to the API documentation

This commit is contained in:
2021-01-31 22:18:57 +01:00
parent 33775ffb1d
commit 3c132ed4e2

View File

@@ -22,6 +22,7 @@ STEP_ARGS=
STEP_RETURN=255 STEP_RETURN=255
MAX_STEP=512 MAX_STEP=512
ALIAS= ALIAS=
CONTEXT_HELP=0
SEQ_CONFIG_NAME=".seqs" SEQ_CONFIG_NAME=".seqs"
SEQ_CONFIG_HOME="$HOME/$SEQ_CONFIG_NAME" SEQ_CONFIG_HOME="$HOME/$SEQ_CONFIG_NAME"
SEQ_CONFIG_FILE= SEQ_CONFIG_FILE=
@@ -87,11 +88,16 @@ sequencer.sh global variables:
\$VERBOSE \$VERBOSE
0 : default 0 : default
1 : Print full command from exe() or exep() before executing 1 : Print full command from exe() or exep() before executing
\$CONTEXT_HELP
0 : normal sequence execution
1 : current run only displays help (-h|-ha)
\$SEQ_CONFIG_HOME \$SEQ_CONFIG_HOME
Path to user specific seq configuration directory Path to user specific seq configuration directory
\$SEQ_CONFIG_FILE \$SEQ_CONFIG_FILE
Path to user specific seq configuration file Path to user specific seq configuration file
Will be empty if unused Will be empty if unused
\$SEQ_PROFILE_NAME
Profile string selected with -p argument
sequencer.sh build-in functions: sequencer.sh build-in functions:
@@ -176,7 +182,6 @@ USAGE_API
echoerr() { >&2 echo "$@"; } echoerr() { >&2 echo "$@"; }
# Echo additional line to info correctly indented # Echo additional line to info correctly indented
CONTEXT_HELP=0
INDENT_HELP=' : ' INDENT_HELP=' : '
INDENTAPPEND_HELP=' ' INDENTAPPEND_HELP=' '
INDENTAPPEND_INFO=' ' INDENTAPPEND_INFO=' '