summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Andres Granados <jgranado@redhat.com>2008-09-25 16:41:42 +0200
committerJoel Andres Granados <jgranado@redhat.com>2008-09-25 16:41:47 +0200
commit626a502d1869d603f5c633bff7a0735b7b3c3e80 (patch)
treeb24b4c5595719377f54dee4a811f29b2d6da6323 /doc
parent7bd6fbb6b66bab5feada209bac64d4702133271b (diff)
downloadfirstaidkit-626a502d1869d603f5c633bff7a0735b7b3c3e80.tar.gz
firstaidkit-626a502d1869d603f5c633bff7a0735b7b3c3e80.tar.xz
firstaidkit-626a502d1869d603f5c633bff7a0735b7b3c3e80.zip
Having some examples of how to execute the command
helps the user to gain better knowledge of FAK.
Diffstat (limited to 'doc')
-rw-r--r--doc/firstaidkit.124
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/firstaidkit.1 b/doc/firstaidkit.1
index 9233281..87bb29c 100644
--- a/doc/firstaidkit.1
+++ b/doc/firstaidkit.1
@@ -84,6 +84,30 @@ Show help.
Setup startup flags.
.PP
+.SH "EXAMPLES"
+.nf
+For most of the situations its probably better to execute
+the plugins individually. You manage this by using the -f
+option.
+.fi
+.IP "firstaidkit -f xserver diagnose"
+Execute the diagnose flow in a specific plugin. This line
+will execute the xserver plugin in diagnose mode.
+.IP "firstaidkit -a diagnose --nodeps"
+Execute all plugins without dependencies. this will execute
+all plugins without looking at the dependencies between them.
+This is good if you want a general diagnose of the system.
+.IP "firstaidkit --print-config"
+List the configuration.
+.IP "firstaidkit --list"
+List of plugins.
+.IP "firstaidkit --info xserver"
+Request a specific info from a plugin.
+.IP "firstaidkit -a -e xserver"
+Exclude a plugin from an action. This will execute every plugin
+except the xserver.
+
+.PP
.SH "BUGS"
.nf
Please report bugs at http://fedorahosted.org/firstaidkit/newticket