From d60a8680de79ce15fbba08e44a08d9cdaf9a175e Mon Sep 17 00:00:00 2001 From: Mike Burns Date: Fri, 7 Jun 2013 11:35:23 +0200 Subject: Add a manpage for rcup(1) A quick and unskilled manpage for rcup(1) with a synopsis, description, options, directory layout, and references to other manpages that I haven't written yet. --- Makefile | 1 + man/man1/rcup.1 | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 man/man1/rcup.1 diff --git a/Makefile b/Makefile index df46731..56373fd 100644 --- a/Makefile +++ b/Makefile @@ -3,5 +3,6 @@ PREFIX=/usr/local install: install -m 0755 bin/mkrc $(PREFIX)/bin install -m 0755 bin/rcup $(PREFIX)/bin + install -m 0644 man/man1/rcup.1 $(PREFIX)/share/man/man1 .PHONY: install diff --git a/man/man1/rcup.1 b/man/man1/rcup.1 new file mode 100644 index 0000000..22f5b95 --- /dev/null +++ b/man/man1/rcup.1 @@ -0,0 +1,62 @@ +.TH rcup "1" "June 2013" "rcm" + +.sh NAME +rcup \- update and install dotfiles + +.SH SYNOPSIS +.B rcup [-v] [-q] [-t \fItag\fR] [\fIfiles...\fR] + +.SH DESCRIPTION + +This is a program to update and install personal dotfiles. These +dotfiles are managed in a separate directory. Use \fBrcup\fR to install +files from your dotfiles directory or from host- or tag-specific +directories within. + +See \fBDIRECTORY LAYOUT\fR for details on the directory layout. + +It supports these options: + +.TP +\fB-v\fR +increase verbosity. This can be repeated for extra verbosity. + +.TP +\fB-q\fR +decrease verbosity + +.TP +\fB-t\fR \fITAG\fR +install dotfiles according to tag + +.TP +\fIfiles...\fR +only install the specified file(s) + +.SH DIRECTORY LAYOUT + +Any non-dot non-meta file or directory under your dotfiles directory will be +installed as a dotfile. For example, \fI.dotfiles/zshrc\fR will be +installed into \fI~/.zshrc\fR\|. + +Files are installed as symlinks. Directories are installed by making +directories. + +Two meta files are supported: host-specific files and tagged files. + +Host-specific files go in a directory named for the host, prefixed with +\fIhost-\fR\|. For example, \fI.dotfiles/host-scarlett\fR contains files +specific to the computer with hostname \fIscarlett\fR\|, and these files +will only be installed on the computer with hostname \fIscarlett\fR\|. + +Tagged files go in a directory named for the tag, prefixed with +\fItag-\fR\|. Files under \fI.dotfiles/tag-git\fR are only installed +when installing using the \fIgit\fR tag. + +.SH FILES +.I ~/.dotfiles +.I ~/.rcrc + +.SH SEE ALSO + +\&\fIrcrc\fR\|(5), \fImkrc\fR\|(1) -- cgit v1.2.3