diff options
| author | Joey Hess <joey@gnu.kitenet.net> | 2009-02-24 22:44:05 -0500 |
|---|---|---|
| committer | Joey Hess <joey@gnu.kitenet.net> | 2009-02-24 22:44:05 -0500 |
| commit | 0c04235d320c1ebe5e29867dfbcf48109e61d544 (patch) | |
| tree | e5e676a772fbf5245c6177c9e19f39d095d98150 /etckeeper.8 | |
| parent | 145fb779aef9d955b0029b5e4fe27209a3dd435b (diff) | |
uninit and auto-init
* Add uninit subcommand, which cleans up all etckeeper and VCS droppings
in /etc. This is useful if you want to switch to a different VCS and
don't have any history to preserve. (Preserving history and converting
is of course possible, but significantly harder.)
* Run etckeeper init on initial install. Closes: #505772
(The idea being that if someone doesn't want to use git, they can
immediatly uninit to easily reverse this.)
* Document how to change the VCS used by etckeeper, without preserving
any history. Preserving history left as an exersise for the reader.
Closes: #515237
Diffstat (limited to 'etckeeper.8')
| -rw-r--r-- | etckeeper.8 | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/etckeeper.8 b/etckeeper.8 index cfb6828..c76be55 100644 --- a/etckeeper.8 +++ b/etckeeper.8 @@ -12,16 +12,15 @@ 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, mercurial, or bazaar repository +This initialises and sets up a git, mercurial, or bazaar 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. +Commits all changes in /etc to the repository. A commit message can be +specified. You may also use the underlying VCS to commit manually. .TP .B pre-commit This is called as a pre-commit hook. It stores metadata and does sanity @@ -44,6 +43,13 @@ This returns true if the directory contains uncommitted changes. This updates the VCS ignore file. Content outside a "managed by etckeeper" block is not touched. This is generally run when upgrading to a new version of etckeeper. +.TP +.B uninit +This command DESTROYS DATA! It is the inverse of the init command, removing +VCS information and etckeeper's own bookkeeping information from the +directory. Use with caution. A typical use case would be to run etckeeper +uninit, then modify etckeeper.conf to use a different VCS, and then run +etckeeper init. .SH FILES /etc/etckeeper/etckeeper.conf is the configuration file. |