summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorGravatar Mike Burns <mike@mike-burns.com>2015-04-08 10:44:05 +0200
committerGravatar Mike Burns <mike@mike-burns.com>2015-04-08 10:45:53 +0200
commit45071a8baaacb5734409eb0d35335fff1b205936 (patch)
tree61f797b29d1f8a16a927ccc10de3a3a0dd3edabb /man
parent33ff11e941f952200bed9f13ca3136b97ef89faf (diff)
Documentation editing and improvements
Some formatting and more explanatory text. Frost was missing from the rcm(7) credits. While here, bump the version number. Honestly I just had these edits sitting around, unsure for how long.
Diffstat (limited to 'man')
-rw-r--r--man/lsrc.116
-rw-r--r--man/mkrc.16
-rw-r--r--man/rcdn.19
-rw-r--r--man/rcm.7.mustache1
-rw-r--r--man/rcrc.58
-rw-r--r--man/rcup.110
6 files changed, 41 insertions, 9 deletions
diff --git a/man/lsrc.1 b/man/lsrc.1
index b63b8a7..9febe6b 100644
--- a/man/lsrc.1
+++ b/man/lsrc.1
@@ -175,8 +175,22 @@ User configuration file. Defaults to
.Xr rcrc 5 ,
.Xr rcm 7
.Sh AUTHORS
-.An "Mike Burns" Aq mike@mike-burns.com
+.Nm
+is maintained by
+.An "Mike Burns" Aq Mt mburns@thoughtbot.com
+and
+.Lk http://thoughtbot.se thoughtbot
.Sh BUGS
+For OS X systems, we strongly encourage the use of the
+.Va HOSTNAME
+variable in your
+.Xr rcrc 5 .
+We use the
+.Xr hostname 1
+program to determine the unique identifier for the host. This program is
+not specified by POSIX and can vary by system. On OS X the hostname is
+unpredictable, and can even change as part of the DHCP handshake.
+.Pp
There are a few bugs around shell globs. Anything involving an exclude
pattern is unpredictable, so use
.Fl v
diff --git a/man/mkrc.1 b/man/mkrc.1
index 9ac11a7..b280969 100644
--- a/man/mkrc.1
+++ b/man/mkrc.1
@@ -80,4 +80,8 @@ User configuration file. Defaults to
.Xr rcrc 5 ,
.Xr rcm 7
.Sh AUTHORS
-.An "Mike Burns" Aq mike@mike-burns.com
+.Nm
+is maintained by
+.An "Mike Burns" Aq Mt mburns@thoughtbot.com
+and
+.Lk http://thoughtbot.se thoughtbot
diff --git a/man/rcdn.1 b/man/rcdn.1
index 10543e9..04f8fd7 100644
--- a/man/rcdn.1
+++ b/man/rcdn.1
@@ -41,7 +41,8 @@ The
program will run hooks before and after removing files, if these hooks
exist. Hooks are executable programs inside the dotfiles directory, with
the following names:
-.Pa hooks/pre-down and
+.Pa hooks/pre-down
+and
.Pa hooks/post-down .
These hooks are run each time
.Nm
@@ -148,4 +149,8 @@ User configuration file. Defaults to
.Xr rcrc 5 ,
.Xr rcm 7
.Sh AUTHORS
-.An "Mike Burns" Aq mike@mike-burns.com
+.Nm
+is maintained by
+.An "Mike Burns" Aq Mt mburns@thoughtbot.com
+and
+.Lk http://thoughtbot.se thoughtbot
diff --git a/man/rcm.7.mustache b/man/rcm.7.mustache
index 25e4f5c..72e20d0 100644
--- a/man/rcm.7.mustache
+++ b/man/rcm.7.mustache
@@ -136,6 +136,7 @@ in
or use the
.Fl U
option. For example:
+.Pp
.Dl mkrc -U bin
.
.Sh QUICK START FOR EMPTY DOTFILES DIRECTORIES
diff --git a/man/rcrc.5 b/man/rcrc.5
index c692a5d..c74d48d 100644
--- a/man/rcrc.5
+++ b/man/rcrc.5
@@ -37,7 +37,7 @@ the source directories for dotfiles. The first in the list is the
source to which dotfiles created using
.Xr mkrc 1
are installed. The default value is
-.Li ~/.dotfiles
+.Pa ~/.dotfiles
.
.It Va EXCLUDES
a space-separated list of exclude patterns. Exclude patterns are
@@ -91,4 +91,8 @@ under the section
.Xr rcup 1 ,
.Xr rcm 7
.Sh AUTHORS
-.An "Mike Burns" Aq mike@mike-burns.com
+.Nm
+is maintained by
+.An "Mike Burns" Aq Mt mburns@thoughtbot.com
+and
+.Lk http://thoughtbot.se thoughtbot
diff --git a/man/rcup.1 b/man/rcup.1
index 82c0293..26e613d 100644
--- a/man/rcup.1
+++ b/man/rcup.1
@@ -156,8 +156,8 @@ Host-specific files go in a directory named for the host, prefixed with
For example,
.Pa .dotfiles/host-scarlett
contains files specific to the computer with hostname
-.Pa scarlett
-, and these files will only be installed on the computer with hostname
+.Pa scarlett ,
+and these files will only be installed on the computer with hostname
.Pa scarlett .
.Pp
Tagged files go in a directory named for the tag, prefixed with
@@ -249,4 +249,8 @@ User configuration file. Defaults to
.Xr rcrc 5 ,
.Xr rcm 7
.Sh AUTHORS
-.An "Mike Burns" Aq mike@mike-burns.com
+.Nm
+is maintained by
+.An "Mike Burns" Aq Mt mburns@thoughtbot.com
+and
+.Lk http://thoughtbot.se thoughtbot