From 0b9872d4a07e2947e1934f503404c80e5e97970b Mon Sep 17 00:00:00 2001 From: Joel Andres Granados Date: Tue, 28 Oct 2008 19:11:55 +0100 Subject: firstaidkitrevert.1: Add the doc page for firstaidkitrevert. --- doc/firstaidkitrevert.1 | 67 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/man2wiki | 1 + 2 files changed, 68 insertions(+) create mode 100644 doc/firstaidkitrevert.1 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] +.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 +Joel Granados +.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 -- cgit