ed76fbafc0fe0daa69ce624bb599ea16f62256e3
[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 "Juli 28, 2005"
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
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 This program does not support any options. Either run it as normal user to collect some basic
33 information or run it with root permissions to collect as much information as possible. Temporary files
34 will be written to a directory namend info in current directory, a file namend info.tar.bz2 will be
35 generated. Set environment variable INFOFILE if you want to use different name for infofile, e.g. run
36 grml-hwinfo via 'INFOFILE=foobar.tar.bz2 grml-hwinfo' to generate the report in the file foobar.tar.bz2.
37 .SH AUTHOR
38 grml-hwinfo was written by Michael Prokop <mika@grml.org>.
39 .PP
40 This manual page was written by Michael Prokop <mika@grml.org>,
41 for the Debian project (but may be used by others).