From bf3cad0417d4c96de72f0b221ed145bd54d5cb50 Mon Sep 17 00:00:00 2001
From: Mike Burns <mike@mike-burns.com>
Date: Fri, 7 Mar 2014 15:22:48 +0100
Subject: 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`.
---
 man/lsrc.1 |  2 +-
 man/mkrc.1 |  4 ++--
 man/rcdn.1 | 16 ++++++++--------
 man/rcm.7  |  5 ++---
 man/rcrc.5 |  2 +-
 man/rcup.1 |  4 ++--
 6 files changed, 16 insertions(+), 17 deletions(-)

(limited to 'man')

diff --git a/man/lsrc.1 b/man/lsrc.1
index 98109e8..ad4368f 100644
--- a/man/lsrc.1
+++ b/man/lsrc.1
@@ -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
diff --git a/man/mkrc.1 b/man/mkrc.1
index adc4089..4e274bf 100644
--- a/man/mkrc.1
+++ b/man/mkrc.1
@@ -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
diff --git a/man/rcdn.1 b/man/rcdn.1
index a276b76..fa0b60b 100644
--- a/man/rcdn.1
+++ b/man/rcdn.1
@@ -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 ,
diff --git a/man/rcm.7 b/man/rcm.7
index 06d4c90..1b39eae 100644
--- a/man/rcm.7
+++ b/man/rcm.7
@@ -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
diff --git a/man/rcrc.5 b/man/rcrc.5
index ca6e22e..3872795 100644
--- a/man/rcrc.5
+++ b/man/rcrc.5
@@ -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.
 .
diff --git a/man/rcup.1 b/man/rcup.1
index 41e25fd..60e36ae 100644
--- a/man/rcup.1
+++ b/man/rcup.1
@@ -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
-- 
cgit v1.2.3