Differences

This shows you the differences between two versions of the page.

--- decentbash [2016/01/01 01:23] – [Error messages] admin
+++ unixscripts:3-decentbash [2020/10/17 03:04] – ↷ Page moved and renamed from decentbash to unixscripts:3-decentbash admin
@@ Line 13: / Line 13: @@
 ====Use argp.sh(1)====
-Even better, use my **getopt**(1) wrapper [[argp.sh]] which is kinda sorta like GNU's **argp**(3) in glibc. It gives you a single place to define options which is then used to:
+Even better, use my **getopt**(1) wrapper [[unixscripts:2-argp.sh]] which is kinda sorta like GNU's **argp**(3) in glibc. It gives you a single place to define options which is then used to:
       * create the **getopt**(1) command line,
       * process the options setting appropriate environment parameters
@@ Line 26: / Line 26: @@
 ====Provide help====
-respond to the **-h, --help** option with a usage message to **!!!STDOUT!!!** and exit 0
+respond to the **-h, --help** option with a usage message to **!!!STDOUT!!!** and exit 0. This help should be available no matter what the machine's state - so issue it before looking for dependencies and without making assumptions about what is installed.
+If there are specific dependencies, then make sure they are documented in the help message.
 ====Provide version info====
@@ Line 36: / Line 38: @@
 Error messages should go to **!!!STDERR!!!** - do **not** print the usage as it just fills the screen and hides the meat of the error. At the most, refer the user to the usage page with ''run 'foobar -h' for help or 'man foobar' for a reference manual.''
-====Error exit====
+====Be disciplined with error exit codes====
 non-zero exit on any error
@@ Line 47: / Line 49: @@
 include a man page if non-trivial
-====crunchbang====
+====Use a crunchbang====
 always include the //crunchbang// as the first line: