fix help message comment about options passed
This just a simple fix of a comment in the usage message.
This commit is contained in:
1 parent
246ccbfb0f
commit
b3656d0e6f
11 files changed
+13
-33
No files matched your search
+1
-1
@@ -27,7 +27,7 @@
|
||||
#
|
||||
# bin/quick-readme2html.sh -t readme2html -w https://www.ioccc.org YYYY/dir -v 1
|
||||
#
|
||||
# Only the "-D -t, -T, -p, -w" option set are passed to the tool command line.
|
||||
# Only the "-D -t, -w" option set are passed to the tool command line.
|
||||
# For all other special tool options, pass them as additional tool options (i.e., command line arguments
|
||||
# that follow the 1st command line argument) OR consider simply running the tool directly.
|
||||
#
|
||||
|
||||
+2
-2
@@ -26,7 +26,7 @@
|
||||
#
|
||||
# bin/gen-year-index.sh -w https://www.ioccc.org YYYY -v 1
|
||||
#
|
||||
# Only the "-D -t, -T, -p, -w" option set are passed to the tool command line.
|
||||
# Only the "-D -Q, -t, -w" option set are passed to the tool command line.
|
||||
# For all other special tool options, pass them as additional tool options (i.e., command line arguments
|
||||
# that follow the 1st command line argument) OR consider simply running the tool directly.
|
||||
#
|
||||
@@ -179,7 +179,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
|
||||
tool the tool to run over all entries
|
||||
[more_options] additional tool command line options to use before the YYYY/dir argument
|
||||
|
||||
NOTE: Any '-Q', '-t tagline', '-w site_url'
|
||||
NOTE: Any '-D', '-Q', '-t tagline', '-w site_url'
|
||||
are passed to the 'tool' at the beginning of the command line, and
|
||||
before any optional 'more_options' and before the final YYYY/dir argument.
|
||||
|
||||
|
||||
+1
-4
@@ -184,10 +184,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
|
||||
-w site_url Base URL of the website (def: $SITE_URL)
|
||||
NOTE: The '-w site_url' is passed as leading options on tool command lines.
|
||||
|
||||
NOTE: The '-v level' is passed as initial command line options to the 'markdown to html tool' (md2html.sh).
|
||||
The 'tagline' is passed as '-t tagline' to the 'markdown to html tool' (md2html.sh), after the '-v level'.
|
||||
Any '-P pandoc_opts', '-U top_url'
|
||||
are passed to the 'markdown to html tool' (md2html.sh), and will be before any command line arguments.
|
||||
NOTE: Any '-D docroot/', '-t tagline', '-v level', '-w site_url' are passed to 'md2html.sh' tool.
|
||||
|
||||
Exit codes:
|
||||
0 all OK
|
||||
|
||||
+1
-4
@@ -147,10 +147,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
|
||||
-w site_url Base URL of the website (def: $SITE_URL)
|
||||
NOTE: The '-w site_url' is passed as leading options on tool command lines.
|
||||
|
||||
NOTE: The '-v level' is passed as initial command line options to the 'markdown to html tool' (md2html.sh).
|
||||
The 'tagline' is passed as '-t tagline' to the 'markdown to html tool' (md2html.sh), after the '-v level'.
|
||||
Any '-P pandoc_opts', '-U top_url'
|
||||
are passed to the 'markdown to html tool' (md2html.sh), and will be before any command line arguments.
|
||||
NOTE: Any '-D docroot/', '-t tagline', '-v level', '-w site_url' are passed to 'md2html.sh' tool.
|
||||
|
||||
Exit codes:
|
||||
0 all OK
|
||||
|
||||
@@ -148,9 +148,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
|
||||
-w site_url Base URL of the website (def: $SITE_URL)
|
||||
NOTE: The '-w site_url' is passed as leading options on tool command lines.
|
||||
|
||||
NOTE: Any '-D docroot/', '-t tagline', '-w site_url'
|
||||
are passed to the 'tool' at the beginning of the command line, and
|
||||
before any optional 'more_options' and before the final YYYY/dir argument.
|
||||
NOTE: Any '-D docroot/', '-t tagline', '-w site_url' are passed to 'md2html.sh' tool.
|
||||
|
||||
Exit codes:
|
||||
0 all OK
|
||||
|
||||
+1
-4
@@ -367,10 +367,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-n] [-N]
|
||||
[c | closed] Set the contest_status to closed
|
||||
(def: do not change contest_status)
|
||||
|
||||
NOTE: The '-v level' is passed as initial command line options to the 'markdown to html tool' (md2html.sh).
|
||||
The 'tagline' is passed as '-t tagline' to the 'markdown to html tool' (md2html.sh), after the '-v level'.
|
||||
Any '-P pandoc_opts', '-U top_url'
|
||||
are passed to the 'markdown to html tool' (md2html.sh), and will be before any command line arguments.
|
||||
NOTE: Any '-D docroot/', '-t tagline', '-v level', '-w site_url' are passed to 'md2html.sh' tool.
|
||||
|
||||
Exit codes:
|
||||
0 all OK
|
||||
|
||||
+1
-4
@@ -180,10 +180,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
|
||||
-w site_url Base URL of the website (def: $SITE_URL)
|
||||
NOTE: The '-w site_url' is passed as leading options on tool command lines.
|
||||
|
||||
NOTE: The '-v level' is passed as initial command line options to the 'markdown to html tool' (md2html.sh).
|
||||
The 'tagline' is passed as '-t tagline' to the 'markdown to html tool' (md2html.sh), after the '-v level'.
|
||||
Any '-P pandoc_opts', '-U top_url'
|
||||
are passed to the 'markdown to html tool' (md2html.sh), and will be before any command line arguments.
|
||||
NOTE: Any '-D docroot/', '-t tagline', '-v level', '-w site_url' are passed to 'md2html.sh' tool.
|
||||
|
||||
Exit codes:
|
||||
0 all OK
|
||||
|
||||
@@ -145,6 +145,8 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-n] [-N]
|
||||
YYYY path from topdir to year directory: must contain the files: README.md, .path and .entry.json
|
||||
[more_options] additional tool command line options to use before the YYYY argument
|
||||
|
||||
NOTE: Any '-D docroot/', '-t tagline', '-w site_url' are passed to 'md2html.sh' tool.
|
||||
|
||||
Exit codes:
|
||||
0 all OK
|
||||
1 some internal tool exited non-zero
|
||||
|
||||
+1
-4
@@ -159,10 +159,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
|
||||
-w site_url Base URL of the website (def: $SITE_URL)
|
||||
NOTE: The '-w site_url' is passed as leading options on tool command lines.
|
||||
|
||||
NOTE: The '-v level' is passed as initial command line options to the 'markdown to html tool' (md2html.sh).
|
||||
The 'tagline' is passed as '-t tagline' to the 'markdown to html tool' (md2html.sh), after the '-v level'.
|
||||
Any '-P pandoc_opts', '-U top_url'
|
||||
are passed to the 'markdown to html tool' (md2html.sh), and will be before any command line arguments.
|
||||
NOTE: Any '-D docroot/', '-t tagline', '-v level', '-w site_url' are passed to 'md2html.sh' tool.
|
||||
|
||||
Exit codes:
|
||||
0 all OK
|
||||
|
||||
@@ -164,9 +164,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
|
||||
tool the tool to run over all entries
|
||||
[more_options] additional tool command line options to use before the YYYY/dir argument
|
||||
|
||||
NOTE: Any '-t tagline', '-w site_url'
|
||||
are passed to the 'tool' at the beginning of the command line, and
|
||||
before any optional 'more_options' and before the final YYYY/dir argument.
|
||||
NOTE: Any '-D docroot/', '-t tagline', '-v level', '-w site_url' are passed to 'md2html.sh' tool.
|
||||
|
||||
Exit codes:
|
||||
0 all OK
|
||||
|
||||
+1
-4
@@ -151,10 +151,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
|
||||
|
||||
YYYY/dir path from topdir to entry directory: must contain the files: README.md, .path and .entry.json
|
||||
|
||||
NOTE: The '-v level' is passed as initial command line options to the 'markdown to html tool' (md2html.sh).
|
||||
The 'tagline' is passed as '-t tagline' to the 'markdown to html tool' (md2html.sh), after the '-v level'.
|
||||
Any '-P pandoc_opts', '-U top_url'
|
||||
are passed to the 'markdown to html tool' (md2html.sh), and will be before any command line arguments.
|
||||
NOTE: Any '-d topdir', '-D docroot/', '-t tagline', '-v level', '-w site_url' are passed to 'md2html.sh' tool.
|
||||
|
||||
Exit codes:
|
||||
0 all OK
|
||||
|
||||
Reference in new issue
Block a user