1FirstAidKit(1) General Commands Manual FirstAidKit(1)
2
6
9 firstaidkit [options] [-a | --auto] [fix | FLOW ]
10 firstaidkit [options] [-f | --flow ] PLUGIN FLOW
11 firstaidkit [options] --print-config
12 firstaidkit [options] --list
13 firstaidkit [options] --info <plugin>
14
18 Firstaidkit executes simple and common recovery tasks in an automated
19 way. The basic elements in the system are: backend plugin system, the
20 plugins and the plugin flows. The plugins can be thought of as indi‐
21 vidual recovery units. Each unit having the possibility of holding
22 varioius types of processes, but still focused on one specific subsys‐
23 tem. There can be a plugin for password recovery for example. This
24 plugin would take care of all the possible processes related to pass‐
25 word recovery. In the password recovery plugin there would only be one
26 process: to recover the password. But other plugins might need to exe‐
27 cuting more than one process. Like if you would like to diagnose
28 before actually fixing something.
29 Plugin flows are structures that represent the different processes.
31 You will usually find two default flows in a plugin (with known excep‐
32 tions): The diagnose flow and the fix flow. When in diagnose no
33 changes to the system should be done. Only information should be taken
34 from the system and output through the firstaidkit reporting system
35 (this basically means a log file or stdout. It all depends on the con‐
36 figuration parameters when executing firstaidkit). When in fix mode an
37 attempt will be made to modify the system to fix whatever was found to
38 be missconfigured.
39 Currently firstaidkit has 6 modes of operation:
41 Automated Default. -a, --auto
44 This mode runs all the plugins that firstaidkit can detect in
45 the paths (The paths can be set in the config file). It will
46 run the flow denomintated "diagnose" for all these plugins.
47 When a plugin does not have a diagnose flow (Some plugins like
48 passwd don't have it), it will be ignored. The general idea
49 with this mode is to see what is going on in different parts of
50 the system. The behavior of this mode can be modified by pass‐
51 ing on of two parameters: The flow name or "fix".
52 When fix is specified, it will run the fix flow of all the plug‐
54 ins. This is *not* the default behavior because this might not
55 be what the user wants. A more sensible approach is to list the
56 possible problems and then for the user to run individual plug‐
57 ins to address all of the listed problems or a subset of them.
58 When FLOW is specified, the flow named FLOW is run in each plug‐
60 in. As with the default behavior, the plugin is ignored when
61 the flow is not there.
62 Flow Selection. -f PLUGIN FLOW, --flow PLUGIN FLOW
65 Basically lets you specify the plugin to run and the flow that
66 you want to run on that plugin. This implies --nodeps.
67 Print Configuration. --print-config
70 Lists the resulting configuration. Firstaidkit allows you to
71 specify configuration elements in a lot of places. This options
72 just lests you see what firstaidkit ends up with after analyzing
73 all the configuration elements.
74 List Plugins. --list
77 Make a list of all the plugins.
78 Individual Plugin Info. --info PLUGIN
81 Get information fro a specific plugin.
82
85 -c PATH, --config=PATH
86 Location of configuration file.
87 -r PATH, --root=PATH
89 Location of the root directory.
90 -P PATH
92 Location of different plugin path. This option can be used more
93 than once. firstaidkit will look for plugins in all the paths
94 specified by this option.
95 -v, --verbose
97 Verbose mode.
98 -l METHOD, --log=METHOD
100 Select METHOD as a log method.
101 -x PLUGIN, --exclude=PLUGIN
103 Exclude PLUGIN from the run.
104 -g GUI, --gui=GUI
106 Select GUI as front end to show results.
107 -h, --help
109 Show help.
110 -F FLAG, --flag=FLAG
112 Setup startup flags.
113 --nodeps
115 This makes firstaidkit ingore dependency between plugins.
116 --plugin-args=ARGS
118 This is the way firstaidkit passes arguments to plugins. You
119 can actually specify plugin and flow. Although flow is not nec‐
120 essary. The arguments and their meaning are defined by the
121 plugin. Where ARGS is a space separated string that begins with
122 the plugin name and/or the flow name.
123 ARGS="plugin_name[/flow_name] arg1 arg2 arg3"
125 So if you wanted to pass "--installto-devs=/dev/sda" to the grub
127 plugin in the fix flow, you would pass the following arg to
128 firstaidkit:
129 --plugin-args="grub/fix --installto-devs=/dev/sda"
131
134 For most of the situations its probably better to execute
135 the plugins individually. You manage this by using the -f
136 option.
137 firstaidkit -f xserver diagnose
139 Execute the diagnose flow in a specific plugin. This line will
140 execute the xserver plugin in diagnose mode.
141 firstaidkit -a --nodeps
143 Execute all plugins without dependencies. This will execute all
144 plugins without looking at the dependencies between them. This
145 is good if you want a general diagnose of the system.
146 firstaidkit --print-config
148 List the configuration.
149 firstaidkit --list
151 List of plugins.
152 firstaidkit --info xserver
154 Request a specific info from a plugin.
155 firstaidkit -a -e xserver
157 Exclude a plugin from an action. This will execute every plugin
158 except the xserver.
159 firstaidkit --plugin-args='grub/fix recover-devs=/dev/sda' -f grub fix
161 Runs the plugin plugin in the fix flow and passes it the
162 "recover-devs=/dev/sda" argument.
163
166 Please report bugs at http://fedorahosted.org/firstaidkit/newticket
167
170 Martin Sivak <msivak@redhat.com>
171 Joel Granados <jgranado@redhat.com>
172
175 /etc/firstaidkit.conf
176
179 http://fedorahosted.org/firstaidkit
180 FirstAidKit(1)