etckeeper(8)

1ETCKEEPER(8)                                                      ETCKEEPER(8)
2
3
4

NAME

6       etckeeper - store /etc in git, mercurial, bazaar, or darcs
7

SYNOPSIS

9       etckeeper command [-d directory]
10

DESCRIPTION

12       etckeeper  manages /etc be stored in a git, mercurial, bazaar, or darcs
13       repository. By default each of the commands operates  on  /etc,  but  a
14       different  directory can be specified to operate on a clone of the /etc
15       repository located elsewhere.
16

COMMANDS

18       init   This initialises and sets up a git, mercurial, bazaar, or  darcs
19              repository (depending on the VCS setting in /etc/etckeeper/etck‐
20              eeper.conf). Typically this is run in /etc once when starting to
21              use  etckeeper on a machine. It can also be used to initialise a
22              clone of the /etc repository located elsewhere.
23
24       commit [message]
25              Commits all changes in /etc to the repository. A commit  message
26              can  be specified. You may also use the underlying VCS to commit
27              manually.  (Note that etckeeper commit will notice if a user has
28              used sudo or su to become root, and record the original username
29              in the commit.)
30
31       pre-commit
32              This is called as a pre-commit hook. It stores metadata and does
33              sanity checks.
34
35       pre-install
36              This  is  called  by  apt's  DPkg::Pre-Install-Pkgs  hook, or by
37              equivalent hooks of other package managers. It allows committing
38              any uncommitted changes before packages are installed, upgraded,
39              etc.
40
41       post-install
42              This is called by apt's DPkg::Post-Invoke hook, or by equivalent
43              hooks  of  other  package  managers.  It commits changes made by
44              packages into the repository. (You can also call  this  by  hand
45              after running dpkg by hand.)
46
47       unclean
48              This returns true if the directory contains uncommitted changes.
49
50       update-ignore
51              This  updates the VCS ignore file. Content outside a "managed by
52              etckeeper" block is not touched.  This  is  generally  run  when
53              upgrading to a new version of etckeeper.
54
55       vcs subcommand [options ...]
56              You can use this to run any subcommand of the VCS that etckeeper
57              is configured to run. It will be run in /etc. For example, "etc‐
58              keeper vcs diff" will run "git diff", etc.
59
60       uninit [-f]
61              This  command  DESTROYS DATA! It is the inverse of the init com‐
62              mand, removing VCS information and etckeeper's  own  bookkeeping
63              information  from the directory. Use with caution. A typical use
64              case would  be  to  run  etckeeper  uninit,  then  modify  etck‐
65              eeper.conf  to use a different VCS, and then run etckeeper init.
66              (The -f switch can be used to force uninit without prompting.)
67

FILES

69       /etc/etckeeper/etckeeper.conf is the configuration file.
70
71       /etc/etckeeper also contains directories containing the  programs  that
72       are run for each of the above commands.
73

ENVIRONMENT VARIABLES

75       ETCKEEPER_CONF_DIR  path  to configuration directory instead of default
76       /etc/etckeeper.
77

AUTHOR

82       Joey Hess <joey@kitenet.net>
83
84
85
86                                                                  ETCKEEPER(8)