From 5bcf43b4ea7b263a443b95217e1b50691e316aee Mon Sep 17 00:00:00 2001 From: Mike Burns Date: Fri, 9 May 2014 10:50:41 +0200 Subject: Update documentation on usage New flags have accumulated without proper care for the usage instructions or man pages. I manually went through each program and verified its usage instruction against its `getopts`, then I alphabeticalized the usage message. Based on the usage message, I then verified the synposis in the manpage. Then, based on the synposis, I alphabeticalized the detailed listing of the arguments and filled in the missing pieces. The `-h` and `-V` arguments were missing from all manpages. In the future we will need to be more careful about this. It would be good to automate a checker that refuses to build unless the docs have all the flags mentioned. --- test/lsrc-usage.t | 4 ++-- test/mkrc-usage.t | 8 ++++---- test/rcup-usage.t | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) (limited to 'test') diff --git a/test/lsrc-usage.t b/test/lsrc-usage.t index 70a3bd8..83c9c21 100644 --- a/test/lsrc-usage.t +++ b/test/lsrc-usage.t @@ -3,5 +3,5 @@ -h should output usage information and exit 0 $ lsrc -h - Usage: lsrc [-FVqvh] [-I EXCL_PAT] [-x EXCL_PAT] [-N EXCL_PAT ] [-t TAG] [-d DOT_DIR] - see lsrc(1) and rcm(5) for more details + Usage: lsrc [-FhqVv] [-B HOSTNAME] [-d DOT_DIR] [-I EXCL_PAT] [-S EXCL_PAT ] [-t TAG] [-x EXCL_PAT] + see lsrc(1) and rcm(7) for more details diff --git a/test/mkrc-usage.t b/test/mkrc-usage.t index c9ede8d..d4f4a9f 100644 --- a/test/mkrc-usage.t +++ b/test/mkrc-usage.t @@ -3,12 +3,12 @@ no arguments should output usage information and exit 1 $ mkrc - Usage: mkrc [-hvqo] [-t TAG] [-d DIR] FILES ... - see mkrc(1) and rcm(5) for more details + Usage: mkrc [-ChSsVvqo] [-t TAG] [-d DIR] [-B HOSTNAME] FILES ... + see mkrc(1) and rcm(7) for more details [1] -h should output usage information and exit 0 $ mkrc -h - Usage: mkrc [-hvqo] [-t TAG] [-d DIR] FILES ... - see mkrc(1) and rcm(5) for more details + Usage: mkrc [-ChSsVvqo] [-t TAG] [-d DIR] [-B HOSTNAME] FILES ... + see mkrc(1) and rcm(7) for more details diff --git a/test/rcup-usage.t b/test/rcup-usage.t index c5b798f..1fa8a5a 100644 --- a/test/rcup-usage.t +++ b/test/rcup-usage.t @@ -3,5 +3,5 @@ -h should output usage information and exit 0 $ rcup -h - Usage: rcup [-CVqvfhikK] [-I EXCL_PAT] [-x EXCL_PAT] [-t TAG] [-d DOT_DIR] - see rcup(1) and rcm(5) for more details + Usage: rcup [-CfhiKkqVv] [-B HOSTNAME] [-d DOT_DIR] [-I EXCL_PAT] [-S EXCL_PAT] [-t TAG] [-x EXCL_PAT] + see rcup(1) and rcm(7) for more details -- cgit v1.2.3