diff --git a/bin/all-run.sh b/bin/all-run.sh index 17a6f3a23..9b106fb72 100755 --- a/bin/all-run.sh +++ b/bin/all-run.sh @@ -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. # diff --git a/bin/all-years.sh b/bin/all-years.sh index 81fa909bc..c5061f651 100755 --- a/bin/all-years.sh +++ b/bin/all-years.sh @@ -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. diff --git a/bin/gen-authors.sh b/bin/gen-authors.sh index b3a25cd79..c7da3df3f 100755 --- a/bin/gen-authors.sh +++ b/bin/gen-authors.sh @@ -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 diff --git a/bin/gen-location.sh b/bin/gen-location.sh index 132fc1310..25a727262 100755 --- a/bin/gen-location.sh +++ b/bin/gen-location.sh @@ -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 diff --git a/bin/gen-other-html.sh b/bin/gen-other-html.sh index 04ac82ec4..3ccecc749 100755 --- a/bin/gen-other-html.sh +++ b/bin/gen-other-html.sh @@ -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 diff --git a/bin/gen-status.sh b/bin/gen-status.sh index 11ed4ec5c..b76a7166a 100755 --- a/bin/gen-status.sh +++ b/bin/gen-status.sh @@ -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 diff --git a/bin/gen-top-html.sh b/bin/gen-top-html.sh index 771ea1407..ef7fb08d2 100755 --- a/bin/gen-top-html.sh +++ b/bin/gen-top-html.sh @@ -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 diff --git a/bin/gen-year-index.sh b/bin/gen-year-index.sh index a3bb8e066..c3b4cdf9e 100755 --- a/bin/gen-year-index.sh +++ b/bin/gen-year-index.sh @@ -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 diff --git a/bin/gen-years.sh b/bin/gen-years.sh index 0ad9ce4e8..6a15a5ab1 100755 --- a/bin/gen-years.sh +++ b/bin/gen-years.sh @@ -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 diff --git a/bin/quick-readme2index.sh b/bin/quick-readme2index.sh index 8b6d4ee8e..101132943 100755 --- a/bin/quick-readme2index.sh +++ b/bin/quick-readme2index.sh @@ -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 diff --git a/bin/readme2index.sh b/bin/readme2index.sh index 8133f8905..7af3f61be 100755 --- a/bin/readme2index.sh +++ b/bin/readme2index.sh @@ -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