Reorg to directories

Author: joelparkerhenderson

README.md

@@ -6,20 +6,20 @@ This guide is by SixArm.com, a software consultancy. Our customers use shell scr
 
 Highlights:
 
-  * [Aim for POSIX when possible because of portability and standardization](doc/aim-for-posix.md)
-  * [Protect scripts by using `set` flags such as `set -euf`](doc/protect-scripts-by-using-set-flags.md)
-  * [Print output with `printf` not `echo`](doc/print-output-with-printf-not-echo.md)
-  * [Trap signals and exit by using `trap trap_exit EXIT`](doc/trap-signals-and-exit.md)
-  * [Run executable with no file name extension](doc/run-executable-with-no-file-name-extension.md)
-  * [Source with dot operator `.` not keyword `source`](doc/source-with-dot-operator-not-keyword-source.md)
-  * [for arg do loop](doc/for-arg-do-loop.md)
-  * [Parse options via `while` and `case` not `getopts` or `getopt`](doc/parse-options-via-while-and-case-not-getopts-or-getopt.md)
-  * [Version name: use semantic versioning](doc/version-name-use-semantic-versioning.md)
-  * [Help: use a function and HERE document](doc/help-use-a-function-and-here-document.md)
-  * [Date & time format: use UTC and ISO8601](doc/date-time-format-use-utc-and-iso8601.md)
-  * [Booleans: use true and false](doc/booleans-use-true-and-false.md)
-  * [Subshells: use parentheses `$()` not backticks](doc/subshells-use-parentheses-not-backticks.md)
-  * [Trace using set -x then set +x without printing](doc/trace-using-set-x-then-set-x-without-printing.md)
+  * [Aim for POSIX when possible because of portability and standardization](doc/aim-for-posix)
+  * [Protect scripts by using `set` flags such as `set -euf`](doc/protect-scripts-by-using-set-flags)
+  * [Print output with `printf` not `echo`](doc/print-output-with-printf-not-echo)
+  * [Trap signals and exit by using `trap trap_exit EXIT`](doc/trap-signals-and-exit)
+  * [Run executable with no file name extension](doc/run-executable-with-no-file-name-extension)
+  * [Source with dot operator `.` not keyword `source`](doc/source-with-dot-operator-not-keyword-source)
+  * [for arg do loop](doc/for-arg-do-loop)
+  * [Parse options via `while…case` not `getopts/getopt`](doc/parse-options-via-while-and-case-not-getopts-or-getopt)
+  * [Version name: use semantic versioning](doc/version-name-use-semantic-versioning)
+  * [Help: use a function and HERE document](doc/help-use-a-function-and-here-document)
+  * [Date & time format: use UTC and ISO8601](doc/date-time-format-use-utc-and-iso8601)
+  * [Booleans: use true and false](doc/booleans-use-true-and-false)
+  * [Subshells: use parentheses `$()` not backticks](doc/subshells-use-parentheses-not-backticks)
+  * [Trace using set -x then set +x without printing](doc/trace-using-set-x-then-set-x-without-printing)
   * [Hunt for bugs by using ShellCheck](https://www.shellcheck.net)
   * [Fix some bugs automatically, if you want, by using Shellharden](https://github.com/anordal/shellharden)
 
@@ -38,33 +38,33 @@ Demo:
 
 ## Topics
 
-Argumemt parsing:
+Argument parsing:
 
-  * [Arg parse](doc/arg-parse.md)
-  * [Parse options via `while` and `case` not `getopts` or `getopt`](doc/parse-options-via-while-and-case-not-getopts-or-getopt.md)
+  * [Arg parse](doc/arg-parse)
+  * [Parse options via `while` and `case` not `getopts` or `getopt`](doc/parse-options-via-while-and-case-not-getopts-or-getopt)
 
 Environment variables:
 
-  * [Test if set or unset](doc/environment-variables/test-if-set-or-unset.md)
-  * [$FUNCNAME function name](doc/environment-variables/funcname-function-name.md)
+  * [Test if set or unset](doc/environment-variables/test-if-set-or-unset)
+  * [$FUNCNAME function name](doc/environment-variables/funcname-function-name)
 
 Directories:
 
-  * [Script directory](doc/directories/script-directory.md)
-  * [Log directory: use $LOG_HOME](doc/directories/cache-directory-use-log-home.md)
-  * [Data directory: use $XDG_DATA_HOME](doc/directories/data-directory-use-xdg-data-home.md)
-  * [Cache directory: use $XDG_CACHE_HOME](doc/directories/cache-directory-use-xdg-cache-home.md)
-  * [Configuration directory: use $XDG_CONFIG_HOME](doc/directories/configuration-directory-use-xdg-config-home.md)
-  * [Runtime directory: use $XDG_RUNTIME_HOME](doc/directories/runtime-directory-use-xdg-runtime-home.md)
-  * [Temporary directory:: use `mktemp`](doc/directories/temporary-directory-use-mktemp.md)
+  * [Script directory](doc/directories/script-directory)
+  * [Log directory: use $LOG_HOME](doc/directories/cache-directory-use-log-home)
+  * [Data directory: use $XDG_DATA_HOME](doc/directories/data-directory-use-xdg-data-home)
+  * [Cache directory: use $XDG_CACHE_HOME](doc/directories/cache-directory-use-xdg-cache-home)
+  * [Configuration directory: use $XDG_CONFIG_HOME](doc/directories/configuration-directory-use-xdg-config-home)
+  * [Runtime directory: use $XDG_RUNTIME_HOME](doc/directories/runtime-directory-use-xdg-runtime-home)
+  * [Temporary directory:: use `mktemp`](doc/directories/temporary-directory-use-mktemp)
 
 Files:
 
-  * [Temporary file using `mktemp` and `trap`](doc/temporary-file-using-mktemp-and-trap.md)
-  * [Find files with filter for permission denied](doc/find-files-with-filter-for-permission-denied.md)
-  * [Find files with special characters](doc/find-files-with-special-characters.md)
-  * [Find files with readable permissions](doc/find-files-with-readable-permissions.md)
-  * [Find files with executable, perm, test, exec](doc/find-files-with-executable-perm-test-exec.md)
+  * [Temporary file using `mktemp` and `trap`](doc/temporary-file-using-mktemp-and-trap)
+  * [Find files with filter for permission denied](doc/find-files-with-filter-for-permission-denied)
+  * [Find files with special characters](doc/find-files-with-special-characters)
+  * [Find files with readable permissions](doc/find-files-with-readable-permissions)
+  * [Find files with executable, perm, test, exec](doc/find-files-with-executable-perm-test-exec)
 
 References:
 
@@ -78,35 +78,35 @@ References:
 
 Conventions:
 
-  * [Program name using a string or basename](doc/program-name-using-a-string-or-basename.md)
-  * [Program directory using pwd and dirname](doc/program-directory-using-pwd-andr-basename.md)
-  * [Functions: out, err, die, big, log, now, sec, zid, cmd, etc.](doc/functions-out-err-die-big-log-now-sec-zid-cmd-etc.md)
-  * [Assert functions: assert_empty, assert_equal, assert_match](doc/assert-functions.md)
-  * [sec() function portability](doc/sec-function-portability.md)
+  * [Program name using a string or basename](doc/program-name-using-a-string-or-basename)
+  * [Program directory using pwd and dirname](doc/program-directory-using-pwd-andr-basename)
+  * [Functions: out, err, die, big, log, now, sec, zid, cmd, etc.](doc/functions-out-err-die-big-log-now-sec-zid-cmd-etc)
+  * [Assert functions: assert_empty, assert_equal, assert_match](doc/assert-functions)
+  * [sec() function portability](doc/sec-function-portability)
 
 Control flow statements:
 
-  * [While loop with index counter](doc/while-loop-with-index-counter.md)
-  * [Do while loop](doc/do-while-loop.md)
-  * [Case statement that skips option dash flags](doc/case-statement-that-skips-option-dash-flags.md)
+  * [While loop with index counter](doc/while-loop-with-index-counter)
+  * [Do while loop](doc/do-while-loop)
+  * [Case statement that skips option dash flags](doc/case-statement-that-skips-option-dash-flags)
 
 Functions:
 
-  * [Export function](doc/export-function.md)
-  * [Number functions](doc/number-functions.md)
-  * [Array functions](doc/array-functions.md)
-  * [URL encode and URL decode](doc/url-encode-and-url-decode.md)
+  * [Export function](doc/export-function)
+  * [Number functions](doc/number-functions)
+  * [Array functions](doc/array-functions)
+  * [URL encode and URL decode](doc/url-encode-and-url-decode)
 
 Command snippets:
 
-  * [awk match_between](doc/awk-match-between.md)
+  * [awk match_between](doc/awk-match-between)
 
 Compatibilities:
 
-  * [`readlink` on macOS behaves differently](doc/readlink-on-macos-behaves-differently.md)
-  * [`realpath` is` not available on macOS default](doc/realpath-is-not-available-on-macos-default.md)
+  * [`readlink` on macOS behaves differently](doc/readlink-on-macos-behaves-differently)
+  * [`realpath` is` not available on macOS default](doc/realpath-is-not-available-on-macos-default)
 
 PostgreSQL psql:
 
-  * [psql helpers](doc/psql-helpers.md)
+  * [psql helpers](doc/psql-helpers)
 

book/Makefile

@@ -0,0 +1,17 @@
+top = $(shell git rev-parse --show-toplevel)
+key = $(shell basename ${top})
+
+all: build.md ${key}.pdf
+
+new: clean all
+
+.PHONY: clean
+clean:
+	rm -f build.md ${key}.pdf
+
+build.md:
+	echo "top:${top}"
+	book-binder start.yml links.md build.md "${top}" "https://github.com/sixarm/unix-shell-script-tactics/doc/"
+
+${key}.pdf:
+	pandoc-from-markdown-to-pdf build.md -o ${key}.pdf