summaryrefslogtreecommitdiff
path: root/etckeeper.1
diff options
context:
space:
mode:
Diffstat (limited to 'etckeeper.1')
-rw-r--r--etckeeper.113
1 files changed, 10 insertions, 3 deletions
diff --git a/etckeeper.1 b/etckeeper.1
index cd31b5d..e05cd5f 100644
--- a/etckeeper.1
+++ b/etckeeper.1
@@ -3,12 +3,12 @@
.SH NAME
etckeeper \- store /etc in git or mercurial
.SH SYNOPSIS
-.B etckeeper command [directory]
+.B etckeeper command [-d directory]
.SH DESCRIPTION
etckeeper manages /etc be stored in a git or mercurial 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.
+can be specified to operate on a clone of the /etc repository located
+elsewhere.
.SH COMMANDS
.TP
.B init
@@ -18,6 +18,10 @@ and sets up a git or mercurial repository (depending on the VCS setting in
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.
@@ -31,6 +35,9 @@ packages are installed, upgraded, etc.
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.