]>
Commit | Line | Data |
---|---|---|
089a6ff8 JD |
1 | Author: Bjarni Ingi Gislason <bjarniig@rhi.hi.is> |
2 | Date: Wed, 3 Feb 2016 00:22:52 +0000 | |
3 | Cc: 669053@bugs.debian.org | |
4 | Bug-Debian: http://bugs.debian.org/669053 | |
5 | Description: Various manpage improvements. | |
6 | ||
7 | Enable and fix warnings from 'man' and 'groff'. | |
8 | ||
9 | Change `` to ". | |
10 | ||
11 | Split lines longer than about 80 characters into two or more | |
12 | lines. References: | |
13 | ||
14 | 1) man-pages(7) from package \"man-pages\" or | |
15 | \"www.kernel.org/doc/man-pages\" section 7 or | |
16 | \"man7.org/linux/man-pages/man7/man-pages.7.html\": | |
17 | ||
18 | New sentences should be started on new lines. | |
19 | This makes it easier to see the effect of patches, | |
20 | which often operate at the level of individual sentences. | |
21 | ||
22 | Remove space at end of lines. | |
23 | ||
24 | The space between sentences in "roff" is two spaces. | |
25 | ||
26 | Better is to begin each sentence on a new line to avoid different | |
27 | writers' conventions. | |
28 | ||
29 | Change \' (acute) to \(aq, if used as a quote. | |
30 | ||
31 | Change \' (acute) to ', if used as an apostrophe. | |
32 | ||
33 | Change - to \(en (en-dash) for a numeric range. | |
34 | ||
35 | Protect a full stop (.) with \&, if | |
36 | ||
37 | a) it can be transported to the first column, when the line is | |
38 | reformatted (split). | |
39 | b) it is the last part of an abbreviation that does not end a | |
40 | sentence. | |
41 | ||
42 | Add a (no-break, "\ ") space between a number and an unit as these | |
43 | are not one entity | |
44 | ||
45 | Change a hyphen-minus to a minus (\-), if in front of a name for an option | |
46 | ||
47 | Remove space in the first column, if not intended. | |
48 | ||
089a6ff8 JD |
49 | --- a/smartd.conf.5.in |
50 | +++ b/smartd.conf.5.in | |
3360ee78 | 51 | @@ -15,7 +15,7 @@ |
089a6ff8 JD |
52 | This code was originally developed as a Senior Thesis by Michael Cornwell |
53 | at the Concurrent Systems Laboratory (now part of the Storage Systems | |
54 | Research Center), Jack Baskin School of Engineering, University of | |
55 | -California, Santa Cruz. http://ssrc.soe.ucsc.edu/ | |
56 | +California, Santa Cruz. http://ssrc.soe.ucsc.edu/ | |
57 | ||
58 | .. | |
59 | .TH SMARTD.CONF 5 "CURRENT_SVN_DATE" "CURRENT_SVN_VERSION" "SMART Monitoring Tools" | |
3360ee78 | 60 | @@ -33,23 +33,23 @@ |
089a6ff8 JD |
61 | |
62 | If the configuration file \fB/usr/local/etc/smartd.conf\fP is present, | |
63 | \fBsmartd\fP reads it at startup, before \fBfork\fP(2)ing into the | |
64 | -background. If \fBsmartd\fP subsequently receives a \fBHUP\fP signal, | |
65 | +background. If \fBsmartd\fP subsequently receives a \fBHUP\fP signal, | |
66 | it will then re-read the configuration file. If \fBsmartd\fP is | |
67 | running in debug mode, then an \fBINT\fP signal will also make it | |
68 | -re-read the configuration file. This signal can be generated by typing | |
69 | -\fB\<CONTROL-C\>\fP in the terminal window where \fBsmartd\fP is | |
70 | +re-read the configuration file. This signal can be generated by typing | |
71 | +\fB<CONTROL-C>\fP in the terminal window where \fBsmartd\fP is | |
72 | running. | |
73 | ||
74 | In the absence of a configuration file | |
75 | \fBsmartd\fP will try to open all available devices | |
76 | (see \fBsmartd\fP(8) man page). | |
77 | -A configuration file with a single line \fB\'DEVICESCAN \-a'\fP | |
78 | +A configuration file with a single line \fB\(aqDEVICESCAN \-a\(aq\fP | |
79 | would have the same effect. | |
80 | ||
81 | This can be annoying if you have an ATA or SCSI device that hangs or | |
82 | misbehaves when receiving SMART commands. Even if this causes no | |
83 | problems, you may be annoyed by the string of error log messages about devices | |
84 | -that can\'t be opened. | |
85 | +that can't be opened. | |
86 | ||
87 | One can avoid this problem, and gain more control over the types of | |
88 | events monitored by | |
3360ee78 | 89 | @@ -59,27 +59,27 @@ |
089a6ff8 JD |
90 | This file contains a list of devices to monitor, with one device per |
91 | line. An example file is included with the | |
92 | .B smartmontools | |
93 | -distribution. You will find this sample configuration file in | |
94 | -\fB/usr/local/share/doc/smartmontools/\fP. For security, the configuration file | |
95 | -should not be writable by anyone but root. The syntax of the file is as | |
96 | +distribution. You will find this sample configuration file in | |
97 | +\fB/usr/local/share/doc/smartmontools/\fP. For security, the configuration file | |
98 | +should not be writable by anyone but root. The syntax of the file is as | |
99 | follows: | |
100 | .IP \(bu 4 | |
101 | There should be one device listed per line, although you may have | |
102 | lines that are entirely comments or white space. | |
103 | .IP \(bu 4 | |
104 | -Any text following a hash sign \'#\' and up to the end of the line is | |
105 | +Any text following a hash sign \(aq#\(aq and up to the end of the line is | |
106 | taken to be a comment, and ignored. | |
107 | .IP \(bu 4 | |
108 | -Lines may be continued by using a backslash \'\e\' as the last | |
109 | +Lines may be continued by using a backslash \(aq\e\(aq as the last | |
110 | non-whitespace or non-comment item on a line. | |
111 | .IP \(bu 4 | |
112 | -Note: a line whose first character is a hash sign \'#\' is treated as | |
113 | +Note: a line whose first character is a hash sign \(aq#\(aq is treated as | |
114 | a white-space blank line, \fBnot\fP as a non-existent line, and will | |
115 | \fBend\fP a continuation line. | |
116 | .PP | |
117 | ||
118 | -Here is an example configuration file. It\'s for illustrative purposes | |
119 | -only; please don\'t copy it onto your system without reading to the end | |
120 | +Here is an example configuration file. It's for illustrative purposes | |
121 | +only; please don't copy it onto your system without reading to the end | |
122 | of the | |
123 | .B DIRECTIVES | |
124 | Section below! | |
3360ee78 | 125 | @@ -92,127 +92,127 @@ |
089a6ff8 JD |
126 | .B # On the second disk, start a long self-test every |
127 | .B # Sunday between 3 and 4 am. | |
128 | .B # | |
129 | -.B \ \ /dev/sda -a -m admin@example.com,root@localhost | |
130 | -.B \ \ /dev/sdb -a -I 194 -I 5 -i 12 -s L/../../7/03 | |
131 | +.B \ \ /dev/sda \-a \-m admin@example.com,root@localhost | |
132 | +.B \ \ /dev/sdb \-a \-I 194 \-I 5 \-i 12 \-s L/../../7/03 | |
133 | .B # | |
134 | .B # Send a TEST warning email to admin on startup. | |
135 | .B # | |
136 | -.B \ \ /dev/sdc -m admin@example.com -M test | |
137 | +.B \ \ /dev/sdc \-m admin@example.com \-M test | |
138 | .B # | |
139 | -.B # Strange device. It\'s SCSI. Start a scheduled | |
140 | +.B # Strange device. It's SCSI. Start a scheduled | |
141 | .B # long self test between 5 and 6 am Monday/Thursday | |
142 | -.B \ \ /dev/weird -d scsi -s L/../../(1|4)/05 | |
143 | +.B \ \ /dev/weird \-d scsi \-s L/../../(1|4)/05 | |
144 | .B # | |
145 | .B # An ATA disk may appear as a SCSI device to the | |
146 | -.B # OS. If a SCSI to ATA Translation (SAT) layer | |
147 | +.B # OS. If a SCSI to ATA Translation (SAT) layer | |
148 | .B # is between the OS and the device then this can be | |
149 | -.B # flagged with the '-d sat' option. This situation | |
150 | +.B # flagged with the '-d sat' option. This situation | |
151 | .B # may become common with SATA disks in SAS and FC | |
152 | .B # environments. | |
153 | -.B \ \ /dev/sda -a -d sat | |
154 | +.B \ \ /dev/sda \-a \-d sat | |
155 | .B # | |
156 | .\" %IF OS Linux | |
157 | .B # Three disks connected to a MegaRAID controller | |
158 | -.B # Start short self-tests daily between 1-2, 2-3, and | |
159 | -.B # 3-4 am. | |
160 | -.B \ \ /dev/sda -d megaraid,0 -a -s S/../.././01 | |
161 | -.B \ \ /dev/sda -d megaraid,1 -a -s S/../.././02 | |
162 | -.B \ \ /dev/sda -d megaraid,2 -a -s S/../.././03 | |
163 | -.B \ \ /dev/bus/0 -d megaraid,2 -a -s S/../.././03 | |
164 | +.B # Start short self-tests daily between 1\(en2, 2\(en3, and | |
165 | +.B # 3\(en4 am. | |
166 | +.B \ \ /dev/sda \-d megaraid,0 \-a \-s S/../.././01 | |
167 | +.B \ \ /dev/sda \-d megaraid,1 \-a \-s S/../.././02 | |
168 | +.B \ \ /dev/sda \-d megaraid,2 \-a \-s S/../.././03 | |
169 | +.B \ \ /dev/bus/0 \-d megaraid,2 \-a \-s S/../.././03 | |
170 | .B # | |
171 | .B # Three disks connected to an AacRaid controller | |
172 | -.B # Start short self-tests daily between 1-2, 2-3, and | |
173 | -.B # 3-4 am. | |
174 | -.B \ \ /dev/sda -d aacraid,0,0,66 -a -s S/../.././01 | |
175 | -.B \ \ /dev/sda -d aacraid,0,0,67 -a -s S/../.././02 | |
176 | -.B \ \ /dev/sda -d aacraid,0,0,68 -a -s S/../.././03 | |
177 | +.B # Start short self-tests daily between 1\(en2, 2\(en3, and | |
178 | +.B # 3\(en4 am. | |
179 | +.B \ \ /dev/sda \-d aacraid,0,0,66 \-a \-s S/../.././01 | |
180 | +.B \ \ /dev/sda \-d aacraid,0,0,67 \-a \-s S/../.././02 | |
181 | +.B \ \ /dev/sda \-d aacraid,0,0,68 \-a \-s S/../.././03 | |
182 | .B # | |
183 | .\" %ENDIF OS Linux | |
184 | .B # Four ATA disks on a 3ware 6/7/8000 controller. | |
185 | -.B # Start short self-tests daily between midnight and 1am, | |
186 | -.B # 1-2, 2-3, and 3-4 am. Starting with the Linux 2.6 | |
187 | +.B # Start short self-tests daily between midnight and 1 am, | |
188 | +.B # 1\(en2, 2\(en3, and 3\(en4 am. Starting with the Linux 2.6 | |
189 | .B # kernel series, /dev/sdX is deprecated in favor of | |
190 | .B # /dev/tweN. For example replace /dev/sdc by /dev/twe0 | |
191 | .B # and /dev/sdd by /dev/twe1. | |
192 | -.B \ \ /dev/sdc -d 3ware,0 -a -s S/../.././00 | |
193 | -.B \ \ /dev/sdc -d 3ware,1 -a -s S/../.././01 | |
194 | -.B \ \ /dev/sdd -d 3ware,2 -a -s S/../.././02 | |
195 | -.B \ \ /dev/sdd -d 3ware,3 -a -s S/../.././03 | |
196 | +.B \ \ /dev/sdc \-d 3ware,0 \-a \-s S/../.././00 | |
197 | +.B \ \ /dev/sdc \-d 3ware,1 \-a \-s S/../.././01 | |
198 | +.B \ \ /dev/sdd \-d 3ware,2 \-a \-s S/../.././02 | |
199 | +.B \ \ /dev/sdd \-d 3ware,3 \-a \-s S/../.././03 | |
200 | .B # | |
201 | .B # Two ATA disks on a 3ware 9000 controller. | |
202 | .B # Start long self-tests Sundays between midnight and | |
203 | -.B # 1am and 2-3 am | |
204 | -.B \ \ /dev/twa0 -d 3ware,0 -a -s L/../../7/00 | |
205 | -.B \ \ /dev/twa0 -d 3ware,1 -a -s L/../../7/02 | |
206 | +.B # 1 am and 2\(en3 am | |
207 | +.B \ \ /dev/twa0 \-d 3ware,0 \-a \-s L/../../7/00 | |
208 | +.B \ \ /dev/twa0 \-d 3ware,1 \-a \-s L/../../7/02 | |
209 | .B # | |
210 | .B # Two SATA (not SAS) disks on a 3ware 9750 controller. | |
211 | .B # Start long self-tests Sundays between midnight and | |
212 | -.B # 1am and 2-3 am | |
213 | +.B # 1 am and 2\(en3 am | |
214 | .\" %IF OS Linux | |
215 | -.B \ \ /dev/twl0 -d 3ware,0 -a -s L/../../7/00 | |
216 | -.B \ \ /dev/twl0 -d 3ware,1 -a -s L/../../7/02 | |
217 | +.B \ \ /dev/twl0 \-d 3ware,0 \-a \-s L/../../7/00 | |
218 | +.B \ \ /dev/twl0 \-d 3ware,1 \-a \-s L/../../7/02 | |
219 | .\" %ENDIF OS Linux | |
220 | .\" %IF OS FreeBSD | |
221 | -.B \ \ /dev/tws0 -d 3ware,0 -a -s L/../../7/00 | |
222 | -.B \ \ /dev/tws0 -d 3ware,1 -a -s L/../../7/02 | |
223 | +.B \ \ /dev/tws0 \-d 3ware,0 \-a \-s L/../../7/00 | |
224 | +.B \ \ /dev/tws0 \-d 3ware,1 \-a \-s L/../../7/02 | |
225 | .\" %ENDIF OS FreeBSD | |
226 | .B # | |
227 | .B # Three SATA disks on a HighPoint RocketRAID controller. | |
228 | -.B # Start short self-tests daily between 1-2, 2-3, and | |
229 | -.B # 3-4 am. | |
230 | +.B # Start short self-tests daily between 1\(en2, 2\(en3, and | |
231 | +.B # 3\(en4 am. | |
232 | .\" %IF OS Linux | |
233 | .B # under Linux | |
234 | -.B \ \ /dev/sde -d hpt,1/1 -a -s S/../.././01 | |
235 | -.B \ \ /dev/sde -d hpt,1/2 -a -s S/../.././02 | |
236 | -.B \ \ /dev/sde -d hpt,1/3 -a -s S/../.././03 | |
237 | +.B \ \ /dev/sde \-d hpt,1/1 \-a \-s S/../.././01 | |
238 | +.B \ \ /dev/sde \-d hpt,1/2 \-a \-s S/../.././02 | |
239 | +.B \ \ /dev/sde \-d hpt,1/3 \-a \-s S/../.././03 | |
240 | .\" %ENDIF OS Linux | |
241 | .\" %IF OS FreeBSD | |
242 | .B # under FreeBSD | |
243 | -.B /dev/hptrr -d hpt,1/1 -a -s S/../.././01 | |
244 | -.B /dev/hptrr -d hpt,1/2 -a -s S/../.././02 | |
245 | -.B /dev/hptrr -d hpt,1/3 -a -s S/../.././03 | |
246 | +.B /dev/hptrr \-d hpt,1/1 \-a \-s S/../.././01 | |
247 | +.B /dev/hptrr \-d hpt,1/2 \-a \-s S/../.././02 | |
248 | +.B /dev/hptrr \-d hpt,1/3 \-a \-s S/../.././03 | |
249 | .\" %ENDIF OS FreeBSD | |
250 | .B # | |
251 | -.B # Two SATA disks connected to a HighPoint RocketRAID | |
252 | +.B # Two SATA disks connected to a HighPoint RocketRAID | |
253 | .B # via a pmport device. Start long self-tests Sundays | |
254 | -.B # between midnight and 1am and 2-3 am. | |
255 | +.B # between midnight and 1 am and 2\(en3 am. | |
256 | .\" %IF OS Linux | |
257 | .B # under Linux | |
258 | -.B \ \ /dev/sde -d hpt,1/4/1 -a -s L/../../7/00 | |
259 | -.B \ \ /dev/sde -d hpt,1/4/2 -a -s L/../../7/02 | |
260 | +.B \ \ /dev/sde \-d hpt,1/4/1 \-a \-s L/../../7/00 | |
261 | +.B \ \ /dev/sde \-d hpt,1/4/2 \-a \-s L/../../7/02 | |
262 | .\" %ENDIF OS Linux | |
263 | .\" %IF OS FreeBSD | |
264 | .B # under FreeBSD | |
265 | -.B \ \ /dev/hptrr -d hpt,1/4/1 -a -s L/../../7/00 | |
266 | -.B \ \ /dev/hptrr -d hpt,1/4/2 -a -s L/../../7/02 | |
267 | +.B \ \ /dev/hptrr \-d hpt,1/4/1 \-a \-s L/../../7/00 | |
268 | +.B \ \ /dev/hptrr \-d hpt,1/4/2 \-a \-s L/../../7/02 | |
269 | .B # | |
270 | .\" %ENDIF OS FreeBSD | |
271 | .B # Three SATA disks connected to an Areca | |
272 | -.B # RAID controller. Start long self-tests Sundays | |
273 | +.B # RAID controller. o51Start long self-tests Sundays | |
274 | .B # between midnight and 3 am. | |
275 | .\" %IF OS Linux | |
276 | -.B \ \ /dev/sg2 -d areca,1 -a -s L/../../7/00 | |
277 | -.B \ \ /dev/sg2 -d areca,2 -a -s L/../../7/01 | |
278 | -.B \ \ /dev/sg2 -d areca,3 -a -s L/../../7/02 | |
279 | +.B \ \ /dev/sg2 \-d areca,1 \-a \-s L/../../7/00 | |
280 | +.B \ \ /dev/sg2 \-d areca,2 \-a \-s L/../../7/01 | |
281 | +.B \ \ /dev/sg2 \-d areca,3 \-a \-s L/../../7/02 | |
282 | .\" %ENDIF OS Linux | |
283 | .\" %IF OS FreeBSD | |
284 | -.B \ \ /dev/arcmsr0 -d areca,1 -a -s L/../../7/00 | |
285 | -.B \ \ /dev/arcmsr0 -d areca,2 -a -s L/../../7/01 | |
286 | -.B \ \ /dev/arcmsr0 -d areca,3 -a -s L/../../7/02 | |
287 | +.B \ \ /dev/arcmsr0 \-d areca,1 \-a \-s L/../../7/00 | |
288 | +.B \ \ /dev/arcmsr0 \-d areca,2 \-a \-s L/../../7/01 | |
289 | +.B \ \ /dev/arcmsr0 \-d areca,3 \-a \-s L/../../7/02 | |
290 | .\" %ENDIF OS FreeBSD | |
291 | .B # | |
292 | -.B # The following line enables monitoring of the | |
293 | -.B # ATA Error Log and the Self-Test Error Log. | |
294 | +.B # The following line enables monitoring of the | |
295 | +.B # ATA Error Log and the Self-Test Error Log. | |
296 | .B # It also tracks changes in both Prefailure | |
297 | .B # and Usage Attributes, apart from Attributes | |
298 | .B # 9, 194, and 231, and shows continued lines: | |
299 | .B # | |
300 | -.B \ \ /dev/sdd\ -l\ error\ \e | |
301 | -.B \ \ \ \ \ \ \ \ \ \ \ -l\ selftest\ \e | |
302 | -.B \ \ \ \ \ \ \ \ \ \ \ -t\ \e\ \ \ \ \ \ # Attributes not tracked: | |
303 | -.B \ \ \ \ \ \ \ \ \ \ \ -I\ 194\ \e\ \ # temperature | |
304 | -.B \ \ \ \ \ \ \ \ \ \ \ -I\ 231\ \e\ \ # also temperature | |
305 | -.B \ \ \ \ \ \ \ \ \ \ \ -I 9\ \ \ \ \ \ # power-on hours | |
306 | +.B \ \ /dev/sdd\ \-l\ error\ \e | |
307 | +.B \ \ \ \ \ \ \ \ \ \ \ \-l\ selftest\ \e | |
308 | +.B \ \ \ \ \ \ \ \ \ \ \ \-t\ \e\ \ \ \ \ \ # Attributes not tracked: | |
309 | +.B \ \ \ \ \ \ \ \ \ \ \ \-I\ 194\ \e\ \ # temperature | |
310 | +.B \ \ \ \ \ \ \ \ \ \ \ \-I\ 231\ \e\ \ # also temperature | |
311 | +.B \ \ \ \ \ \ \ \ \ \ \ \-I 9\ \ \ \ \ \ # power-on hours | |
312 | .B # | |
313 | .B ################################################ | |
314 | .fi | |
3360ee78 | 315 | @@ -237,23 +237,23 @@ |
089a6ff8 JD |
316 | This configuration: |
317 | .PP | |
318 | .nf | |
319 | -\ \ DEFAULT -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com | |
320 | +\ \ DEFAULT \-a \-R5! \-W 2,40,45 \-I 194 \-s L/../../7/00 \-m admin@example.com | |
321 | \ \ /dev/sda | |
322 | \ \ /dev/sdb | |
323 | \ \ /dev/sdc | |
324 | -\ \ DEFAULT -H -m admin@example.com | |
325 | +\ \ DEFAULT \-H \-m admin@example.com | |
326 | \ \ /dev/sdd | |
327 | -\ \ /dev/sde -d removable | |
328 | +\ \ /dev/sde \-d removable | |
329 | .fi | |
330 | .PP | |
331 | has the same effect as: | |
332 | .PP | |
333 | .nf | |
334 | -\ \ /dev/sda -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com | |
335 | -\ \ /dev/sdb -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com | |
336 | -\ \ /dev/sdc -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com | |
337 | -\ \ /dev/sdd -H -m admin@example.com | |
338 | -\ \ /dev/sde -d removable -H -m admin@example.com | |
339 | +\ \ /dev/sda \-a \-R5! \-W 2,40,45 \-I 194 \-s L/../../7/00 \-m admin@example.com | |
340 | +\ \ /dev/sdb \-a \-R5! \-W 2,40,45 \-I 194 \-s L/../../7/00 \-m admin@example.com | |
341 | +\ \ /dev/sdc \-a \-R5! \-W 2,40,45 \-I 194 \-s L/../../7/00 \-m admin@example.com | |
342 | +\ \ /dev/sdd \-H \-m admin@example.com | |
343 | +\ \ /dev/sde \-d removable \-H \-m admin@example.com | |
344 | .fi | |
345 | ||
346 | ||
3360ee78 | 347 | @@ -264,36 +264,36 @@ |
089a6ff8 JD |
348 | .B DEFAULT |
349 | on any line of the | |
350 | .B /usr/local/etc/smartd.conf | |
351 | -configuration file. Note that | |
352 | -.B these are NOT command-line options for | |
353 | +configuration file. Note that | |
354 | +.B these are NOT command-line options for | |
355 | \fBsmartd\fP. | |
356 | The Directives below may appear in any order, following the device | |
357 | -name. | |
358 | +name. | |
359 | ||
360 | .B For an ATA device, | |
361 | if no Directives appear, then the device will be monitored | |
362 | -as if the \'\-a\' Directive (monitor all SMART properties) had been given. | |
363 | +as if the \(aq\-a\(aq Directive (monitor all SMART properties) had been given. | |
364 | ||
365 | .B If a SCSI disk is listed, | |
366 | it will be monitored at the maximum implemented level: roughly | |
367 | -equivalent to using the \'\-H \-l selftest\' options for an ATA disk. | |
368 | -So with the exception of \'\-d\', \'\-m\', \'\-l selftest\', \'\-s\', and | |
369 | -\'\-M\', the Directives below are ignored for SCSI disks. For SCSI | |
370 | -disks, the \'\-m\' Directive sends a warning email if the SMART status | |
371 | +equivalent to using the \(aq\-H \-l selftest\(aq options for an ATA disk. | |
372 | +So with the exception of \(aq\-d\(aq, \(aq\-m\(aq, \(aq\-l selftest\(aq, \(aq\-s\(aq, and | |
373 | +\(aq\-M\(aq, the Directives below are ignored for SCSI disks. For SCSI | |
374 | +disks, the \(aq\-m\(aq Directive sends a warning email if the SMART status | |
375 | indicates a disk failure or problem, if the SCSI inquiry about disk | |
376 | status fails, or if new errors appear in the self-test log. | |
377 | ||
378 | .B If a 3ware controller is used | |
379 | then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?, | |
380 | -/dev/twa?, /dev/twl? or /dev/tws?) must be listed, along with the \'\-d 3ware,N\' | |
381 | +/dev/twa?, /dev/twl? or /dev/tws?) must be listed, along with the \(aq\-d 3ware,N\(aq | |
382 | Directive (see below). The individual ATA disks hosted by the 3ware | |
383 | controller appear to \fBsmartd\fP as normal ATA devices. Hence all | |
384 | the ATA directives can be used for these disks (but see note below). | |
385 | ||
386 | .\" %IF OS Linux FreeBSD | |
387 | .B If an Areca controller is used | |
388 | -then the corresponding device (SCSI /dev/sg? on Linux or /dev/arcmsr0 on | |
389 | -FreeBSD) must be listed, along with the \'\-d areca,N\' Directive (see below). | |
390 | +then the corresponding device (SCSI /dev/sg? on Linux or /dev/arcmsr0 on | |
391 | +FreeBSD) must be listed, along with the \(aq\-d areca,N\(aq Directive (see below). | |
392 | The individual SATA disks hosted by the Areca controller appear to \fBsmartd\fP | |
393 | as normal ATA devices. Hence all the ATA directives can be used for | |
394 | these disks. Areca firmware version 1.46 or later which supports | |
3360ee78 | 395 | @@ -340,9 +340,9 @@ |
089a6ff8 JD |
396 | (SATL) between the disk and the operating system. |
397 | SAT defines two ATA PASS THROUGH SCSI commands, one 12 bytes long and | |
398 | the other 16 bytes long. The default is the 16 byte variant which can be | |
399 | -overridden with either \'\-d sat,12\' or \'\-d sat,16\'. | |
400 | +overridden with either \(aq\-d sat,12\(aq or \(aq\-d sat,16\(aq. | |
401 | ||
402 | -If \'\-d sat,auto\' is specified, device type SAT (for ATA/SATA disks) is | |
403 | +If \(aq\-d sat,auto\(aq is specified, device type SAT (for ATA/SATA disks) is | |
404 | only used if the SCSI INQUIRY data reports a SATL (VENDOR: "ATA "). | |
405 | Otherwise device type SCSI (for SCSI/SAS disks) is used. | |
406 | ||
3360ee78 | 407 | @@ -350,28 +350,28 @@ |
089a6ff8 JD |
408 | \- this device type is for ATA disks that are behind a Cypress USB to PATA |
409 | bridge. This will use the ATACB proprietary scsi pass through command. | |
410 | The default SCSI operation code is 0x24, but although it can be overridden | |
411 | -with \'\-d usbcypress,0xN\', where N is the scsi operation code, | |
412 | +with \(aq\-d usbcypress,0xN\(aq, where N is the scsi operation code, | |
413 | you're running the risk of damage to the device or filesystems on it. | |
414 | ||
415 | .I usbjmicron[,p][,x][,PORT] | |
416 | \- this device type is for SATA disks that are behind a JMicron USB to | |
417 | -PATA/SATA bridge. The 48-bit ATA commands (required e.g. for \'\-l xerror\', | |
418 | +PATA/SATA bridge. The 48-bit ATA commands (required e.g.\& for \(aq\-l xerror\(aq, | |
419 | see below) do not work with all of these bridges and are therefore disabled by | |
420 | -default. These commands can be enabled by \'\-d usbjmicron,x\'. | |
421 | +default. These commands can be enabled by \(aq\-d usbjmicron,x\(aq. | |
422 | If two disks are connected to a bridge with two ports, an error message is printed | |
423 | if no PORT is specified. | |
424 | -The port can be specified by \'\-d usbjmicron[,x],PORT\' where PORT is 0 | |
425 | +The port can be specified by \(aq\-d usbjmicron[,x],PORT\(aq where PORT is 0 | |
426 | (master) or 1 (slave). This is not necessary if the device uses a port | |
427 | multiplier to connect multiple disks to one port. The disks appear under | |
428 | separate /dev/ice names then. | |
429 | -CAUTION: Specifying \',x\' for a device which does not support it results | |
430 | +CAUTION: Specifying \(aq,x\(aq for a device which does not support it results | |
431 | in I/O errors and may disconnect the drive. The same applies if the specified | |
432 | PORT does not exist or is not connected to a disk. | |
433 | ||
434 | The Prolific PL2507/3507 USB bridges with older firmware support a pass-through | |
435 | -command similar to JMicron and work with \'\-d usbjmicron,0\'. | |
436 | +command similar to JMicron and work with \(aq\-d usbjmicron,0\(aq. | |
437 | Newer Prolific firmware requires a modified command which can be selected by | |
438 | -\'\-d usbjmicron,p\'. | |
439 | +\(aq\-d usbjmicron,p\(aq. | |
440 | Note that this does not yet support the SMART status command. | |
441 | ||
442 | .I usbprolific | |
3360ee78 | 443 | @@ -396,7 +396,7 @@ |
089a6ff8 JD |
444 | This interface will also work for Dell PERC controllers. |
445 | In log files and email messages this disk will be identified as | |
446 | megaraid_disk_XXX with XXX in the range from 000 to 127 inclusive. | |
447 | -It is possible to set RAID device name as /dev/bus/N, where N is a SCSI bus | |
448 | +It is possible to set RAID device name as /dev/bus/N, where N is a SCSI bus | |
449 | number. | |
450 | Please see the \fBsmartctl\fP(8) man page for further details. | |
451 | ||
3360ee78 | 452 | @@ -432,7 +432,7 @@ |
089a6ff8 JD |
453 | \- [FreeBSD, Linux, Windows and Cygwin only] the device consists of one or more SATA disks |
454 | connected to an Areca SATA RAID controller. The positive integer N (in the range | |
455 | from 1 to 24 inclusive) denotes which disk on the controller is monitored. | |
456 | -In log files and email messages this disk will be identifed as | |
457 | +In log files and email messages this disk will be identified as | |
458 | areca_disk_XX with XX in the range from 01 to 24 inclusive. | |
459 | Please see the \fBsmartctl\fP(8) man page for further details. | |
460 | ||
3360ee78 | 461 | @@ -472,7 +472,7 @@ |
089a6ff8 JD |
462 | This allows to ignore specific devices which are detected by a following |
463 | DEVICESCAN configuration line. | |
464 | It may also be used to temporary disable longer multi-line configuration entries. | |
465 | -This Directive may be used in conjunction with the other \'\-d\' Directives. | |
466 | +This Directive may be used in conjunction with the other \(aq\-d\(aq Directives. | |
467 | ||
468 | .I removable | |
469 | \- the device or its media is removable. This indicates to | |
3360ee78 | 470 | @@ -480,16 +480,16 @@ |
089a6ff8 JD |
471 | that it should continue (instead of exiting, which is the default |
472 | behavior) if the device does not appear to be present when | |
473 | \fBsmartd\fP is started. This Directive may be used in conjunction | |
474 | -with the other \'\-d\' Directives. | |
475 | +with the other \(aq\-d\(aq Directives. | |
476 | .TP | |
477 | .B \-n POWERMODE[,N][,q] | |
478 | -[ATA only] This \'nocheck\' Directive is used to prevent a disk from | |
479 | +[ATA only] This \(aqnocheck\(aq Directive is used to prevent a disk from | |
480 | being spun-up when it is periodically polled by \fBsmartd\fP. | |
481 | ||
482 | -ATA disks have five different power states. In order of increasing | |
483 | -power consumption they are: \'OFF\', \'SLEEP\', \'STANDBY\', \'IDLE\', | |
484 | -and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the | |
485 | -disk\'s platters are not spinning. But usually, in response to SMART | |
486 | +ATA disks have five different power states. In order of increasing | |
487 | +power consumption they are: \(aqOFF\(aq, \(aqSLEEP\(aq, \(aqSTANDBY\(aq, \(aqIDLE\(aq, | |
488 | +and \(aqACTIVE\(aq. Typically in the OFF, SLEEP, and STANDBY modes the | |
489 | +disk's platters are not spinning. But usually, in response to SMART | |
490 | commands issued by \fBsmartd\fP, the disk platters are spun up. So if | |
491 | this option is not used, then a disk which is in a low-power mode may | |
492 | be spun up and put into a higher-power mode when it is periodically | |
3360ee78 | 493 | @@ -497,11 +497,11 @@ |
089a6ff8 JD |
494 | |
495 | Note that if the disk is in SLEEP mode when \fBsmartd\fP is started, | |
496 | then it won't respond to \fBsmartd\fP commands, and so the disk won't | |
497 | -be registered as a device for \fBsmartd\fP to monitor. If a disk is in | |
498 | +be registered as a device for \fBsmartd\fP to monitor. If a disk is in | |
499 | any other low-power mode, then the commands issued by \fBsmartd\fP to | |
500 | register the disk will probably cause it to spin-up. | |
501 | ||
502 | -The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s | |
503 | +The \(aq\fB\-n\fP\(aq (nocheck) Directive specifies if \fBsmartd\fP's | |
504 | periodic checks should still be carried out when the device is in a | |
505 | low-power mode. It may be used to prevent a disk from being spun-up | |
506 | by periodic \fBsmartd\fP polling. The allowed values of POWERMODE | |
3360ee78 | 507 | @@ -509,7 +509,7 @@ |
089a6ff8 JD |
508 | |
509 | .I never | |
510 | \- \fBsmartd\fP will poll (check) the device regardless of its power | |
511 | -mode. This may cause a disk which is spun-down to be spun-up when | |
512 | +mode. This may cause a disk which is spun-down to be spun-up when | |
513 | \fBsmartd\fP checks it. This is the default behavior if the '\-n' | |
514 | Directive is not given. | |
515 | ||
3360ee78 | 516 | @@ -528,16 +528,16 @@ |
089a6ff8 JD |
517 | not what you want. |
518 | ||
519 | Maximum number of skipped checks (in a row) can be specified by | |
520 | -appending positive number \',N\' to POWERMODE (like \'\-n standby,15\'). | |
521 | +appending positive number \(aq,N\(aq to POWERMODE (like \(aq\-n standby,15\(aq). | |
522 | After N checks are skipped in a row, powermode is ignored and the | |
523 | check is performed anyway. | |
524 | ||
525 | When a periodic test is skipped, \fBsmartd\fP normally writes an | |
526 | -informal log message. The message can be suppressed by appending | |
527 | -the option \',q\' to POWERMODE (like \'\-n standby,q\'). | |
528 | +informal log message. The message can be suppressed by appending | |
529 | +the option \(aq,q\(aq to POWERMODE (like \(aq\-n standby,q\(aq). | |
530 | This prevents a laptop disk from spinning up due to this message. | |
531 | ||
532 | -Both \',N\' and \',q\' can be specified together. | |
533 | +Both \(aq,N\(aq and \(aq,q\(aq can be specified together. | |
534 | .TP | |
535 | .B \-T TYPE | |
536 | Specifies how tolerant | |
3360ee78 | 537 | @@ -582,7 +582,7 @@ |
089a6ff8 JD |
538 | STATUS command. |
539 | If this command reports a failing health status, then disk | |
540 | failure is predicted in less than 24 hours, and a message at loglevel | |
541 | -.B \'LOG_CRIT\' | |
542 | +.B \(aqLOG_CRIT\(aq | |
543 | will be logged to syslog. [Please see the | |
544 | .B smartctl \-H | |
545 | command-line option.] | |
3360ee78 GI |
546 | @@ -615,7 +615,7 @@ |
547 | \- [ATA] report if the number of ATA errors reported in the Extended | |
089a6ff8 JD |
548 | Comprehensive SMART error log has increased since the last check. |
549 | ||
550 | -If both \'\-l error\' and \'\-l xerror\' are specified, smartd checks | |
551 | +If both \(aq\-l error\(aq and \(aq\-l xerror\(aq are specified, smartd checks | |
552 | the maximum of both values. | |
553 | ||
554 | [Please see the \fBsmartctl \-l xerror\fP command-line option.] | |
3360ee78 | 555 | @@ -633,10 +633,10 @@ |
089a6ff8 JD |
556 | associated with the most recent failed test has increased. Note that |
557 | such errors will \fBonly\fP be logged if you run self-tests on the | |
558 | disk (and it fails a test!). Self-Tests can be run automatically by | |
559 | -\fBsmartd\fP: please see the \fB\'\-s\'\fP Directive below. | |
560 | -Self-Tests can also be run manually by using the \fB\'\-t\ short\'\fP | |
561 | -and \fB\'\-t\ long\'\fP options of \fBsmartctl\fP and the results of | |
562 | -the testing can be observed using the \fBsmartctl \'\-l\ selftest\'\fP | |
563 | +\fBsmartd\fP: please see the \fB\(aq\-s\(aq\fP Directive below. | |
564 | +Self-Tests can also be run manually by using the \fB\(aq\-t\ short\(aq\fP | |
565 | +and \fB\(aq\-t\ long\(aq\fP options of \fBsmartctl\fP and the results of | |
566 | +the testing can be observed using the \fBsmartctl \(aq\-l\ selftest\(aq\fP | |
567 | command-line option. | |
568 | [Please see the \fBsmartctl \-l\fP and \fB\-t\fP command-line | |
569 | options.] | |
3360ee78 | 570 | @@ -650,16 +650,16 @@ |
089a6ff8 JD |
571 | \- [ATA only] report if the Offline Data Collection status has changed |
572 | since the last check. The report will be logged as LOG_CRIT if the new | |
573 | status indicates an error. With some drives the status often changes, | |
574 | -therefore \'\-l offlinests\' is not enabled by '\-a\' Directive. | |
575 | +therefore \(aq\-l offlinests\(aq is not enabled by \(aq\-a\(aq Directive. | |
576 | .\" %IF NOT OS Cygwin Windows | |
577 | -.\"! Appending \',ns\' (no standby) to this directive is not implemented | |
578 | +.\"! Appending ',ns' (no standby) to this directive is not implemented | |
579 | .\"! on OS_MAN_FILTER. | |
580 | .\" %ENDIF NOT OS Cygwin Windows | |
581 | .\" %IF OS Cygwin Windows | |
582 | ||
583 | -[Windows and Cygwin only] If \',ns\' (no standby) is appended to this | |
584 | +[Windows and Cygwin only] If \(aq,ns\(aq (no standby) is appended to this | |
585 | directive, smartd disables system auto standby as long as an Offline | |
586 | -Data Collection is in progress. See \'\-l selfteststs,ns\' below. | |
587 | +Data Collection is in progress. See \(aq\-l selfteststs,ns\(aq below. | |
588 | .\" %ENDIF OS Cygwin Windows | |
589 | ||
590 | .I selfteststs[,ns] | |
3360ee78 | 591 | @@ -667,16 +667,16 @@ |
089a6ff8 JD |
592 | since the last check. The report will be logged as LOG_CRIT if the new |
593 | status indicates an error. | |
594 | .\" %IF NOT OS Cygwin Windows | |
595 | -.\"! Appending \',ns\' (no standby) to this directive is not implemented | |
596 | +.\"! Appending ',ns' (no standby) to this directive is not implemented | |
597 | .\"! on OS_MAN_FILTER. | |
598 | .\" %ENDIF NOT OS Cygwin Windows | |
599 | .\" %IF OS Cygwin Windows | |
600 | ||
601 | -[Windows and Cygwin only] If \',ns\' (no standby) is appended to this | |
602 | +[Windows and Cygwin only] If \(aq,ns\(aq (no standby) is appended to this | |
603 | directive, smartd disables system auto standby as long as a Self-Test | |
604 | is in progress. This prevents that a Self-Test is aborted because the | |
605 | OS sets the system to a standby/sleep mode when idle. Smartd check | |
606 | -interval (\'\-i\' option) should be shorter than the configured idle | |
607 | +interval (\(aq\-i\(aq option) should be shorter than the configured idle | |
608 | timeout. Auto standby is not disabled if the system is running on | |
609 | battery. | |
610 | .\" %ENDIF OS Cygwin Windows | |
3360ee78 | 611 | @@ -718,25 +718,25 @@ |
089a6ff8 JD |
612 | Run Self-Tests or Offline Immediate Tests, at scheduled times. A |
613 | Self- or Offline Immediate Test will be run at the end of periodic | |
614 | device polling, if all 12 characters of the string \fBT/MM/DD/d/HH\fP | |
615 | -match the extended regular expression \fBREGEXP\fP. Here: | |
616 | +match the extended regular expression \fBREGEXP\fP. Here: | |
617 | .RS 7 | |
618 | .IP \fBT\fP 4 | |
619 | is the type of the test. The values that \fBsmartd\fP will try to | |
620 | -match (in turn) are: \'L\' for a \fBL\fPong Self-Test, \'S\' for a | |
621 | -\fBS\fPhort Self-Test, \'C\' for a \fBC\fPonveyance Self-Test (ATA | |
622 | -only), and \'O\' for an \fBO\fPffline Immediate Test (ATA only). As | |
623 | +match (in turn) are: \(aqL\(aq for a \fBL\fPong Self-Test, \(aqS\(aq for a | |
624 | +\fBS\fPhort Self-Test, \(aqC\(aq for a \fBC\fPonveyance Self-Test (ATA | |
625 | +only), and \(aqO\(aq for an \fBO\fPffline Immediate Test (ATA only). As | |
626 | soon as a match is found, the test will be started and no additional | |
627 | matches will be sought for that device and that polling cycle. | |
628 | ||
629 | -To run scheduled Selective Self-Tests, use \'n\' for \fBn\fPext span, | |
630 | -\'r\' to \fBr\fPedo last span, or \'c\' to \fBc\fPontinue with next span | |
631 | +To run scheduled Selective Self-Tests, use \(aqn\(aq for \fBn\fPext span, | |
632 | +\(aqr\(aq to \fBr\fPedo last span, or \(aqc\(aq to \fBc\fPontinue with next span | |
633 | or redo last span based on status of last test. | |
634 | The LBA range is based on the first span from the last test. | |
635 | See the \fBsmartctl \-t select,[next|redo|cont]\fP options for | |
636 | further info. | |
637 | ||
638 | -Some disks (e.g. WD) do not preserve the selective self test log accross | |
639 | -power cycles. If state persistence (\'\-s\' option) is enabled, the last | |
640 | +Some disks (e.g.\& WD) do not preserve the selective self test log across | |
641 | +power cycles. If state persistence (\(aq\-s\(aq option) is enabled, the last | |
642 | test span is preserved by smartd and used if (and only if) the selective | |
643 | self test log is empty. | |
644 | .IP \fBMM\fP 4 | |
3360ee78 | 645 | @@ -744,7 +744,7 @@ |
089a6ff8 JD |
646 | range is from 01 (January) to 12 (December) inclusive. Do \fBnot\fP |
647 | use a single decimal digit or the match will always fail! | |
648 | .IP \fBDD\fP 4 | |
649 | -is the day of the month, expressed with two decimal digits. The | |
650 | +is the day of the month, expressed with two decimal digits. The | |
651 | range is from 01 to 31 inclusive. Do \fBnot\fP | |
652 | use a single decimal digit or the match will always fail! | |
653 | .IP \fBd\fP 4 | |
3360ee78 | 654 | @@ -752,7 +752,7 @@ |
089a6ff8 JD |
655 | range is from 1 (Monday) to 7 (Sunday) inclusive. |
656 | .IP \fBHH\fP 4 | |
657 | is the hour of the day, written with two decimal digits, and given in | |
658 | -hours after midnight. The range is 00 (midnight to just before 1am) | |
659 | +hours after midnight. The range is 00 (midnight to just before 1 am) | |
660 | to 23 (11pm to just before midnight) inclusive. Do \fBnot\fP use a | |
661 | single decimal digit or the match will always fail! | |
662 | .RE | |
3360ee78 | 663 | @@ -761,37 +761,37 @@ |
089a6ff8 JD |
664 | .TP |
665 | .B \& | |
666 | Some examples follow. In reading these, keep in mind that in extended | |
667 | -regular expressions a dot \fB\'.\'\fP matches any single character, and | |
668 | -a parenthetical expression such as \fB\'(A|B|C)\'\fP denotes any one of the three possibilities \fBA\fP, | |
669 | -\fBB\fP, or \fBC\fP. | |
670 | +regular expressions a dot \fB\(aq.\(aq\fP matches any single character, and | |
671 | +a parenthetical expression such as \fB\(aq(A|B|C)\(aq\fP denotes any one | |
672 | +of the three possibilities \fBA\fP, \fBB\fP, or \fBC\fP. | |
673 | ||
674 | -To schedule a short Self-Test between 2-3am every morning, use: | |
675 | +To schedule a short Self-Test between 2\(en3 am every morning, use: | |
676 | .nf | |
677 | \fB \-s S/../.././02\fP | |
678 | .fi | |
679 | -To schedule a long Self-Test between 4-5am every Sunday morning, use: | |
680 | +To schedule a long Self-Test between 4\(en5 am every Sunday morning, use: | |
681 | .nf | |
682 | \fB \-s L/../../7/04\fP | |
683 | .fi | |
684 | -To schedule a long Self-Test between 10-11pm on the first and | |
685 | +To schedule a long Self-Test between 10\(en11 pm on the first and | |
686 | fifteenth day of each month, use: | |
687 | .nf | |
688 | \fB \-s L/../(01|15)/./22\fP | |
689 | .fi | |
690 | -To schedule an Offline Immediate test after every midnight, 6am, | |
691 | -noon,and 6pm, plus a Short Self-Test daily at 1-2am and a Long | |
692 | -Self-Test every Saturday at 3-4am, use: | |
693 | +To schedule an Offline Immediate test after every midnight, 6 am, | |
694 | +noon, and 6 pm, plus a Short Self-Test daily at 1\(en2 am and a Long | |
695 | +Self-Test every Saturday at 3\(en4 am, use: | |
696 | .nf | |
697 | \fB \-s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03)\fP | |
698 | .fi | |
699 | If Long Self-Tests of a large disks take longer than the system uptime, | |
700 | a full disk test can be performed by several Selective Self-Tests. | |
701 | -To setup a full test of a 1TB disk within 20 days (one 50GB span | |
702 | +To setup a full test of a 1 TB disk within 20 days (one 50 GB span | |
703 | each day), run this command once: | |
704 | .nf | |
705 | - smartctl -t select,0-99999999 /dev/sda | |
706 | + smartctl \-t select,0-99999999 /dev/sda | |
707 | .fi | |
708 | -To run the next test spans on Monday-Friday between 12-13am, run smartd | |
709 | +To run the next test spans on Monday\(enFriday between 12\(en13 am, run smartd | |
710 | with this directive: | |
711 | .nf | |
712 | \fB \-s n/../../[1-5]/12\fP | |
3360ee78 | 713 | @@ -802,7 +802,7 @@ |
089a6ff8 JD |
714 | device polling, if the current local date, time, and test type, match |
715 | \fBREGEXP\fP. By default the regularly-scheduled device polling | |
716 | occurs every thirty minutes after starting \fBsmartd\fP. Take caution | |
717 | -if you use the \'\-i\' option to make this polling interval more than | |
718 | +if you use the \(aq\-i\(aq option to make this polling interval more than | |
719 | sixty minutes: the poll times may fail to coincide with any of the | |
720 | testing times that you have specified with \fBREGEXP\fP. In this case | |
721 | the test will be run following the next device polling. | |
3360ee78 | 722 | @@ -817,7 +817,7 @@ |
089a6ff8 JD |
723 | |
724 | To avoid performance problems during system boot, \fBsmartd\fP will | |
725 | not attempt to run any scheduled tests following the very first | |
726 | -device polling (unless \'\-q onecheck\' is specified). | |
727 | +device polling (unless \(aq\-q onecheck\(aq is specified). | |
728 | ||
729 | Each time a test is run, \fBsmartd\fP will log an entry to SYSLOG. | |
730 | You can use these or the '-q showtests' command-line option to verify | |
3360ee78 | 731 | @@ -827,12 +827,12 @@ |
089a6ff8 JD |
732 | longer test type has precedence. This is usually the desired behavior. |
733 | ||
734 | If the scheduled tests are used in conjunction with state persistence | |
735 | -(\'\-s\' option), smartd will also try to match the hours since last | |
736 | -shutdown (or 90 days at most). If any test would have been started | |
737 | +(\(aq\-s\(aq option), smartd will also try to match the hours since last | |
738 | +shutdown (or 90 days at most). If any test would have been started | |
739 | during downtime, the longest (see above) of these tests is run after | |
740 | second device polling. | |
741 | ||
742 | -If the \'\-n\' directive is used and any test would have been started | |
743 | +If the \(aq\-n\(aq directive is used and any test would have been started | |
744 | during disk standby time, the longest of these tests is run when the | |
745 | disk is active again. | |
746 | ||
3360ee78 | 747 | @@ -844,24 +844,24 @@ |
089a6ff8 JD |
748 | mistake. |
749 | .TP | |
750 | .B \-m ADD | |
751 | -Send a warning email to the email address \fBADD\fP if the \'\-H\', | |
752 | -\'\-l\', \'\-f\', \'\-C\', or \'\-O\' Directives detect a failure or a | |
753 | -new error, or if a SMART command to the disk fails. This Directive | |
754 | +Send a warning email to the email address \fBADD\fP if the \(aq\-H\(aq, | |
755 | +\(aq\-l\(aq, \(aq\-f\(aq, \(aq\-C\(aq, or \(aq\-O\(aq Directives detect a failure or a | |
756 | +new error, or if a SMART command to the disk fails. This Directive | |
757 | only works in conjunction with these other Directives (or with the | |
758 | -equivalent default \'\-a\' Directive). | |
759 | +equivalent default \(aq\-a\(aq Directive). | |
760 | ||
761 | To prevent your email in-box from getting filled up with warning | |
762 | messages, by default only a single warning will be sent for each of | |
763 | -the enabled alert types, \'\-H\', \'\-l\', \'\-f\', \'\-C\', or | |
764 | -\'\-O\' even if more than one failure or error is detected or if the | |
765 | +the enabled alert types, \(aq\-H\(aq, \(aq\-l\(aq, \(aq\-f\(aq, \(aq\-C\(aq, or | |
766 | +\(aq\-O\(aq even if more than one failure or error is detected or if the | |
767 | failure or error persists. [This behavior can be modified; see the | |
768 | -\'\-M\' Directive below.] | |
769 | +\(aq\-M\(aq Directive below.] | |
770 | ||
771 | To send email to more than one user, please use the following "comma | |
772 | separated" form for the address: \fBuser1@add1,user2@add2,...,userN@addN\fP | |
773 | (with no spaces). | |
774 | ||
775 | -To test that email is being sent correctly, use the \'\-M test\' | |
776 | +To test that email is being sent correctly, use the \(aq\-M test\(aq | |
777 | Directive described below to send one test email message on | |
778 | \fBsmartd\fP | |
779 | startup. | |
3360ee78 | 780 | @@ -872,38 +872,38 @@ |
089a6ff8 JD |
781 | \fBsmartd\fP |
782 | was started. If you wish to specify an explicit path to the mail | |
783 | executable (for example /usr/local/bin/mail) or a custom script to | |
784 | -run, please use the \'\-M exec\' Directive below. | |
785 | +run, please use the \(aq\-M exec\(aq Directive below. | |
786 | ||
787 | .\" %IF OS Windows | |
788 | -On Windows, the \'\fBBlat\fP\' mailer | |
789 | +On Windows, the \(aq\fBBlat\fP\(aq mailer | |
790 | (\fBhttp://blat.sourceforge.net/\fP) is used by default. | |
791 | This mailer uses a different command line syntax, see | |
792 | -\'\-M exec\' below. | |
793 | +\(aq\-M exec\(aq below. | |
794 | ||
795 | .\" %ENDIF OS Windows | |
796 | Note also that there is a special argument | |
797 | .B <nomailer> | |
798 | -which can be given to the \'\-m\' Directive in conjunction with the \'\-M | |
799 | -exec\' Directive. Please see below for an explanation of its effect. | |
800 | +which can be given to the \(aq\-m\(aq Directive in conjunction with the \(aq\-M | |
801 | +exec\(aq Directive. Please see below for an explanation of its effect. | |
802 | ||
803 | If the mailer or the shell running it produces any STDERR/STDOUT | |
804 | output, then a snippet of that output will be copied to SYSLOG. The | |
805 | -remainder of the output is discarded. If problems are encountered in | |
806 | +remainder of the output is discarded. If problems are encountered in | |
807 | sending mail, this should help you to understand and fix them. If | |
808 | you have mail problems, we recommend running \fBsmartd\fP in debug | |
809 | -mode with the \'-d\' flag, using the \'-M test\' Directive described | |
810 | +mode with the \(aq\-d\(aq flag, using the \(aq\-M test\(aq Directive described | |
811 | below. | |
812 | .\" %IF ENABLE_SMARTDPLUGINDIR | |
813 | .\" %IF NOT OS Windows | |
814 | ||
815 | -If a word of the comma separated list has the form \'@plugin\', a custom | |
816 | +If a word of the comma separated list has the form \(aq@plugin\(aq, a custom | |
817 | script /usr/local/etc/smartd_warning.d/plugin is run and the word is | |
818 | -removed from the list before sending mail. The string \'plugin\' may be any | |
819 | -valid name except \'ALL\'. | |
820 | -If \'@ALL\' is specified, all scripts in /usr/local/etc/smartd_warning.d/* | |
821 | +removed from the list before sending mail. The string \(aqplugin\(aq may be any | |
822 | +valid name except \(aqALL\(aq. | |
823 | +If \(aq@ALL\(aq is specified, all scripts in /usr/local/etc/smartd_warning.d/* | |
824 | are run instead. | |
825 | This is handled by the script /usr/local/etc/smartd_warning.sh | |
826 | -(see also \'\-M exec\' below). | |
827 | +(see also \(aq\-M exec\(aq below). | |
828 | .\" %ENDIF NOT OS Windows | |
829 | .\" %ENDIF ENABLE_SMARTDPLUGINDIR | |
830 | .\" %IF OS Windows | |
3360ee78 | 831 | @@ -935,17 +935,17 @@ |
089a6ff8 JD |
832 | |
833 | .I once | |
834 | \- send only one warning email for each type of disk problem detected. This | |
835 | -is the default unless state persistence (\'\-s\' option) is enabled. | |
836 | +is the default unless state persistence (\(aq\-s\(aq option) is enabled. | |
837 | ||
838 | .I daily | |
839 | \- send additional warning reminder emails, once per day, for each type | |
840 | of disk problem detected. This is the default if state persistence | |
841 | -(\'\-s\' option) is enabled. | |
842 | +(\(aq\-s\(aq option) is enabled. | |
843 | ||
844 | .I diminishing | |
845 | \- send additional warning reminder emails, after a one-day interval, | |
846 | then a two-day interval, then a four-day interval, and so on for each | |
847 | -type of disk problem detected. Each interval is twice as long as the | |
848 | +type of disk problem detected. Each interval is twice as long as the | |
849 | previous interval. | |
850 | ||
851 | If a disk problem is no longer detected, the internal email counter is | |
3360ee78 | 852 | @@ -960,7 +960,7 @@ |
089a6ff8 JD |
853 | startup. This allows one to verify that email is delivered correctly. |
854 | Note that if this Directive is used, | |
855 | \fBsmartd\fP | |
856 | -will also send the normal email warnings that were enabled with the \'\-m\' Directive, | |
857 | +will also send the normal email warnings that were enabled with the \(aq\-m\(aq Directive, | |
858 | in addition to the single test email! | |
859 | ||
860 | .I exec PATH | |
3360ee78 | 861 | @@ -977,7 +977,7 @@ |
089a6ff8 JD |
862 | By setting PATH to point to a customized script, you can make |
863 | \fBsmartd\fP perform useful tricks when a disk problem is detected | |
864 | (beeping the console, shutting down the machine, broadcasting warnings | |
865 | -to all logged-in users, etc.) But please be careful. \fBsmartd\fP | |
866 | +to all logged-in users, etc.\&) But please be careful. \fBsmartd\fP | |
867 | will \fBblock\fP until the executable PATH returns, so if your | |
868 | executable hangs, then \fBsmartd\fP will also hang. | |
869 | .\" %IF NOT OS Windows | |
3360ee78 | 870 | @@ -986,7 +986,7 @@ |
089a6ff8 JD |
871 | .\" %ENDIF NOT OS Windows |
872 | ||
873 | The return status of the executable is recorded by \fBsmartd\fP in | |
874 | -SYSLOG. The executable is not expected to write to STDOUT or | |
875 | +SYSLOG. The executable is not expected to write to STDOUT or | |
876 | STDERR. If it does, then this is interpreted as indicating that | |
877 | something is going wrong with your executable, and a fragment of this | |
878 | output is logged to SYSLOG to help you to understand the problem. | |
3360ee78 | 879 | @@ -995,25 +995,27 @@ |
089a6ff8 JD |
880 | |
881 | Before running the executable, \fBsmartd\fP sets a number of | |
882 | environment variables. These environment variables may be used to | |
883 | -control the executable\'s behavior. The environment variables | |
884 | +control the executable's behavior. The environment variables | |
885 | exported by \fBsmartd\fP are: | |
886 | .RS 7 | |
887 | .IP \fBSMARTD_MAILER\fP 4 | |
888 | -is set to the argument of \-M exec, if present or else to \'mail\' | |
889 | +is set to the argument of \-M exec, if present or else to \(aqmail\(aq | |
890 | (examples: /usr/local/bin/mail, mail). | |
891 | .IP \fBSMARTD_DEVICE\fP 4 | |
892 | is set to the device path (example: /dev/sda). | |
893 | .IP \fBSMARTD_DEVICETYPE\fP 4 | |
894 | -is set to the device type specified by \'-d\' directive or | |
895 | -\'auto\' if none. | |
896 | +is set to the device type specified by \(aq\-d\(aq directive or | |
897 | +\(aqauto\(aq if none. | |
898 | .IP \fBSMARTD_DEVICESTRING\fP 4 | |
899 | is set to the device description. For SMARTD_DEVICETYPE of ata or | |
900 | scsi, this is the same as SMARTD_DEVICE. For 3ware RAID controllers, | |
901 | -the form used is \'/dev/sdc [3ware_disk_01]\'. For HighPoint | |
902 | -RocketRAID controller, the form is \'/dev/sdd [hpt_1/1/1]\' under Linux | |
903 | -or \'/dev/hptrr [hpt_1/1/1]\' under FreeBSD. For Areca controllers, the | |
904 | -form is \'/dev/sg2 [areca_disk_09]\' on Linux or \'/dev/arcmsr0 [areca_disk_09]\' on FreeBSD. In these cases the device string | |
905 | -contains a space and is NOT quoted. So to use $SMARTD_DEVICESTRING in a | |
906 | +the form used is \(aq/dev/sdc [3ware_disk_01]\(aq. For HighPoint | |
907 | +RocketRAID controller, the form is \(aq/dev/sdd [hpt_1/1/1]\(aq under Linux | |
908 | +or \(aq/dev/hptrr [hpt_1/1/1]\(aq under FreeBSD. For Areca controllers, | |
909 | +the form is \(aq/dev/sg2 [areca_disk_09]\(aq on Linux or \(aq/dev/arcmsr0 | |
910 | +[areca_disk_09]\(aq on FreeBSD. | |
911 | +In these cases the device string contains a space and is NOT quoted. | |
912 | +So to use $SMARTD_DEVICESTRING in a | |
913 | shell script you should probably enclose it in double quotes. | |
914 | .IP \fBSMARTD_DEVICEINFO\fP 4 | |
915 | is set to device identify information. It includes most of the info printed | |
3360ee78 | 916 | @@ -1052,7 +1054,7 @@ |
089a6ff8 JD |
917 | .br |
918 | \fIFailedOpenDevice\fP: the open() command to the device failed. | |
919 | .IP \fBSMARTD_ADDRESS\fP 4 | |
920 | -is determined by the address argument ADD of the \'\-m\' Directive. | |
921 | +is determined by the address argument ADD of the \(aq\-m\(aq Directive. | |
922 | If ADD is \fB<nomailer>\fP, then \fBSMARTD_ADDRESS\fP is not set. | |
923 | Otherwise, it is set to the comma-separated-list of email addresses | |
924 | given by the argument ADD, with the commas replaced by spaces | |
3360ee78 | 925 | @@ -1067,17 +1069,18 @@ |
089a6ff8 JD |
926 | .\" %ENDIF OS Windows |
927 | .IP \fBSMARTD_MESSAGE\fP 4 | |
928 | is set to the one sentence summary warning email message string from | |
929 | -\fBsmartd\fP. | |
930 | -This message string contains space characters and is NOT quoted. So to | |
931 | +\fBsmartd\fP.m46 | |
932 | +This message string contains space characters and is NOT quoted. So to | |
933 | use $SMARTD_MESSAGE in a shell script you should probably enclose it in | |
934 | double quotes. | |
935 | .\" %IF NOT OS Windows | |
936 | .IP \fBSMARTD_FULLMESSAGE\fP 4 | |
937 | is set to the contents of the entire email warning message string from | |
938 | -\fBsmartd\fP. | |
939 | -This message string contains space and return characters and is NOT quoted. So to | |
940 | -use $SMARTD_FULLMESSAGE in a shell script you should probably enclose it in | |
941 | -double quotes. | |
942 | +\fBsmartd\fP. | |
943 | +This message string contains space and return characters and is NOT | |
944 | +quoted. | |
945 | +So to use $SMARTD_FULLMESSAGE in a shell script you should probably | |
946 | +enclose it in double quotes. | |
947 | .\" %ENDIF NOT OS Windows | |
948 | .\" %IF OS Windows | |
949 | .IP \fBSMARTD_FULLMSGFILE\fP 4 | |
3360ee78 | 950 | @@ -1088,8 +1091,8 @@ |
089a6ff8 JD |
951 | .\" %ENDIF OS Windows |
952 | .IP \fBSMARTD_TFIRST\fP 4 | |
953 | is a text string giving the time and date at which the first problem | |
954 | -of this type was reported. This text string contains space characters | |
955 | -and no newlines, and is NOT quoted. For example: | |
956 | +of this type was reported. This text string contains space characters | |
957 | +and no newlines, and is NOT quoted. For example: | |
958 | .br | |
959 | Sun Feb 9 14:58:19 2003 CST | |
960 | .IP \fBSMARTD_TFIRSTEPOCH\fP 4 | |
3360ee78 | 961 | @@ -1097,38 +1100,38 @@ |
089a6ff8 JD |
962 | 1970) for \fBSMARTD_TFIRST\fP. |
963 | .IP \fBSMARTD_PREVCNT\fP 4 | |
964 | is an integer specifying the number of previous messages sent. | |
965 | -It is set to \'0\' for the first message. | |
966 | +It is set to \(aq0\(aq for the first message. | |
967 | .IP \fBSMARTD_NEXTDAYS\fP 4 | |
968 | is an integer specifying the number of days until the next message will be sent. | |
969 | -It it set to empty on \'\-M once\' and set to \'1\' on \'\-M daily\'. | |
970 | +It it set to empty on \(aq\-M once\(aq and set to \(aq1\(aq on \(aq\-M daily\(aq. | |
971 | .RE | |
972 | .\" The following two lines are a workaround for a man2html bug. Please leave them. | |
973 | .\" They define a non-existent option; useful because man2html can't correctly reset the margins. | |
974 | .TP | |
975 | .B \& | |
976 | -If the \'\-m ADD\' Directive is given with a normal address argument, | |
977 | +If the \(aq\-m ADD\(aq Directive is given with a normal address argument, | |
978 | then the executable pointed to by PATH will be run in a shell with | |
979 | STDIN receiving the body of the email message, and with the same | |
980 | command-line arguments: | |
981 | .nf | |
982 | -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS | |
983 | .fi | |
984 | -that would normally be provided to \'mail\'. Examples include: | |
985 | +that would normally be provided to \(aqmail\(aq. Examples include: | |
986 | .nf | |
987 | -.B -m user@home -M exec /usr/bin/mail | |
988 | -.B -m admin@work -M exec /usr/local/bin/mailto | |
989 | -.B -m root -M exec /Example_1/shell/script/below | |
990 | +.B \-m user@home \-M exec /usr/bin/mail | |
991 | +.B \-m admin@work \-M exec /usr/local/bin/mailto | |
992 | +.B \-m root \-M exec /Example_1/shell/script/below | |
993 | .fi | |
994 | ||
995 | .\" %IF OS Windows | |
996 | -[Windows only] On Windows, the syntax of the \'\fBBlat\fP\' mailer is | |
997 | +[Windows only] On Windows, the syntax of the \(aq\fBBlat\fP\(aq mailer is | |
998 | used: | |
999 | .nf | |
1000 | -- -q -subject "%SMARTD_SUBJECT%" -to %SMARTD_ADDRCSV% | |
1001 | +\- \-q \-subject "%SMARTD_SUBJECT%" \-to %SMARTD_ADDRCSV% | |
1002 | .fi | |
1003 | ||
1004 | .\" %ENDIF OS Windows | |
1005 | -If the \'\-m ADD\' Directive is given with the special address argument | |
1006 | +If the \(aq\-m ADD\(aq Directive is given with the special address argument | |
1007 | .B <nomailer> | |
1008 | then the executable pointed to by PATH is run in a shell with | |
1009 | .B no | |
3360ee78 | 1010 | @@ -1136,14 +1139,14 @@ |
089a6ff8 JD |
1011 | .B no |
1012 | command-line arguments, for example: | |
1013 | .nf | |
1014 | -.B -m <nomailer> -M exec /Example_2/shell/script/below | |
1015 | +.B \-m <nomailer> \-M exec /Example_2/shell/script/below | |
1016 | .fi | |
1017 | If the executable produces any STDERR/STDOUT output, then \fBsmartd\fP | |
1018 | assumes that something is going wrong, and a snippet of that output | |
1019 | will be copied to SYSLOG. The remainder of the output is then | |
1020 | discarded. | |
1021 | ||
1022 | -Some EXAMPLES of scripts that can be used with the \'\-M exec\' | |
1023 | +Some EXAMPLES of scripts that can be used with the \(aq\-M exec\(aq | |
1024 | Directive are given below. | |
1025 | .\" %IF NOT OS Windows | |
1026 | Some sample scripts are also included in | |
3360ee78 | 1027 | @@ -1175,7 +1178,7 @@ |
089a6ff8 JD |
1028 | are set by the script before running the executable. |
1029 | .TP | |
1030 | .B \-f | |
1031 | -[ATA only] Check for \'failure\' of any Usage Attributes. If these | |
1032 | +[ATA only] Check for \(aqfailure\(aq of any Usage Attributes. If these | |
1033 | Attributes are less than or equal to the threshold, it does NOT indicate | |
1034 | imminent disk failure. It "indicates an advisory condition where the usage | |
1035 | or age of the device has exceeded its intended design life period." | |
3360ee78 | 1036 | @@ -1183,28 +1186,28 @@ |
089a6ff8 JD |
1037 | .TP |
1038 | .B \-p | |
1039 | [ATA only] Report anytime that a Prefail Attribute has changed | |
1040 | -its value since the last check. [Please see the | |
1041 | +its value since the last check. [Please see the | |
1042 | .B smartctl \-A | |
1043 | command-line option.] | |
1044 | .TP | |
1045 | .B \-u | |
1046 | [ATA only] Report anytime that a Usage Attribute has changed its value | |
1047 | -since the last check. [Please see the | |
1048 | +since the last check. [Please see the | |
1049 | .B smartctl \-A | |
1050 | command-line option.] | |
1051 | .TP | |
1052 | .B \-t | |
1053 | -[ATA only] Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'. | |
1054 | +[ATA only] Equivalent to turning on the two previous flags \(aq\-p\(aq and \(aq\-u\(aq. | |
1055 | Tracks changes in \fIall\fP device Attributes (both Prefailure and | |
1056 | -Usage). [Please see the \fBsmartctl\fP \-A command-line option.] | |
1057 | +Usage). [Please see the \fBsmartctl\fP \-A command-line option.] | |
1058 | .TP | |
1059 | .B \-i ID | |
1060 | [ATA only] Ignore device Attribute number \fBID\fP when checking for failure | |
1061 | of Usage Attributes. \fBID\fP must be a decimal integer in the range | |
1062 | -from 1 to 255. This Directive modifies the behavior of the \'\-f\' | |
1063 | +from 1 to 255. This Directive modifies the behavior of the \(aq\-f\(aq | |
1064 | Directive and has no effect without it. | |
1065 | ||
1066 | -This is useful, for example, if you have a very old disk and don\'t | |
1067 | +This is useful, for example, if you have a very old disk and don't | |
1068 | want to keep getting messages about the hours-on-lifetime Attribute | |
1069 | (usually Attribute 9) failing. This Directive may appear multiple | |
1070 | times for a single device, if you want to ignore multiple Attributes. | |
3360ee78 | 1071 | @@ -1212,12 +1215,12 @@ |
089a6ff8 JD |
1072 | .B \-I ID |
1073 | [ATA only] Ignore device Attribute \fBID\fP when tracking changes in the | |
1074 | Attribute values. \fBID\fP must be a decimal integer in the range | |
1075 | -from 1 to 255. This Directive modifies the behavior of the \'\-p\', | |
1076 | -\'\-u\', and \'\-t\' tracking Directives and has no effect without one | |
1077 | +from 1 to 255. This Directive modifies the behavior of the \(aq\-p\(aq, | |
1078 | +\(aq\-u\(aq, and \(aq\-t\(aq tracking Directives and has no effect without one | |
1079 | of them. | |
1080 | ||
1081 | This is useful, for example, if one of the device Attributes is the disk | |
1082 | -temperature (usually Attribute 194 or 231). It\'s annoying to get reports | |
1083 | +temperature (usually Attribute 194 or 231). It's annoying to get reports | |
1084 | each time the temperature changes. This Directive may appear multiple | |
1085 | times for a single device, if you want to ignore multiple Attributes. | |
1086 | .TP | |
3360ee78 | 1087 | @@ -1225,27 +1228,27 @@ |
089a6ff8 JD |
1088 | [ATA only] When tracking, report the \fIRaw\fP value of Attribute \fBID\fP |
1089 | along with its (normally reported) \fINormalized\fP value. \fBID\fP must | |
1090 | be a decimal integer in the range from 1 to 255. This Directive modifies | |
1091 | -the behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives | |
1092 | +the behavior of the \(aq\-p\(aq, \(aq\-u\(aq, and \(aq\-t\(aq tracking Directives | |
1093 | and has no effect without one of them. This Directive may be given | |
1094 | multiple times. | |
1095 | ||
1096 | A common use of this Directive is to track the device Temperature | |
1097 | (often ID=194 or 231). | |
1098 | ||
1099 | -If the optional flag \'!\' is appended, a change of the Normalized | |
1100 | +If the optional flag \(aq!\(aq is appended, a change of the Normalized | |
1101 | value is considered critical. The report will be logged as LOG_CRIT | |
1102 | -and a warning email will be sent if \'\-m\' is specified. | |
1103 | +and a warning email will be sent if \(aq\-m\(aq is specified. | |
1104 | .TP | |
1105 | .B \-R ID[!] | |
1106 | [ATA only] When tracking, report whenever the \fIRaw\fP value of Attribute | |
1107 | \fBID\fP changes. (Normally \fBsmartd\fP only tracks/reports changes | |
1108 | of the \fINormalized\fP Attribute values.) \fBID\fP must be a decimal | |
1109 | integer in the range from 1 to 255. This Directive modifies the | |
1110 | -behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives and | |
1111 | +behavior of the \(aq\-p\(aq, \(aq\-u\(aq, and \(aq\-t\(aq tracking Directives and | |
1112 | has no effect without one of them. This Directive may be given | |
1113 | multiple times. | |
1114 | ||
1115 | -If this Directive is given, it automatically implies the \'\-r\' | |
1116 | +If this Directive is given, it automatically implies the \(aq\-r\(aq | |
1117 | Directive for the same Attribute, so that the Raw value of the | |
1118 | Attribute is reported. | |
1119 | ||
3360ee78 | 1120 | @@ -1254,10 +1257,10 @@ |
089a6ff8 JD |
1121 | different types of system behavior affects the values of certain |
1122 | Attributes. | |
1123 | ||
1124 | -If the optional flag \'!\' is appended, a change of the Raw | |
1125 | +If the optional flag \(aq!\(aq is appended, a change of the Raw | |
1126 | value is considered critical. The report will be logged as | |
1127 | -LOG_CRIT and a warning email will be sent if \'\-m\' is specified. | |
1128 | -An example is \'-R 5!\' to warn when new sectors are reallocated. | |
1129 | +LOG_CRIT and a warning email will be sent if \(aq\-m\(aq is specified. | |
1130 | +An example is \(aq\-R 5!\(aq to warn when new sectors are reallocated. | |
1131 | .TP | |
1132 | .B \-C ID[+] | |
1133 | [ATA only] Report if the current number of pending sectors is | |
3360ee78 | 1134 | @@ -1267,20 +1270,20 @@ |
089a6ff8 JD |
1135 | ID\ =\ 0. If the \fB\-C ID\fP option is not given, then it defaults to |
1136 | \fB\-C 197\fP (since Attribute 197 is generally used to monitor | |
1137 | pending sectors). If the name of this Attribute is changed by a | |
1138 | -\'\-v 197,FORMAT,NAME\' directive, the default is changed to | |
1139 | +\(aq\-v 197,FORMAT,NAME\(aq directive, the default is changed to | |
1140 | \fB\-C 0\fP. | |
1141 | ||
1142 | -If \'+\' is specified, a report is only printed if the number of sectors | |
1143 | -has increased between two check cycles. Some disks do not reset this | |
1144 | +If \(aq+\(aq is specified, a report is only printed if the number of sectors | |
1145 | +has increased between two check cycles. Some disks do not reset this | |
1146 | attribute when a bad sector is reallocated. | |
1147 | -See also \'\-v 197,increasing\' below. | |
1148 | +See also \(aq\-v 197,increasing\(aq below. | |
1149 | ||
1150 | The warning email counter is reset if the number of pending sectors | |
1151 | dropped to 0. This typically happens when all pending sectors have | |
1152 | been reallocated or could be read again. | |
1153 | ||
1154 | A pending sector is a disk sector (containing 512 bytes of your data) | |
1155 | -which the device would like to mark as ``bad" and reallocate. | |
1156 | +which the device would like to mark as "bad" and reallocate. | |
1157 | Typically this is because your computer tried to read that sector, and | |
1158 | the read failed because the data on it has been corrupted and has | |
1159 | inconsistent Error Checking and Correction (ECC) codes. This is | |
3360ee78 | 1160 | @@ -1299,13 +1302,13 @@ |
089a6ff8 JD |
1161 | ID\ =\ 0. If the \fB\-U ID\fP option is not given, then it defaults to |
1162 | \fB\-U 198\fP (since Attribute 198 is generally used to monitor | |
1163 | offline uncorrectable sectors). If the name of this Attribute is changed | |
1164 | -by a \'\-v 198,FORMAT,NAME\' (except \'\-v 198,FORMAT,Offline_Scan_UNC_SectCt\'), | |
1165 | +by a \(aq\-v 198,FORMAT,NAME\(aq (except \(aq\-v 198,FORMAT,Offline_Scan_UNC_SectCt\(aq), | |
1166 | directive, the default is changed to \fB\-U 0\fP. | |
1167 | ||
1168 | -If \'+\' is specified, a report is only printed if the number of sectors | |
1169 | -has increased since the last check cycle. Some disks do not reset this | |
1170 | +If \(aq+\(aq is specified, a report is only printed if the number of sectors | |
1171 | +has increased since the last check cycle. Some disks do not reset this | |
1172 | attribute when a bad sector is reallocated. | |
1173 | -See also \'\-v 198,increasing\' below. | |
1174 | +See also \(aq\-v 198,increasing\(aq below. | |
1175 | ||
1176 | The warning email counter is reset if the number of offline uncorrectable | |
1177 | sectors dropped to 0. This typically happens when all offline uncorrectable | |
3360ee78 | 1178 | @@ -1314,7 +1317,7 @@ |
089a6ff8 JD |
1179 | An offline uncorrectable sector is a disk sector which was not |
1180 | readable during an off-line scan or a self-test. This is important | |
1181 | to know, because if you have data stored in this disk sector, and you | |
1182 | -need to read it, the read will fail. Please see the previous \'\-C\' | |
1183 | +need to read it, the read will fail. Please see the previous \(aq\-C\(aq | |
1184 | option for more details. | |
1185 | .TP | |
1186 | .B \-W DIFF[,INFO[,CRIT]] | |
3360ee78 | 1187 | @@ -1323,21 +1326,21 @@ |
089a6ff8 JD |
1188 | Report or Warn if the temperature is greater or equal than one of |
1189 | \fBINFO\fP or \fBCRIT\fP degrees Celsius. | |
1190 | If the limit \fBCRIT\fP is reached, a message with loglevel | |
1191 | -\fB\'LOG_CRIT\'\fP will be logged to syslog and a warning email | |
1192 | -will be send if \'\-m\' is specified. If only the limit \fBINFO\fP is | |
1193 | -reached, a message with loglevel \fB\'LOG_INFO\'\fP will be logged. | |
1194 | +\fB\(aqLOG_CRIT\(aq\fP will be logged to syslog and a warning email | |
1195 | +will be send if \(aq\-m\(aq is specified. If only the limit \fBINFO\fP is | |
1196 | +reached, a message with loglevel \fB\(aqLOG_INFO\(aq\fP will be logged. | |
1197 | ||
1198 | The warning email counter is reset if the temperature dropped below | |
1199 | \fBINFO\fP or \fBCRIT\fP-5 if \fBINFO\fP is not specified. | |
1200 | ||
1201 | If this directive is used in conjunction with state persistence | |
1202 | -(\'\-s\' option), the min and max temperature values are preserved | |
1203 | -across boot cycles. The minimum temperature value is not updated | |
1204 | +(\(aq\-s\(aq option), the min and max temperature values are preserved | |
1205 | +across boot cycles. The minimum temperature value is not updated | |
1206 | during the first 30 minutes after startup. | |
1207 | ||
1208 | To disable any of the 3 reports, set the corresponding limit to 0. | |
1209 | -Trailing zero arguments may be omitted. By default, all temperature | |
1210 | -reports are disabled (\'-W 0\'). | |
1211 | +Trailing zero arguments may be omitted. By default, all temperature | |
1212 | +reports are disabled (\(aq\-W 0\(aq). | |
1213 | ||
1214 | To track temperature changes of at least 2 degrees, use: | |
1215 | .nf | |
3360ee78 | 1216 | @@ -1373,7 +1376,7 @@ |
089a6ff8 JD |
1217 | |
1218 | .I none | |
1219 | \- Assume that the device firmware obeys the ATA specifications. This | |
1220 | -is the default, unless the device has presets for \'\-F\' in the | |
1221 | +is the default, unless the device has presets for \(aq\-F\(aq in the | |
1222 | drive database. Using this directive will override any preset values. | |
1223 | ||
1224 | .I nologdir | |
3360ee78 | 1225 | @@ -1399,8 +1402,8 @@ |
089a6ff8 JD |
1226 | .I samsung3 |
1227 | \- Some Samsung disks (at least SP2514N with Firmware VF100-37) report | |
1228 | a self-test still in progress with 0% remaining when the test was already | |
1229 | -completed. If this directive is specified, \fBsmartd\fP will not skip the | |
1230 | -next scheduled self-test (see Directive \'\-s\' above) in this case. | |
1231 | +completed. If this directive is specified, \fBsmartd\fP will not skip the | |
1232 | +next scheduled self-test (see Directive \(aq\-s\(aq above) in this case. | |
1233 | ||
1234 | .I xerrorlba | |
1235 | \- This only affects \fBsmartctl\fP. | |
3360ee78 | 1236 | @@ -1411,19 +1414,19 @@ |
089a6ff8 JD |
1237 | [ATA only] Sets a vendor-specific raw value print FORMAT, an optional |
1238 | BYTEORDER and an optional NAME for Attribute ID. | |
1239 | This directive may be used multiple times. | |
1240 | -Please see \fBsmartctl -v\fP command-line option for further details. | |
1241 | +Please see \fBsmartctl \-v\fP command-line option for further details. | |
1242 | ||
1243 | The following arguments affect smartd warning output: | |
1244 | ||
1245 | .I 197,increasing | |
1246 | \- Raw Attribute number 197 (Current Pending Sector Count) is not | |
1247 | -reset if uncorrectable sectors are reallocated. This sets \'-C 197+\' | |
1248 | -if no other \'-C\' directive is specified. | |
1249 | +reset if uncorrectable sectors are reallocated. This sets \(aq\-C 197+\(aq | |
1250 | +if no other \(aq\-C\(aq directive is specified. | |
1251 | ||
1252 | .I 198,increasing | |
1253 | \- Raw Attribute number 198 (Offline Uncorrectable Sector Count) is not | |
1254 | -reset if uncorrectable sectors are reallocated. This sets \'-U 198+\' | |
1255 | -if no other \'-U\' directive is specified. | |
1256 | +reset if uncorrectable sectors are reallocated. This sets \(aq\-U 198+\(aq | |
1257 | +if no other \(aq\-U\(aq directive is specified. | |
1258 | .TP | |
1259 | .B \-P TYPE | |
1260 | [ATA only] Specifies whether \fBsmartd\fP should use any preset options | |
3360ee78 | 1261 | @@ -1447,22 +1450,22 @@ |
089a6ff8 JD |
1262 | command-line option.] |
1263 | .TP | |
1264 | .B \-a | |
1265 | -Equivalent to turning on all of the following Directives: | |
1266 | -.B \'\-H\' | |
1267 | +Equivalent to turning on all of the following Directives: | |
1268 | +.B \(aq\-H\(aq | |
1269 | to check the SMART health status, | |
1270 | -.B \'\-f\' | |
1271 | +.B \(aq\-f\(aq | |
1272 | to report failures of Usage (rather than Prefail) Attributes, | |
1273 | -.B \'\-t\' | |
1274 | +.B \(aq\-t\(aq | |
1275 | to track changes in both Prefailure and Usage Attributes, | |
1276 | -.B \'\-l\ error\' | |
1277 | +.B \(aq\-l\ error\(aq | |
1278 | to report increases in the number of ATA errors, | |
1279 | -.B \'\-l\ selftest\' | |
1280 | +.B \(aq\-l\ selftest\(aq | |
1281 | to report increases in the number of Self-Test Log errors, | |
1282 | -.B \'\-l\ selfteststs\' | |
1283 | +.B \(aq\-l\ selfteststs\(aq | |
1284 | to report changes of Self-Test execution status, | |
1285 | -.B \'\-C 197\' | |
1286 | +.B \(aq\-C 197\(aq | |
1287 | to report nonzero values of the current pending sector count, and | |
1288 | -.B \'\-U 198\' | |
1289 | +.B \(aq\-U 198\(aq | |
1290 | to report nonzero values of the offline pending sector count. | |
1291 | ||
1292 | Note that \-a is the default for ATA devices. If none of these other | |
3360ee78 | 1293 | @@ -1487,7 +1490,7 @@ |
089a6ff8 JD |
1294 | .B \-H \-l\ selftest \-l\ error \-f. |
1295 | .fi | |
1296 | If you want more frequent information, use: | |
1297 | -.B -a. | |
1298 | +.B \-a. | |
1299 | ||
1300 | .TP | |
1301 | .B ADDITIONAL DETAILS ABOUT DEVICESCAN | |
3360ee78 | 1302 | @@ -1504,16 +1507,16 @@ |
089a6ff8 JD |
1303 | which will be applied to all devices that are found in the scan. For |
1304 | example | |
1305 | .nf | |
1306 | -.B DEVICESCAN -m root@example.com | |
1307 | +.B DEVICESCAN \-m root@example.com | |
1308 | .fi | |
1309 | will scan for all devices, and then monitor them. It will send one | |
1310 | email warning per device for any problems that are found. | |
1311 | .nf | |
1312 | -.B DEVICESCAN -d ata -m root@example.com | |
1313 | +.B DEVICESCAN \-d ata \-m root@example.com | |
1314 | .fi | |
1315 | -will do the same, but restricts the scan to ATA devices only. | |
1316 | +will do the same, but restricts the scan to ATA devices only. | |
1317 | .nf | |
1318 | -.B DEVICESCAN -H -d ata -m root@example.com | |
1319 | +.B DEVICESCAN \-H \-d ata \-m root@example.com | |
1320 | .fi | |
1321 | will do the same, but only monitors the SMART health status of the | |
1322 | devices, (rather than the default \-a, which monitors all SMART | |
3360ee78 | 1323 | @@ -1526,26 +1529,26 @@ |
089a6ff8 JD |
1324 | Configuration entries for specific devices may precede the \fBDEVICESCAN\fP entry. |
1325 | For example | |
1326 | .nf | |
1327 | -.B DEFAULT -m root@example.com | |
1328 | -.B /dev/sda -s S/../.././02 | |
1329 | -.B /dev/sdc -d ignore | |
1330 | -.B DEVICESCAN -s L/../.././02 | |
1331 | +.B DEFAULT \-m root@example.com | |
1332 | +.B /dev/sda \-s S/../.././02 | |
1333 | +.B /dev/sdc \-d ignore | |
1334 | +.B DEVICESCAN \-s L/../.././02 | |
1335 | .fi | |
1336 | will scan for all devices except /dev/sda and /dev/sdc, monitor them, and run a long | |
1337 | -test between 2-3am every morning. Device /dev/sda will also be monitored, but | |
1338 | +test between 2\(en3 am every morning. Device /dev/sda will also be monitored, but | |
1339 | only a short test will be run. Device /dev/sdc will be ignored. | |
1340 | Warning emails will be sent for all monitored devices. | |
1341 | ||
1342 | .TP | |
1343 | -.B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\' | |
1344 | -These are two examples of shell scripts that can be used with the \'\-M | |
1345 | -exec PATH\' Directive described previously. The paths to these scripts | |
1346 | -and similar executables is the PATH argument to the \'\-M exec PATH\' | |
1347 | +.B EXAMPLES OF SHELL SCRIPTS FOR \(aq\-M exec\(aq | |
1348 | +These are two examples of shell scripts that can be used with the \(aq\-M | |
1349 | +exec PATH\(aq Directive described previously. The paths to these scripts | |
1350 | +and similar executables is the PATH argument to the \(aq\-M exec PATH\(aq | |
1351 | Directive. | |
1352 | ||
1353 | -Example 1: This script is for use with \'\-m ADDRESS -M exec PATH\'. It appends | |
1354 | +Example 1: This script is for use with \(aq\-m ADDRESS \-M exec PATH\(aq. It appends | |
1355 | the output of | |
1356 | -.B smartctl -a | |
1357 | +.B smartctl \-a | |
1358 | to the output of the smartd email warning message and sends it to ADDRESS. | |
1359 | ||
1360 | .nf | |
3360ee78 | 1361 | @@ -1555,16 +1558,16 @@ |
089a6ff8 JD |
1362 | # Save the email message (STDIN) to a file: |
1363 | cat > /root/msg | |
1364 | ||
1365 | -# Append the output of smartctl -a to the message: | |
1366 | -/usr/local/sbin/smartctl -a -d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg | |
1367 | - | |
1368 | +# Append the output of smartctl \-a to the message: | |
1369 | +/usr/local/sbin/smartctl \-a \-d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg | |
1370 | + | |
1371 | # Now email the message to the user at address ADD: | |
1372 | -/usr/bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg | |
1373 | +/usr/bin/mail \-s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg | |
1374 | \fP | |
1375 | .fi | |
1376 | ||
1377 | -Example 2: This script is for use with \'\-m <nomailer> \-M exec | |
1378 | -PATH\'. It warns all users about a disk problem, waits 30 seconds, and | |
1379 | +Example 2: This script is for use with \(aq\-m <nomailer> \-M exec | |
1380 | +PATH\(aq. It warns all users about a disk problem, waits 30 seconds, and | |
1381 | then powers down the machine. | |
1382 | ||
1383 | .nf | |
3360ee78 | 1384 | @@ -1582,7 +1585,7 @@ |
089a6ff8 JD |
1385 | sleep 30 |
1386 | ||
1387 | # Power down the machine | |
1388 | -/sbin/shutdown -hf now | |
1389 | +/sbin/shutdown \-hf now | |
1390 | \fP | |
1391 | .fi | |
1392 |