diff options
author | Mike Burns <mike@mike-burns.com> | 2014-03-07 15:22:48 +0100 |
---|---|---|
committer | Mike Burns <mike@mike-burns.com> | 2014-03-07 15:22:48 +0100 |
commit | bf3cad0417d4c96de72f0b221ed145bd54d5cb50 (patch) | |
tree | 30fa238860fdf90a78a26efc5c0c9889ccedbe81 /man | |
parent | d61396f694b4ac201cdfd76765e455fefb31b5e4 (diff) |
Manpage cleanup
* Make sure `rcm` is mentioned in every `.Nd`, so that it will appear in
whatis(1).
* Every `.Bl -tag` must have a `-width`.
* Put the sections in a consistent order, as defined my mandoc.
* A `.Sh` should not be followed by a `.Pp`.
Diffstat (limited to 'man')
-rw-r--r-- | man/lsrc.1 | 2 | ||||
-rw-r--r-- | man/mkrc.1 | 4 | ||||
-rw-r--r-- | man/rcdn.1 | 16 | ||||
-rw-r--r-- | man/rcm.7 | 5 | ||||
-rw-r--r-- | man/rcrc.5 | 2 | ||||
-rw-r--r-- | man/rcup.1 | 4 |
6 files changed, 16 insertions, 17 deletions
@@ -3,7 +3,7 @@ .Os .Sh NAME .Nm lsrc -.Nd show configuration files +.Nd show dotfiles files managed by rcm .Sh SYNOPSIS .Nm lsrc .Op Fl Fvq @@ -3,7 +3,7 @@ .Os .Sh NAME .Nm mkrc -.Nd bless files into a dotfile +.Nd bless files into a dotfile managed by rcm .Sh SYNOPSIS .Nm mkrc .Op Fl Cvqo @@ -17,7 +17,7 @@ different source directory. . It supports these options: . -.Bl -tag +.Bl -tag -width "-d DIR" .It Fl C copy instead of symlinking when installing the rc file back into your home directory @@ -3,7 +3,7 @@ .Os .Sh NAME .Nm rcdn -.Nd remove dotfiles +.Nd remove dotfiles as managed by rcm .Sh SYNOPSIS .Nm rcdn .Op Fl kKvq @@ -42,7 +42,7 @@ These hooks are run each time .Nm is run and therefore must be idempotent. . -.Bl -tag +.Bl -tag -width "-I EXCL_PAT" .It Fl d Ar DIR remove rc files from the .Ar DIR . @@ -85,12 +85,6 @@ for more details. only remove the specified file(s) .El . -.Sh EXAMPLES -.Dl rcdn -v -.Dl rcdn zshrc -.Dl rcdn -t python -.Dl rcdn -d ~/corporate-dotfiles -.Dl rcdn -e '*:.zshrc' .Sh ENVIRONMENT .Bl -tag -width ".Ev RCRC" .It Ev RCRC @@ -99,6 +93,12 @@ User configuration file. Defaults to .El .Sh FILES .Pa ~/.rcrc +.Sh EXAMPLES +.Dl rcdn -v +.Dl rcdn zshrc +.Dl rcdn -t python +.Dl rcdn -d ~/corporate-dotfiles +.Dl rcdn -e '*:.zshrc' .Sh SEE ALSO .Xr lsrc 1 , .Xr mkrc 1 , @@ -22,13 +22,13 @@ files in your home directory and so on .Pc . These files have gone by many -names in history, such as +names in history, such as .Do rc files .Dc because they typically end in .Li rc -or +or .Do dotfiles .Dc @@ -215,7 +215,6 @@ machine. .Dl mkrc -o .rcrc . .Sh RATIONALE -.Pp The rcm suite was built as an abstraction over the shell, Ruby, Python, and make scripts people were writing and sharing. It is intended to run on any unix system and support the range from simple to complex dotfile @@ -28,7 +28,7 @@ and programs. .Pp It supports these variables: -.Bl -tag +.Bl -tag -width "DOTFILES_DIRS" .It Va COPY_ALWAYS always copy files that match the listed globs, never symlink them. . @@ -3,7 +3,7 @@ .Os .Sh NAME .Nm rcup -.Nd update and install dotfiles +.Nd update and install dotfiles managed by rcm .Sh SYNOPSIS .Nm rcup .Op Fl CfikKqv @@ -24,7 +24,7 @@ See for details on the directory layout. .Pp It supports these options: -.Bl -tag +.Bl -tag -width "-x EXCL_PAT" .It Fl C copy the files instead of symlinking them .It Fl d Ar DIR |