diff options
author | Mike Burns <mike@mike-burns.com> | 2014-05-09 10:50:41 +0200 |
---|---|---|
committer | Mike Burns <mike@mike-burns.com> | 2014-05-09 13:37:43 +0200 |
commit | 5bcf43b4ea7b263a443b95217e1b50691e316aee (patch) | |
tree | f9505a76688685dc7b3befe4b15189979e683d70 /man/rcdn.1 | |
parent | 13e9775b0575d9399da624024cd710efcdae6bbe (diff) |
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.
Diffstat (limited to 'man/rcdn.1')
-rw-r--r-- | man/rcdn.1 | 11 |
1 files changed, 8 insertions, 3 deletions
@@ -6,10 +6,11 @@ .Nd remove dotfiles as managed by rcm .Sh SYNOPSIS .Nm rcdn -.Op Fl kKvq +.Op Fl hqVv .Op Fl B Ar hostname .Op Fl d Ar dir .Op Fl I Ar excl_pat +.Op Fl S Ar excl_pat .Op Fl t Ar tag .Op Fl x Ar excl_pat .Op Ar files ... @@ -52,6 +53,8 @@ as the host-specific directory instead of computing it remove rc files from the .Ar DIR . This can be specified multiple times. +.It Fl h +show usage instructions. .It Fl I Ar EXCL_PAT remove rc files that match .Ar EXCL_PAT @@ -63,10 +66,10 @@ This can be repeated with additional patterns. See .Xr lsrc 1 , .Sx EXCLUDE PATTERN , for more details. -.It Fl k -run pre- and post-hooks. This is the default. .It Fl K skip pre- and post-hooks +.It Fl k +run pre- and post-hooks. This is the default. .It Fl q decrease verbosity .It Fl S Ar EXCL_PAT @@ -79,6 +82,8 @@ remove dotfiles according to .Ar TAG .It Fl v increase verbosity. This can be repeated for extra verbosity. +.It Fl V +show the version number. .It Fl x Ar EXCL_PAT do not remove rc files that match .Ar EXCL_PAT . |