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/rcup.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/rcup.1')
| -rw-r--r-- | man/rcup.1 | 19 |
1 files changed, 12 insertions, 7 deletions
@@ -6,10 +6,11 @@ .Nd update and install dotfiles managed by rcm .Sh SYNOPSIS .Nm rcup -.Op Fl CfikKqv +.Op Fl CfhiKkqVv .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 ... @@ -40,10 +41,8 @@ This can be specified multiple times. if the rc file already exists in your home directory but does not match the file in your dotfiles directory, remove the rc file then create the symlink -.It Fl i -if the rc file already exists in your home directory but does not match -the file in your dotfiles directory, prompt for how to handle it. This -is the default +.It Fl h +show usage instructions. .It Fl I Ar EXCL_PAT install rc files that match .Ar EXCL_PAT @@ -55,12 +54,16 @@ This can be repeated with additional patterns. See .Xr lsrc 1 , .Sx EXCLUDE PATTERN , for more details. +.It Fl i +if the rc file already exists in your home directory but does not match +the file in your dotfiles directory, prompt for how to handle it. This +is the default +.It Fl K +skip pre- and post-hooks .It Fl k run pre- and post-hooks (see .Sx DIRECTORY LAYOUT for more details on hooks). This is the default. -.It Fl K -skip pre- and post-hooks .It Fl S Ar EXCL_PAT any rc file that matches .Ar EXCL_PAT @@ -71,6 +74,8 @@ install dotfiles according to .Ar TAG .It Fl q decrease verbosity +.It Fl V +show the version number. .It Fl v increase verbosity. This can be repeated for extra verbosity. .It Fl x Ar EXCL_PAT |