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/mkrc.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/mkrc.1')
| -rw-r--r-- | man/mkrc.1 | 12 |
1 files changed, 8 insertions, 4 deletions
@@ -6,7 +6,7 @@ .Nd bless files into a dotfile managed by rcm .Sh SYNOPSIS .Nm mkrc -.Op Fl Cvqo +.Op Fl ChoqSsVv .Op Fl t Ar tag .Op Fl d Ar dir .Op Fl B Ar hostname @@ -28,10 +28,15 @@ home directory .It Fl d Ar DIR install dotfiles under the specified directory. This can be specified multiple times. +.It Fl h +show usage instructions. .It Fl o install dotfiles into the host-specific directory .It Fl q decrease verbosity +.It Fl S +treat the specified rc files as files to be symlinked, even if they are +directories .It Fl s if the rc file is a file, symlink it; otherwise, make a directory structure as described in @@ -39,13 +44,12 @@ structure as described in in the section .Sx ALGORITHM . This is the default. -.It Fl S -treat the specified rc files as files to be symlinked, even if they are -directories .It Fl t Ar TAG install dotfiles according to tag .It Fl v increase verbosity. This can be repeated for extra verbosity. +.It Fl V +show the version number. .El .Sh ENVIRONMENT .Bl -tag -width ".Ev RCRC" |