doc: Migrate some more docs over from the wiki

Signed-off-by: Sol Jerome <solj@ices.utexas.edu>

git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5717 ce84e21b-d406-0410-9b95-82705330c041

1 files changed, 38 insertions, 0 deletions

diff --git a/doc/client/paranoid.txt b/doc/client/paranoid.txt
new file mode 100644
index 000000000..1bf8c4fa5
--- /dev/null
+++ b/doc/client/paranoid.txt
@@ -0,0 +1,38 @@
+.. -*- mode: rst -*-
+
+.. _client-paranoid:
+
+=============
+Paranoid Mode
+=============
+
+What is paranoid mode?
+======================
+
+Paranoid mode creates a backup of a local configuration file before
+Bcfg2 replaces the file. This allows for easier recovery by the local
+administrator.
+
+How do I use it?
+================
+
+#. In the Bcfg2 repository, put `paranoid='true'` in the `info.xml` file.
+#. On the client, create `/var/cache/bcfg2` (in 1.0, you can specify an alternate path in the [paranoid] section of /etc/bcfg2).
+#. On the client, run `bcfg2` with the `-P` option.
+
+This will save a copy of the replaced file in `/var/cache/bcfg2`, but
+it'll be named as the path to the file with /'s replaced by _'s. For
+example, the old `/etc/hosts` will be named `/var/cache/bcfg2/etc_hosts`.
+
+Extra configuration
+===================
+
+Here is an example of how to use the extra paranoid features available
+in 1.0. For the following section in bcfg2.conf::
+
+    [paranoid]
+    path = /my/custom/backup/path
+    max_copies = 5
+
+You will have the file backups store in /my/custom/backup/path. This
+will also keep the five most recent backups of files.