summaryrefslogtreecommitdiff
path: root/etckeeper.8
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2008-12-22 16:12:01 -0500
committerJoey Hess <joey@gnu.kitenet.net>2008-12-22 16:12:01 -0500
commiteab5c4468b54b8f5513ff57f48e9d69e8d3ab254 (patch)
treef9af2f103bfcefcf5c75b426f1cda368343b4527 /etckeeper.8
parent8ba5089e8ee73d62bd92db1f327e7d32c7b0c1f1 (diff)
Move etckeeper to sbin, and man page to section 8, since only an admin can really use etckeeper.
Diffstat (limited to 'etckeeper.8')
-rw-r--r--etckeeper.848
1 files changed, 48 insertions, 0 deletions
diff --git a/etckeeper.8 b/etckeeper.8
new file mode 100644
index 0000000..bbd340a
--- /dev/null
+++ b/etckeeper.8
@@ -0,0 +1,48 @@
+.\" -*- nroff -*-
+.TH ETCKEEPER 8 "" "" ""
+.SH NAME
+etckeeper \- store /etc in git, mercurial, or bazaar
+.SH SYNOPSIS
+.B etckeeper command [-d directory]
+.SH DESCRIPTION
+etckeeper manages /etc be stored in a git, mercurial, or bazaar
+repository. By default each of the commands operates on /etc, but a
+different directory can be specified to operate on a clone of the /etc
+repository located elsewhere.
+.SH COMMANDS
+.TP
+.B init
+This is the only command you typically need to run by hand. It
+initialises and sets up a git, mercurial, or bazaar repository
+(depending on the VCS setting in
+/etc/etckeeper/etckeeper.conf). Typically this is run in /etc once
+when starting to use etckeeper on a machine. It can also be used to
+initialise a clone of the /etc repository located elsewhere.
+.TP
+.B commit [message]
+Commits changes in /etc to the repository. A commit message can be
+specified.
+.TP
+.B pre-commit
+This is called as a pre-commit hook. It stores metadata and does sanity
+checks.
+.TP
+.B pre-install
+This is called by apt's DPkg::Pre-Install-Pkgs hook, or by equivilant hooks
+of other package managers. It allows committing any uncommitted changes before
+packages are installed, upgraded, etc.
+.TP
+.B post-install
+This is called by apt's DPkg::Post-Invoke hook, or by equivilant hooks
+of other package managers. It commits changes made by packages into the
+repository. (You can also call this by hand after running dpkg by hand.)
+.TP
+.B unclean
+This returns true if the directory contains uncommitted changes.
+.SH FILES
+/etc/etckeeper/etckeeper.conf is the configuration file.
+
+/etc/etckeeper also contains directories containing the programs that are
+run for each of the above commands.
+.SH AUTHOR
+Joey Hess, <joey@kitenet.net>.