summaryrefslogtreecommitdiff
path: root/debian/patches/04-manpage-hyphen.patch
blob: c644572dbe372040948e4a094b8a585e78b23d8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
Author: Daniel Baumann <daniel.baumann@progress-technologies.net>
Description: Escaping hyphens in manpage.

diff -Naurp dmidecode.orig/man/dmidecode.8 dmidecode/man/dmidecode.8
--- dmidecode.orig/man/dmidecode.8	2012-06-25 23:23:43.849293701 +0200
+++ dmidecode/man/dmidecode.8	2012-06-26 01:12:39.578227162 +0200
@@ -8,7 +8,7 @@ dmidecode \- \s-1DMI\s0 table decoder
 .SH DESCRIPTION
 .B dmidecode
 is a tool for dumping a computer's \s-1DMI\s0 (some say \s-1SMBIOS\s0) table
-contents in a human-readable format. This table contains a description of the
+contents in a human\-readable format. This table contains a description of the
 system's hardware components, as well as other useful pieces of information
 such as serial numbers and \s-1BIOS\s0 revision. Thanks to this table, you can
 retrieve this information without having to probe for the actual hardware.
@@ -32,7 +32,7 @@ Handle 0x0002, DMI type 2, 8 bytes.
 Base Board Information
         Manufacturer: Intel
         Product Name: C440GX+
-        Version: 727281-001
+        Version: 727281\-001
         Serial Number: INCY92700942
 
 Each record has:
@@ -45,7 +45,7 @@ A type. The \s-1SMBIOS\s0 specification
 a computer can be made of. In this example, the type is 2, which
 means that the record contains "Base Board Information".
 .IP \(bu
-A size. Each record has a 4-byte header (2 for the handle, 1 for the type,
+A size. Each record has a 4\-byte header (2 for the handle, 1 for the type,
 1 for the size), the rest is used by the record data. This value doesn't
 take text strings into account (these are placed at the end of the record),
 so the actual length of the record may be (and is often) greater than the
@@ -57,42 +57,42 @@ and serial number.
 
 .SH OPTIONS
 .TP
-.BR "-d" ", " "--dev-mem FILE"
+.BR "\-d" ", " "\-\-dev\-mem FILE"
 Read memory from device \fBFILE\fR (default: \fB/dev/mem\fR)
 .TP
-.BR "-q" ", " "--quiet"
+.BR "\-q" ", " "\-\-quiet"
 Be less verbose. Unknown, inactive and \s-1OEM\s0-specific entries are not
-displayed. Meta-data and handle references are hidden.
+displayed. Meta\-data and handle references are hidden.
 .TP
-.BR "-s" ", " "--string KEYWORD"
+.BR "\-s" ", " "\-\-string KEYWORD"
 Only display the value of the \s-1DMI\s0 string identified by \fBKEYWORD\fR.
-\fBKEYWORD\fR must be a keyword from the following list: \fBbios-vendor\fR,
-\fBbios-version\fR, \fBbios-release-date\fR,
-\fBsystem-manufacturer\fR, \fBsystem-product-name\fR,
-\fBsystem-version\fR, \fBsystem-serial-number\fR,
-\fBsystem-uuid\fR,
-\fBbaseboard-manufacturer\fR, \fBbaseboard-product-name\fR,
-\fBbaseboard-version\fR, \fBbaseboard-serial-number\fR,
-\fBbaseboard-asset-tag\fR, \fBchassis-manufacturer\fR,
-\fBchassis-type\fR,
-\fBchassis-version\fR, \fBchassis-serial-number\fR,
-\fBchassis-asset-tag\fR, \fBprocessor-family\fR,
-\fBprocessor-manufacturer\fR,
-\fBprocessor-version\fR, \fBprocessor-frequency\fR.
+\fBKEYWORD\fR must be a keyword from the following list: \fBbios\-vendor\fR,
+\fBbios\-version\fR, \fBbios\-release\-date\fR,
+\fBsystem\-manufacturer\fR, \fBsystem\-product\-name\fR,
+\fBsystem\-version\fR, \fBsystem\-serial\-number\fR,
+\fBsystem\-uuid\fR,
+\fBbaseboard\-manufacturer\fR, \fBbaseboard\-product\-name\fR,
+\fBbaseboard\-version\fR, \fBbaseboard\-serial\-number\fR,
+\fBbaseboard\-asset\-tag\fR, \fBchassis\-manufacturer\fR,
+\fBchassis\-type\fR,
+\fBchassis\-version\fR, \fBchassis\-serial\-number\fR,
+\fBchassis\-asset\-tag\fR, \fBprocessor\-family\fR,
+\fBprocessor\-manufacturer\fR,
+\fBprocessor\-version\fR, \fBprocessor\-frequency\fR.
 Each keyword corresponds to a given \s-1DMI\s0 type and a given offset
 within this entry type.
 Not all strings may be meaningful or even defined on all systems. Some
 keywords may return more than one result on some systems (e.g.
-\fBprocessor-version\fR on a multi-processor system).
+\fBprocessor\-version\fR on a multi\-processor system).
 If \fBKEYWORD\fR is not provided or not valid, a list of all valid
 keywords is printed and
 .B dmidecode
 exits with an error.
 This option cannot be used more than once.
 .TP
-.BR "-t" ", " "--type TYPE"
+.BR "\-t" ", " "\-\-type TYPE"
 Only display the entries of type \fBTYPE\fR. \fBTYPE\fR can be either a
-\s-1DMI\s0 type number, or a comma-separated list of type numbers, or a
+\s-1DMI\s0 type number, or a comma\-separated list of type numbers, or a
 keyword from the following list: \fBbios\fR, \fBsystem\fR,
 \fBbaseboard\fR, \fBchassis\fR, \fBprocessor\fR, \fBmemory\fR,
 \fBcache\fR, \fBconnector\fR, \fBslot\fR. Refer to the DMI TYPES section
@@ -104,28 +104,28 @@ is printed and
 .B dmidecode
 exits with an error.
 .TP
-.BR "-u" ", " "--dump"
+.BR "\-u" ", " "\-\-dump"
 Do not decode the entries, dump their contents as hexadecimal instead.
 Note that this is still a text output, no binary data will be thrown upon
 you. The strings attached to each entry are displayed as both
 hexadecimal and \s-1ASCII\s0. This option is mainly useful for debugging.
 .TP
-.BR "  " "  " "--dump-bin FILE"
+.BR "  " "  " "\-\-dump\-bin FILE"
 Do not decode the entries, instead dump the DMI data to a file in binary
-form. The generated file is suitable to pass to \fB--from-dump\fR
+form. The generated file is suitable to pass to \fB\-\-from\-dump\fR
 later.
 .TP
-.BR "  " "  " "--from-dump FILE"
+.BR "  " "  " "\-\-from\-dump FILE"
 Read the DMI data from a binary file previously generated using 
-\fB--dump-bin\fR.
+\fB\-\-dump\-bin\fR.
 .TP
-.BR "-h" ", " "--help"
+.BR "\-h" ", " "\-\-help"
 Display usage information and exit
 .TP
-.BR "-V" ", " "--version"
+.BR "\-V" ", " "\-\-version"
 Display the version and exit
 .P
-Options --string, --type and --dump-bin
+Options \-\-string, \-\-type and \-\-dump\-bin
 determine the output format and are mutually exclusive.
 .P
 Please note in case of
@@ -161,10 +161,10 @@ Type	Information
 15	System Event Log
 16	Physical Memory Array
 17	Memory Device
-18	32-bit Memory Error
+18	32\-bit Memory Error
 19	Memory Array Mapped Address
 20	Memory Device Mapped Address
-21	Built-in Pointing Device
+21	Built\-in Pointing Device
 22	Portable Battery
 23	System Reset
 24	Hardware Security
@@ -173,10 +173,10 @@ Type	Information
 27	Cooling Device
 28	Temperature Probe
 29	Electrical Current Probe
-30	Out-of-band Remote Access
+30	Out\-of\-band Remote Access
 31	Boot Integrity Services
 32	System Boot
-33	64-bit Memory Error
+33	64\-bit Memory Error
 34	Management Device
 35	Management Device Component
 36	Management Device Threshold Data
@@ -189,12 +189,12 @@ Type	Information
 .TE
 
 Additionally, type 126 is used for disabled entries and type 127 is an
-end-of-table marker. Types 128 to 255 are for \s-1OEM\s0-specific data.
+end\-of\-table marker. Types 128 to 255 are for \s-1OEM\s0-specific data.
 .B dmidecode
 will display these entries by default, but it can only decode them
 when the vendors have contributed documentation or code for them.
 
-Keywords can be used instead of type numbers with \fB--type\fR.
+Keywords can be used instead of type numbers with \fB\-\-type\fR.
 Each keyword is equivalent to a list of type numbers:
 
 .TS
@@ -213,22 +213,22 @@ connector	8
 slot	9
 .TE
 
-Keywords are matched case-insensitively. The following command lines are equivalent:
+Keywords are matched case\-insensitively. The following command lines are equivalent:
 .IP \(bu "\w'\(bu'u+1n"
-dmidecode --type 0 --type 13
+dmidecode \-\-type 0 \-\-type 13
 .IP \(bu
-dmidecode --type 0,13
+dmidecode \-\-type 0,13
 .IP \(bu
-dmidecode --type bios
+dmidecode \-\-type bios
 .IP \(bu
-dmidecode --type BIOS
+dmidecode \-\-type BIOS
 
 .SH BINARY DUMP FILE FORMAT
-The binary dump files generated by --dump-bin and read using --from-dump
+The binary dump files generated by \-\-dump\-bin and read using \-\-from\-dump
 are formatted as follows:
 .IP \(bu "\w'\(bu'u+1n"
 The SMBIOS or DMI entry point is located at offset 0x00.
-It is crafted to hard-code the table address at offset 0x20.
+It is crafted to hard\-code the table address at offset 0x20.
 .IP \(bu "\w'\(bu'u+1n"
 The DMI table is located at offset 0x20.