summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Mike Burns <mike@mike-burns.com>2013-06-07 16:49:00 +0200
committerGravatar Mike Burns <mike@mike-burns.com>2013-06-07 16:49:00 +0200
commit0f1fbc3c0458355917a79cb4e76925573562bda1 (patch)
treeb979488b64778f3904f2b1d00863be6ed53f7faf
parent8f293bebc40c367793eac9c6af49c41c083c5533 (diff)
Introduce a manpage for rcrc(5)
Document the `.rcrc` dotfile. So far it only supports `TAGS`.
-rw-r--r--Makefile1
-rw-r--r--man/man5/rcrc.534
2 files changed, 35 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index db53829..ea8483e 100644
--- a/Makefile
+++ b/Makefile
@@ -5,5 +5,6 @@ install:
install -m 0755 bin/rcup $(PREFIX)/bin
install -m 0644 man/man1/rcup.1 $(PREFIX)/share/man/man1
install -m 0644 man/man1/mkrc.1 $(PREFIX)/share/man/man1
+ install -m 0644 man/man5/rcrc.5 $(PREFIX)/share/man/man1
.PHONY: install
diff --git a/man/man5/rcrc.5 b/man/man5/rcrc.5
new file mode 100644
index 0000000..1032504
--- /dev/null
+++ b/man/man5/rcrc.5
@@ -0,0 +1,34 @@
+.TH rcrc "5" "June 2013" "rcm"
+
+.SH NAME
+rcrc \- configuration for rcm
+
+
+.SH DESCRIPTION
+
+The rcm dotfile manager can be configured using a \fI.rcrc\fR file in
+your home directory. The format is POSIX shell, and it is sourced in by
+the \fBrcup\fR and \fBmkrc\fR programs.
+
+It supports these variables:
+
+.TP
+\fBTAGS\fR
+the default tags used by \fBrcup\fR\|.
+
+.SH EXAMPLES
+
+\&\fBTAGS="freebsd development email git laptop gmail notmuch"\fR
+
+.SH AUTHOR
+
+Written by Mike Burns.
+
+.SH FILES
+
+.I ~/.rcrc
+.I ~/.dotfiles
+
+.SH SEE ALSO
+
+\&\fImkrc\fR\|(5), \fIrcup\fR\|(1)