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 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'man/lsrc.1') 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. . -- cgit v1.2.3