Release new version 0.17.1
[grml-hwinfo.git] / grml-hwinfo.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH GRML-HWINFO 1 "April 22, 2011"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 grml-hwinfo \- collect hardware information
20 .SH SYNOPSIS
21 .B grml-hwinfo [-d] [-f]
22 .SH DESCRIPTION
23 This manual page documents briefly the
24 .B grml-hwinfo
25 command.
26 .PP
27 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
28 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
29 .\" respectively.
30 \fBgrml-hwinfo\fP is a program that collects information regarding hardware.
31 .SH OPTIONS
32 .B -d
33 Save collected data in a directory named "grml-hwinfo-TIMESTAMP".
34
35 .B -f
36 Save collected data in a tarball named "grml-hwinfo-TIMESTAMP.tar.bz2".
37 Specify both -d and -f, as -df, to get the directory and the tarball.
38 .SH RUNNING AS ROOT
39 Running this program as root will make it gather additional information.
40 This includes DMI, DDC, disk, partition tables and other data normally
41 only available to root.
42 .SH AUTHOR
43 grml-hwinfo was written by Michael Prokop <mika@grml.org>.
44 .PP
45 This manual page was written by Michael Prokop <mika@grml.org>,
46 for the Grml project (but may be used by others).