- rewrote man page, help text & README (bnc #178662)
[opensuse:hwinfo.git] / doc / hwinfo.8
1 .TH HWINFO 8 "June 2009" "hwinfo" "System configuration"
2 .\"
3 .SH NAME
4 hwinfo \- probe for hardware
5 .\"
6 .SH SYNOPSIS
7 .B hwinfo [
8 .I OPTIONS
9 .B ]
10 .\"
11 .SH DESCRIPTION
12 .B hwinfo
13 is used to probe for the hardware present in the system. It can be used to
14 generate a system overview log which can be later used for support.
15 .\"
16 .SH OPTIONS
17 Note that running \fBhwinfo\fR without any options is roughly equivalent
18 to 'hwinfo --all --log=-'.
19 .TP
20 \fB--<\f[BI]HARDWARE_ITEM\fB>\fR
21 This option can be given more than once.
22 Probe for a particular \fIHARDWARE_ITEM\fR. Available hardware items are:
23
24 all, arch, bios, block, bluetooth, braille, bridge, camera, cdrom, chipcard,
25 cpu, disk, dsl, dvb, fingerprint, floppy, framebuffer, gfxcard, hub, ide, 
26 isapnp, isdn, joystick, keyboard, memory, modem, monitor, mouse, netcard,
27 network, partition, pci, pcmcia, pcmcia-ctrl, pppoe, printer, redasd,
28 reallyall, scanner, scsi, smp, sound, storage-ctrl, sys, tape, tv, uml, usb,
29 usb-ctrl, vbe, wlan, xen, zip
30 .TP
31 \fB--short\fR
32 Show only a summary. Use this option in addition to a hardware probing
33 option.   
34 .TP
35 \fB--listmd\fR
36 Normally hwinfo does not report RAID devices. Add this option to see them.
37 .TP
38 \fB--only \fIDEVNAME\fR
39 This option can be given more than once. If you add this option, only data
40 about devices with \fIDEVNAME\fR will be shown.
41 .TP
42 \fB--save-config \fISPEC\fR
43 Store config for a particular device below /var/lib/hardware. \fISPEC\fR
44 can be a device name, an UDI, or 'all'. This option must be given in addition to
45 a hardware probing option.
46 .TP
47 \fB--show-config \fIUDI\fR
48 Show saved config data for a particular device.
49 .TP
50 \fB--map\fR
51 If disk names have changed (e.g. after a kernel update) this prints a list
52 of disk name mappings. Note that you must have used --save-config at some
53 point before for this can work.
54 .TP
55 \fB--debug \fIN\fR
56 Set debug level to \fIN\fR. The debug info is shown only in the log file.
57 If you specify a log file, the debug level is implicitly set to a reasonable value.
58 .TP
59 \fB--verbose\fR
60 Increase verbosity. Only together with --map.
61 .TP
62 \fB--log \fIFILE\fR
63 Write log info to \fIFILE\fR.
64 .TP
65 \fB--dump-db \fIN\fR
66 Dump hardware data base. \fIN\fR is either 0 for the external data base in
67 /var/lib/hardware, or 1 for the internal data base.
68 .TP
69 \fB--version\fR
70 Print libhd version.
71 .TP
72 \fB--help\fR
73 Print usage.
74 .\"
75 .SH ENVIRONMENT
76 \fBhwprobe\fR can hold a comma-separated list of probing flags preceded by '+'
77 or '-' to be turned on or off. To get a complete list of supported flags, 
78 run 'hwinfo -all' (note: not '--all') and look at the top of the output.  
79
80 hwinfo also looks at /proc/cmdline for a \fBhwprobe\fR option.
81 .\"
82 .SH EXAMPLES
83 .TP
84 - show all disks
85 hwinfo --disk
86 .TP
87 - just an overview
88 hwinfo --short --block 
89 .TP
90 - show a particular disk
91 hwinfo --disk --only /dev/sdb
92 .TP
93 - save disk config state
94 hwinfo --disk --save-config=all
95 .TP
96 - try 4 graphics card ports for monitor data (default: 3)
97 hwprobe=bios.ddc.ports=4 hwinfo --monitor
98 .TP
99 - monitor detection runs the Video BIOS to get the monitor data; dump a complete BIOS code execution trace to the log
100 hwprobe=bios.ddc.ports=1,x86emu=trace:dump:trace.only=0:dump.only=0 \
101 hwinfo --monitor --log=foo
102 .\"
103 .SH FILES
104 .TP
105 \fB/var/lib/hardware/hd.ids\fR
106 External hardware data base (in readable text form). Try the --dump-db option to see the format.
107 .TP
108 \fB/var/lib/hardware/udi\fR
109 Directory where persistent config data are stored (see --save-config option).
110 .\"
111 .SH BUGS
112 Not all hardware can be detected.
113 .\"
114 .SH "SEE ALSO"
115 More documentation in /usr/share/doc/packages/hwinfo.
116 .br
117 Source repository: git://git.opensuse.org/projects/hwinfo.git.
118 .\"