2d38bf87b449aa5fbbe4f7634cbe3cfd2ca40c12
[jelmer/etckeeper.git] / etckeeper.1
1 .\" -*- nroff -*-
2 .TH ETCKEEPER 1 "" "" ""
3 .SH NAME
4 etckeeper \- store /etc in git
5 .SH SYNOPSIS
6 .B etckeeper command [directory]
7 .SH DESCRIPTION
8 etckeeper manages /etc be stored in a git repository. By default each
9 of the commands operates on /etc, but a different directory can be
10 specified as a parameter to operate on a clone of the /etc repository
11 located elsewhere.
12 .SH COMMANDS
13 .TP
14 .B init
15 This is the only command you typically need to run by hand. It initialises
16 and sets up a git repository. Typically this is run in /etc once when
17 starting to use etckeeper on a machine. It can also be used to initialise
18 a clone of the /etc repository located elsewhere.
19 .TP
20 .B pre-commit
21 This is called as a git pre-commit hook. It stores metadata and does sanity
22 checks.
23 .TP
24 .B pre-apt
25 This is called by apt's DPkg::Pre-Install-Pkgs hook. It allows committing
26 any uncommitted changes before the apt run.
27 .TP
28 .B post-apt
29 This is called by apt's DPkg::Post-Invoke hook. It commits changes made by
30 packages into the repository. (You can also call this by hand after running
31 dpkg by hand.)
32 .SH AUTHOR 
33 Joey Hess, <joey@kitenet.net>.