etckeeper.1

   1 .\" -*- nroff -*-
   2 .TH ETCKEEPER 1 "" "" ""
   3 .SH NAME
   4 etckeeper \- store /etc in git, mercurial, or bazaar
   5 .SH SYNOPSIS
   6 .B etckeeper command [-d directory]
   7 .SH DESCRIPTION
   8 etckeeper manages /etc be stored in a git, mercurial, or bazaar
   9 repository. By default each of the commands operates on /etc, but a
  10 different directory can be specified to operate on a clone of the /etc
  11 repository located elsewhere.
  12 .SH COMMANDS
  13 .TP
  14 .B init
  15 This is the only command you typically need to run by hand. It
  16 initialises and sets up a git, mercurial, or bazaar repository
  17 (depending on the VCS setting in
  18 /etc/etckeeper/etckeeper.conf). Typically this is run in /etc once
  19 when starting to use etckeeper on a machine. It can also be used to
  20 initialise a clone of the /etc repository located elsewhere.
  21 .TP
  22 .B commit [message]
  23 Commits changes in /etc to the repository. A commit message can be
  24 specified.
  25 .TP
  26 .B pre-commit
  27 This is called as a pre-commit hook. It stores metadata and does sanity
  28 checks.
  29 .TP
  30 .B pre-install
  31 This is called by apt's DPkg::Pre-Install-Pkgs hook, or by equivilant hooks
  32 of other package managers. It allows committing any uncommitted changes before
  33 packages are installed, upgraded, etc.
  34 .TP
  35 .B post-install
  36 This is called by apt's DPkg::Post-Invoke hook, or by equivilant hooks
  37 of other package managers. It commits changes made by packages into the
  38 repository. (You can also call this by hand after running dpkg by hand.)
  39 .TP
  40 .B unclean
  41 This returns true if the directory contains uncommitted changes.
  42 .SH FILES
  43 /etc/etckeeper/etckeeper.conf is the configuration file.
  44
  45 /etc/etckeeper also contains directories containing the programs that are
  46 run for each of the above commands.
  47 .SH AUTHOR
  48 Joey Hess, <joey@kitenet.net>.