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. --- man/lsrc.1 | 12 +++++++++--- man/mkrc.1 | 12 ++++++++---- man/rcdn.1 | 11 ++++++++--- man/rcup.1 | 19 ++++++++++++------- 4 files changed, 37 insertions(+), 17 deletions(-) (limited to 'man') diff --git a/man/lsrc.1 b/man/lsrc.1 index a0d096c..97fb536 100644 --- a/man/lsrc.1 +++ b/man/lsrc.1 @@ -6,13 +6,13 @@ .Nd show dotfiles files managed by rcm .Sh SYNOPSIS .Nm lsrc -.Op Fl Fvq +.Op Fl FhqVv +.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 Fl N Ar excl_pat -.Op Fl B Ar hostname .Op files ... .Sh DESCRIPTION This program lists all configuration files, both the sources in the @@ -52,6 +52,9 @@ and .Va SYMLINK_DIRS , respectively. . +.It Fl h +show usage instructions. +. .It Fl I Ar excl_pat include the files that match the given pattern. This is applied after any @@ -72,6 +75,9 @@ pattern to prevent the shell from swallowing the glob. .It Fl t Ar TAG list dotfiles according to TAG . +.It Fl V +show the version number. +. .It Fl v increase verbosity. This can be repeated for extra verbosity. . diff --git a/man/mkrc.1 b/man/mkrc.1 index 3101839..687c894 100644 --- a/man/mkrc.1 +++ b/man/mkrc.1 @@ -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" diff --git a/man/rcdn.1 b/man/rcdn.1 index b7f7554..6ac8a2f 100644 --- a/man/rcdn.1 +++ b/man/rcdn.1 @@ -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 . diff --git a/man/rcup.1 b/man/rcup.1 index b487987..684b1fc 100644 --- a/man/rcup.1 +++ b/man/rcup.1 @@ -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 -- cgit v1.2.3