summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Andres Granados <jgranado@redhat.com>2008-10-28 19:11:55 +0100
committerJoel Andres Granados <jgranado@redhat.com>2008-10-28 19:12:32 +0100
commit0b9872d4a07e2947e1934f503404c80e5e97970b (patch)
tree2b72aea267447737bc5dcc12bc0850ff93dfc713 /doc
parentaf570c80d8b4e8fa0f7fb8c8105c468321c38b1d (diff)
downloadfirstaidkit-0b9872d4a07e2947e1934f503404c80e5e97970b.tar.gz
firstaidkit-0b9872d4a07e2947e1934f503404c80e5e97970b.tar.xz
firstaidkit-0b9872d4a07e2947e1934f503404c80e5e97970b.zip
firstaidkitrevert.1:
Add the doc page for firstaidkitrevert.
Diffstat (limited to 'doc')
-rw-r--r--doc/firstaidkitrevert.167
-rwxr-xr-xdoc/man2wiki1
2 files changed, 68 insertions, 0 deletions
diff --git a/doc/firstaidkitrevert.1 b/doc/firstaidkitrevert.1
new file mode 100644
index 0000000..0461e90
--- /dev/null
+++ b/doc/firstaidkitrevert.1
@@ -0,0 +1,67 @@
+.\" FirstAidKit
+.TH "FirstAidKitRevert" "1"
+.SH "NAME" FirstAidKitRevert
+.BR
+.SH "SYNOPSIS"
+firstaidkitrevert [options] <plugins>
+.br
+
+.BR
+.SH "DESCRIPTION"
+Firsaidkit has the possibility of reverting the changes made by the plugins.
+This is only possible in plugins that implement the revert functionality.
+Plugins must use persistent backup for this to happen. From the users
+point of view the plugin will leave a directory somewhree in the directory
+tree (This directory is shown to the user at the end of firstaidkits execution)
+that can be used to change the system back to the state in which the plugin
+found it.
+
+In order to use the revert functionality you must specify the plugin you wish
+to revert and the directory in which the plugin stored its backup information.
+As stated before, the directory in which al the backedup information lies is
+shown at the end of fistatidkits execution.
+
+.PP
+.SH "OPTIONS"
+.IP "-P PATH, --plugin-path=PATH"
+Location of directories that contain plugins.
+.IP "-c PATH, config=PATH"
+Location of configuration file.
+.IP "--dir=PATH"
+This is where firstaidkit backup is located. This is not the directory
+of individual plugins. Rather it identifies the directory where firstaidkit
+stored all the persistent backups.
+.IP "--all"
+Indicates to firstaidkitrevert to ignore the list of plugins and revert
+all that is found on --dir
+
+.PP
+.SH "EXAMPLES"
+.IP "firstaidkitrevert -P /tmp/fakbackup/10112008_SAFQq-_/ grub"
+Reverts whatever was done in the grub plugin. It looks for the backups in
+/tmp/fakbackup/10112008_SAFQq-_/
+
+.PP
+.SH "BUGS"
+.nf
+Please report bugs at http://fedorahosted.org/firstaidkit/newticket
+.fi
+
+.PP
+.SH "AUTHORS"
+.nf
+Martin Sivak <msivak@redhat.com>
+Joel Granados <jgranado@redhat.com>
+.fi
+
+.PP
+.SH "FILES"
+.nf
+/etc/firstaidkit.conf
+.fi
+
+.PP
+.SH "SEE ALSO"
+.nf
+http://fedorahosted.org/firstaidkit
+.fi
diff --git a/doc/man2wiki b/doc/man2wiki
index fee6742..10523ca 100755
--- a/doc/man2wiki
+++ b/doc/man2wiki
@@ -8,6 +8,7 @@
#
DEFAULT_CHANGE_FILES="
firstaidkit.1
+ firstaidkitrevert.1
firstaidkit-flags.1
firstaidkit-plugin.1
firstaidkit-reporting.1