From 45071a8baaacb5734409eb0d35335fff1b205936 Mon Sep 17 00:00:00 2001 From: Mike Burns Date: Wed, 8 Apr 2015 10:44:05 +0200 Subject: [PATCH] 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. --- .mailmap | 1 + configure.ac | 2 +- man/lsrc.1 | 16 +++++++++++++++- man/mkrc.1 | 6 +++++- man/rcdn.1 | 9 +++++++-- man/rcm.7.mustache | 1 + man/rcrc.5 | 8 ++++++-- man/rcup.1 | 10 +++++++--- 8 files changed, 43 insertions(+), 10 deletions(-) diff --git a/.mailmap b/.mailmap index 8e4a87ca..49fcdc43 100644 --- a/.mailmap +++ b/.mailmap @@ -5,3 +5,4 @@ Melissa Xie Mike Burns Pablo Olmos de Aguilera Corradini Patrick Brisbin +Martin Frost diff --git a/configure.ac b/configure.ac index e96552b6..22c96806 100644 --- a/configure.ac +++ b/configure.ac @@ -2,7 +2,7 @@ # Process this file with autoconf to produce a configure script. AC_PREREQ([2.69]) -AC_INIT(rcm, 1.2.3, mburns@thoughtbot.com) +AC_INIT(rcm, 1.2.4, mburns@thoughtbot.com) AM_INIT_AUTOMAKE # Checks for programs. diff --git a/man/lsrc.1 b/man/lsrc.1 index b63b8a7d..9febe6bb 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 9ac11a70..b2809693 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 10543e9e..04f8fd75 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 25e4f5c8..72e20d0b 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 c692a5d7..c74d48d3 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 82c02933..26e613da 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