Remove now obsolete precommit script for bzr.

[jelmer/etckeeper.git] / etckeeper.1

diff --git a/etckeeper.1 b/etckeeper.1
index 2d38bf87b449aa5fbbe4f7634cbe3cfd2ca40c12..c313a0c5d994b9a0fe237b511d943819a9ce903c 100644 (file)
--- a/etckeeper.1
+++ b/etckeeper.1
@@ -1,33 +1,48 @@
 .\" -*- nroff -*-
 .TH ETCKEEPER 1 "" "" ""
 .SH NAME
-etckeeper \- store /etc in git
+etckeeper \- store /etc in git, mercurial, or bazaar
 .SH SYNOPSIS
-.B etckeeper command [directory]
+.B etckeeper command [-d directory]
 .SH DESCRIPTION
-etckeeper manages /etc be stored in a git repository. By default each
-of the commands operates on /etc, but a different directory can be
-specified as a parameter to operate on a clone of the /etc repository
-located elsewhere.
+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 repository. 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.
+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 git pre-commit hook. It stores metadata and does sanity
+This is called as a pre-commit hook. It stores metadata and does sanity
 checks.
 .TP
-.B pre-apt
-This is called by apt's DPkg::Pre-Install-Pkgs hook. It allows committing
-any uncommitted changes before the apt run.
+.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 post-apt
-This is called by apt's DPkg::Post-Invoke hook. It commits changes made by
-packages into the repository. (You can also call this by hand after running
-dpkg by hand.)
+.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>.