etckeeper.1


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

.\" -*- nroff -*-
.TH ETCKEEPER 1 "" "" ""
.SH NAME
etckeeper \- store /etc in git or mercurial
.SH SYNOPSIS
.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 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 or mercurial 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>.