From 5bcf43b4ea7b263a443b95217e1b50691e316aee Mon Sep 17 00:00:00 2001
From: Mike Burns <mike@mike-burns.com>
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.
---
 bin/lsrc.in | 4 ++--
 bin/mkrc.in | 4 ++--
 bin/rcdn.in | 4 ++--
 bin/rcup.in | 4 ++--
 4 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'bin')

diff --git a/bin/lsrc.in b/bin/lsrc.in
index 760d769..951f3df 100755
--- a/bin/lsrc.in
+++ b/bin/lsrc.in
@@ -212,8 +212,8 @@ is_excluded() {
 show_help() {
   local exit_code=${1:-0}
 
-  $PRINT "Usage: lsrc [-FVqvh] [-I EXCL_PAT] [-x EXCL_PAT] [-N EXCL_PAT ] [-t TAG] [-d DOT_DIR]"
-  $PRINT "see lsrc(1) and rcm(5) for more details"
+  $PRINT "Usage: lsrc [-FhqVv] [-B HOSTNAME] [-d DOT_DIR] [-I EXCL_PAT] [-S EXCL_PAT ] [-t TAG] [-x EXCL_PAT]"
+  $PRINT "see lsrc(1) and rcm(7) for more details"
 
   exit $exit_code
 }
diff --git a/bin/mkrc.in b/bin/mkrc.in
index 7cab210..9af0b6a 100755
--- a/bin/mkrc.in
+++ b/bin/mkrc.in
@@ -23,8 +23,8 @@ destination() {
 show_help() {
   local exit_code=${1:-0}
 
-  $PRINT "Usage: mkrc [-hvqo] [-t TAG] [-d DIR] FILES ..."
-  $PRINT "see mkrc(1) and rcm(5) for more details"
+  $PRINT "Usage: mkrc [-ChSsVvqo] [-t TAG] [-d DIR] [-B HOSTNAME] FILES ..."
+  $PRINT "see mkrc(1) and rcm(7) for more details"
 
   exit $exit_code
 }
diff --git a/bin/rcdn.in b/bin/rcdn.in
index e633f3e..0393f4d 100755
--- a/bin/rcdn.in
+++ b/bin/rcdn.in
@@ -21,8 +21,8 @@ remove_link() {
 show_help() {
   local exit_code=${1:-0}
 
-  $PRINT "Usage: rcdn [-Vqvh] [-I EXCL_PAT] [-x EXCL_PAT] [-t TAG] [-d DOT_DIR]"
-  $PRINT "see rcdn(1) and rcm(5) for more details"
+  $PRINT "Usage: rcdn [-hqVv] [-B HOSTNAME] [-d DOT_DIR] [-I EXCL_PAT] [-S EXCL_PAT] [-t TAG] [-x EXCL_PAT]"
+  $PRINT "see rcdn(1) and rcm(7) for more details"
 
   exit $exit_code
 }
diff --git a/bin/rcup.in b/bin/rcup.in
index 8e541e8..17516b6 100755
--- a/bin/rcup.in
+++ b/bin/rcup.in
@@ -87,8 +87,8 @@ handle_file() {
 show_help() {
   local exit_code=${1:-0}
 
-  $PRINT "Usage: rcup [-CVqvfhikK] [-I EXCL_PAT] [-x EXCL_PAT] [-t TAG] [-d DOT_DIR]"
-  $PRINT "see rcup(1) and rcm(5) for more details"
+  $PRINT "Usage: rcup [-CfhiKkqVv] [-B HOSTNAME] [-d DOT_DIR] [-I EXCL_PAT] [-S EXCL_PAT] [-t TAG] [-x EXCL_PAT]"
+  $PRINT "see rcup(1) and rcm(7) for more details"
 
   exit $exit_code
 }
-- 
cgit v1.2.3