Ticket #656: 50_manpage_improvements.diff

File 50_manpage_improvements.diff, 66.6 KB (added by Jonathan Dowland, 8 years ago)

patch

  • smartd.conf.5.in

    Author: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
    Date: Wed, 3 Feb 2016 00:22:52 +0000
    Cc: 669053@bugs.debian.org
    Bug-Debian: http://bugs.debian.org/669053
    Description: Various manpage improvements.
    
    Enable and fix warnings from 'man' and 'groff'.
    
    Change `` to ".
    
    Split lines longer than about 80 characters into two or more
    lines.  References:
    
      1) man-pages(7) from package \"man-pages\" or
      \"www.kernel.org/doc/man-pages\" section 7 or
      \"man7.org/linux/man-pages/man7/man-pages.7.html\":
    
      New sentences should be started on new lines.
      This makes it easier to see the effect of patches,
      which often operate at the level of individual sentences.
    
    Remove space at end of lines.
    
    The space between sentences in "roff" is two spaces.
    
    Better is to begin each sentence on a new line to avoid different
    writers' conventions.
    
    Change \' (acute) to \(aq, if used as a quote.
    
    Change \' (acute) to ', if used as an apostrophe.
    
    Change - to \(en (en-dash) for a numeric range.
    
    Protect a full stop (.) with \&, if
    
      a) it can be transported to the first column, when the line is
         reformatted (split).
      b) it is the last part of an abbreviation that does not end a
         sentence.
    
    Add a (no-break, "\ ") space between a number and an unit as these
    are not one entity
    
    Change a hyphen-minus to a minus (\-), if in front of a name for an option
    
    Remove space in the first column, if not intended.
    
    diff --git a/smartd.conf.5.in b/smartd.conf.5.in
    index 21b031f..df2b6c4 100644
    a b You should have received a copy of the GNU General Public License  
    1515This code was originally developed as a Senior Thesis by Michael Cornwell
    1616at the Concurrent Systems Laboratory (now part of the Storage Systems
    1717Research Center), Jack Baskin School of Engineering, University of
    18 California, Santa Cruz. http://ssrc.soe.ucsc.edu/
     18California, Santa Cruz.  http://ssrc.soe.ucsc.edu/
    1919
    2020..
    2121.TH SMARTD.CONF 5 "CURRENT_SVN_DATE" "CURRENT_SVN_VERSION" "SMART Monitoring Tools"
    daemon.  
    3333
    3434If the configuration file \fB/usr/local/etc/smartd.conf\fP is present,
    3535\fBsmartd\fP reads it at startup, before \fBfork\fP(2)ing into the
    36 background. If \fBsmartd\fP subsequently receives a \fBHUP\fP signal,
     36background.  If \fBsmartd\fP subsequently receives a \fBHUP\fP signal,
    3737it will then re-read the configuration file.  If \fBsmartd\fP is
    3838running in debug mode, then an \fBINT\fP signal will also make it
    39 re-read the configuration file. This signal can be generated by typing
    40 \fB\<CONTROL-C\>\fP in the terminal window where \fBsmartd\fP is
     39re-read the configuration file.  This signal can be generated by typing
     40\fB<CONTROL-C>\fP in the terminal window where \fBsmartd\fP is
    4141running.
    4242
    4343In the absence of a configuration file
    4444\fBsmartd\fP will try to open all available devices
    4545(see \fBsmartd\fP(8) man page).
    46 A configuration file with a single line \fB\'DEVICESCAN \-a'\fP
     46A configuration file with a single line \fB\(aqDEVICESCAN \-a\(aq\fP
    4747would have the same effect.
    4848
    4949This can be annoying if you have an ATA or SCSI device that hangs or
    5050misbehaves when receiving SMART commands.  Even if this causes no
    5151problems, you may be annoyed by the string of error log messages about devices
    52 that can\'t be opened.
     52that can't be opened.
    5353
    5454One can avoid this problem, and gain more control over the types of
    5555events monitored by
    by using the configuration file  
    5959This file contains a list of devices to monitor, with one device per
    6060line.  An example file is included with the
    6161.B smartmontools
    62 distribution. You will find this sample configuration file in
    63 \fB/usr/local/share/doc/smartmontools/\fP. For security, the configuration file
    64 should not be writable by anyone but root. The syntax of the file is as
     62distribution.  You will find this sample configuration file in
     63\fB/usr/local/share/doc/smartmontools/\fP.  For security, the configuration file
     64should not be writable by anyone but root.  The syntax of the file is as
    6565follows:
    6666.IP \(bu 4
    6767There should be one device listed per line, although you may have
    6868lines that are entirely comments or white space.
    6969.IP \(bu 4
    70 Any text following a hash sign \'#\' and up to the end of the line is
     70Any text following a hash sign \(aq#\(aq and up to the end of the line is
    7171taken to be a comment, and ignored.
    7272.IP \(bu 4
    73 Lines may be continued by using a backslash \'\e\' as the last
     73Lines may be continued by using a backslash \(aq\e\(aq as the last
    7474non-whitespace or non-comment item on a line.
    7575.IP \(bu 4
    76 Note: a line whose first character is a hash sign \'#\' is treated as
     76Note: a line whose first character is a hash sign \(aq#\(aq is treated as
    7777a white-space blank line, \fBnot\fP as a non-existent line, and will
    7878\fBend\fP a continuation line.
    7979.PP
    8080
    81 Here is an example configuration file.  It\'s for illustrative purposes
    82 only; please don\'t copy it onto your system without reading to the end
     81Here is an example configuration file.  It's for illustrative purposes
     82only; please don't copy it onto your system without reading to the end
    8383of the
    8484.B DIRECTIVES
    8585Section below!
    Section below!  
    9292.B # On the second disk, start a long self-test every
    9393.B # Sunday between 3 and 4 am.
    9494.B #
    95 .B \ \ /dev/sda -a -m admin@example.com,root@localhost
    96 .B \ \ /dev/sdb -a -I 194 -I 5 -i 12 -s L/../../7/03
     95.B \ \ /dev/sda \-a \-m admin@example.com,root@localhost
     96.B \ \ /dev/sdb \-a \-I 194 \-I 5 \-i 12 \-s L/../../7/03
    9797.B #
    9898.B # Send a TEST warning email to admin on startup.
    9999.B #
    100 .B \ \ /dev/sdc -m admin@example.com -M test
     100.B \ \ /dev/sdc \-m admin@example.com \-M test
    101101.B #
    102 .B # Strange device.  It\'s SCSI. Start a scheduled
     102.B # Strange device.  It's SCSI. Start a scheduled
    103103.B # long self test between 5 and 6 am Monday/Thursday
    104 .B \ \ /dev/weird -d scsi -s L/../../(1|4)/05
     104.B \ \ /dev/weird \-d scsi \-s L/../../(1|4)/05
    105105.B #
    106106.B # An ATA disk may appear as a SCSI device to the
    107 .B # OS. If a SCSI to ATA Translation (SAT) layer
     107.B # OS.  If a SCSI to ATA Translation (SAT) layer
    108108.B # is between the OS and the device then this can be
    109 .B # flagged with the '-d sat' option. This situation
     109.B # flagged with the '-d sat' option.  This situation
    110110.B # may become common with SATA disks in SAS and FC
    111111.B # environments.
    112 .B \ \ /dev/sda -a -d sat
     112.B \ \ /dev/sda \-a \-d sat
    113113.B #
    114114.\" %IF OS Linux
    115115.B # Three disks connected to a MegaRAID controller
    116 .B # Start short self-tests daily between 1-2, 2-3, and
    117 .B # 3-4 am.
    118 .B \ \ /dev/sda -d megaraid,0 -a -s S/../.././01
    119 .B \ \ /dev/sda -d megaraid,1 -a -s S/../.././02
    120 .B \ \ /dev/sda -d megaraid,2 -a -s S/../.././03
    121 .B \ \ /dev/bus/0 -d megaraid,2 -a -s S/../.././03
     116.B # Start short self-tests daily between 1\(en2, 2\(en3, and
     117.B # 3\(en4 am.
     118.B \ \ /dev/sda \-d megaraid,0 \-a \-s S/../.././01
     119.B \ \ /dev/sda \-d megaraid,1 \-a \-s S/../.././02
     120.B \ \ /dev/sda \-d megaraid,2 \-a \-s S/../.././03
     121.B \ \ /dev/bus/0 \-d megaraid,2 \-a \-s S/../.././03
    122122.B #
    123123.B # Three disks connected to an AacRaid controller
    124 .B # Start short self-tests daily between 1-2, 2-3, and
    125 .B # 3-4 am.
    126 .B \ \ /dev/sda -d aacraid,0,0,66 -a -s S/../.././01
    127 .B \ \ /dev/sda -d aacraid,0,0,67 -a -s S/../.././02
    128 .B \ \ /dev/sda -d aacraid,0,0,68 -a -s S/../.././03
     124.B # Start short self-tests daily between 1\(en2, 2\(en3, and
     125.B # 3\(en4 am.
     126.B \ \ /dev/sda \-d aacraid,0,0,66 \-a \-s S/../.././01
     127.B \ \ /dev/sda \-d aacraid,0,0,67 \-a \-s S/../.././02
     128.B \ \ /dev/sda \-d aacraid,0,0,68 \-a \-s S/../.././03
    129129.B #
    130130.\" %ENDIF OS Linux
    131131.B # Four ATA disks on a 3ware 6/7/8000 controller.
    132 .B # Start short self-tests daily between midnight and 1am,
    133 .B # 1-2, 2-3, and 3-4 am.  Starting with the Linux 2.6
     132.B # Start short self-tests daily between midnight and 1 am,
     133.B # 1\(en2, 2\(en3, and 3\(en4 am.  Starting with the Linux 2.6
    134134.B # kernel series, /dev/sdX is deprecated in favor of
    135135.B # /dev/tweN.  For example replace /dev/sdc by /dev/twe0
    136136.B # and /dev/sdd by /dev/twe1.
    137 .B \ \ /dev/sdc -d 3ware,0 -a -s S/../.././00
    138 .B \ \ /dev/sdc -d 3ware,1 -a -s S/../.././01
    139 .B \ \ /dev/sdd -d 3ware,2 -a -s S/../.././02
    140 .B \ \ /dev/sdd -d 3ware,3 -a -s S/../.././03
     137.B \ \ /dev/sdc \-d 3ware,0 \-a \-s S/../.././00
     138.B \ \ /dev/sdc \-d 3ware,1 \-a \-s S/../.././01
     139.B \ \ /dev/sdd \-d 3ware,2 \-a \-s S/../.././02
     140.B \ \ /dev/sdd \-d 3ware,3 \-a \-s S/../.././03
    141141.B #
    142142.B # Two ATA disks on a 3ware 9000 controller.
    143143.B # Start long self-tests Sundays between midnight and
    144 .B # 1am and 2-3 am
    145 .B \ \ /dev/twa0 -d 3ware,0 -a -s L/../../7/00
    146 .B \ \ /dev/twa0 -d 3ware,1 -a -s L/../../7/02
     144.B # 1 am and 2\(en3 am
     145.B \ \ /dev/twa0 \-d 3ware,0 \-a \-s L/../../7/00
     146.B \ \ /dev/twa0 \-d 3ware,1 \-a \-s L/../../7/02
    147147.B #
    148148.B # Two SATA (not SAS) disks on a 3ware 9750 controller.
    149149.B # Start long self-tests Sundays between midnight and
    150 .B # 1am and 2-3 am
     150.B # 1 am and 2\(en3 am
    151151.\" %IF OS Linux
    152 .B \ \ /dev/twl0 -d 3ware,0 -a -s L/../../7/00
    153 .B \ \ /dev/twl0 -d 3ware,1 -a -s L/../../7/02
     152.B \ \ /dev/twl0 \-d 3ware,0 \-a \-s L/../../7/00
     153.B \ \ /dev/twl0 \-d 3ware,1 \-a \-s L/../../7/02
    154154.\" %ENDIF OS Linux
    155155.\" %IF OS FreeBSD
    156 .B \ \ /dev/tws0 -d 3ware,0 -a -s L/../../7/00
    157 .B \ \ /dev/tws0 -d 3ware,1 -a -s L/../../7/02
     156.B \ \ /dev/tws0 \-d 3ware,0 \-a \-s L/../../7/00
     157.B \ \ /dev/tws0 \-d 3ware,1 \-a \-s L/../../7/02
    158158.\" %ENDIF OS FreeBSD
    159159.B #
    160160.B # Three SATA disks on a HighPoint RocketRAID controller.
    161 .B # Start short self-tests daily between 1-2, 2-3, and
    162 .B # 3-4 am.
     161.B # Start short self-tests daily between 1\(en2, 2\(en3, and
     162.B # 3\(en4 am.
    163163.\" %IF OS Linux
    164164.B # under Linux
    165 .B \ \ /dev/sde -d hpt,1/1 -a -s S/../.././01
    166 .B \ \ /dev/sde -d hpt,1/2 -a -s S/../.././02
    167 .B \ \ /dev/sde -d hpt,1/3 -a -s S/../.././03
     165.B \ \ /dev/sde \-d hpt,1/1 \-a \-s S/../.././01
     166.B \ \ /dev/sde \-d hpt,1/2 \-a \-s S/../.././02
     167.B \ \ /dev/sde \-d hpt,1/3 \-a \-s S/../.././03
    168168.\" %ENDIF OS Linux
    169169.\" %IF OS FreeBSD
    170170.B # under FreeBSD
    171 .B  /dev/hptrr -d hpt,1/1 -a -s S/../.././01
    172 .B  /dev/hptrr -d hpt,1/2 -a -s S/../.././02
    173 .B  /dev/hptrr -d hpt,1/3 -a -s S/../.././03
     171.B  /dev/hptrr \-d hpt,1/1 \-a \-s S/../.././01
     172.B  /dev/hptrr \-d hpt,1/2 \-a \-s S/../.././02
     173.B  /dev/hptrr \-d hpt,1/3 \-a \-s S/../.././03
    174174.\" %ENDIF OS FreeBSD
    175175.B #
    176 .B # Two SATA disks connected to a HighPoint RocketRAID 
     176.B # Two SATA disks connected to a HighPoint RocketRAID
    177177.B # via a pmport device.  Start long self-tests Sundays
    178 .B # between midnight and 1am and 2-3 am.
     178.B # between midnight and 1 am and 2\(en3 am.
    179179.\" %IF OS Linux
    180180.B # under Linux
    181 .B \ \ /dev/sde -d hpt,1/4/1 -a -s L/../../7/00
    182 .B \ \ /dev/sde -d hpt,1/4/2 -a -s L/../../7/02
     181.B \ \ /dev/sde \-d hpt,1/4/1 \-a \-s L/../../7/00
     182.B \ \ /dev/sde \-d hpt,1/4/2 \-a \-s L/../../7/02
    183183.\" %ENDIF OS Linux
    184184.\" %IF OS FreeBSD
    185185.B # under FreeBSD
    186 .B \ \ /dev/hptrr -d hpt,1/4/1 -a -s L/../../7/00
    187 .B \ \ /dev/hptrr -d hpt,1/4/2 -a -s L/../../7/02
     186.B \ \ /dev/hptrr \-d hpt,1/4/1 \-a \-s L/../../7/00
     187.B \ \ /dev/hptrr \-d hpt,1/4/2 \-a \-s L/../../7/02
    188188.B #
    189189.\" %ENDIF OS FreeBSD
    190190.B # Three SATA disks connected to an Areca
    191 .B # RAID controller. Start long self-tests Sundays
     191.B # RAID controller.  o51Start long self-tests Sundays
    192192.B # between midnight and 3 am.
    193193.\" %IF OS Linux
    194 .B \ \ /dev/sg2 -d areca,1 -a -s L/../../7/00
    195 .B \ \ /dev/sg2 -d areca,2 -a -s L/../../7/01
    196 .B \ \ /dev/sg2 -d areca,3 -a -s L/../../7/02
     194.B \ \ /dev/sg2 \-d areca,1 \-a \-s L/../../7/00
     195.B \ \ /dev/sg2 \-d areca,2 \-a \-s L/../../7/01
     196.B \ \ /dev/sg2 \-d areca,3 \-a \-s L/../../7/02
    197197.\" %ENDIF OS Linux
    198198.\" %IF OS FreeBSD
    199 .B \ \ /dev/arcmsr0 -d areca,1 -a -s L/../../7/00
    200 .B \ \ /dev/arcmsr0 -d areca,2 -a -s L/../../7/01
    201 .B \ \ /dev/arcmsr0 -d areca,3 -a -s L/../../7/02
     199.B \ \ /dev/arcmsr0 \-d areca,1 \-a \-s L/../../7/00
     200.B \ \ /dev/arcmsr0 \-d areca,2 \-a \-s L/../../7/01
     201.B \ \ /dev/arcmsr0 \-d areca,3 \-a \-s L/../../7/02
    202202.\" %ENDIF OS FreeBSD
    203203.B #
    204 .B # The following line enables monitoring of the 
    205 .B # ATA Error Log and the Self-Test Error Log. 
     204.B # The following line enables monitoring of the
     205.B # ATA Error Log and the Self-Test Error Log.
    206206.B # It also tracks changes in both Prefailure
    207207.B # and Usage Attributes, apart from Attributes
    208208.B # 9, 194, and 231, and shows  continued lines:
    209209.B #
    210 .B \ \ /dev/sdd\ -l\ error\ \e
    211 .B \ \ \ \ \ \ \ \ \ \ \ -l\ selftest\ \e
    212 .B \ \ \ \ \ \ \ \ \ \ \ -t\ \e\ \ \ \ \ \ # Attributes not tracked:
    213 .B \ \ \ \ \ \ \ \ \ \ \ -I\ 194\ \e\ \ # temperature
    214 .B \ \ \ \ \ \ \ \ \ \ \ -I\ 231\ \e\ \ # also temperature
    215 .B \ \ \ \ \ \ \ \ \ \ \ -I 9\ \ \ \ \ \ # power-on hours
     210.B \ \ /dev/sdd\ \-l\ error\ \e
     211.B \ \ \ \ \ \ \ \ \ \ \ \-l\ selftest\ \e
     212.B \ \ \ \ \ \ \ \ \ \ \ \-t\ \e\ \ \ \ \ \ # Attributes not tracked:
     213.B \ \ \ \ \ \ \ \ \ \ \ \-I\ 194\ \e\ \ # temperature
     214.B \ \ \ \ \ \ \ \ \ \ \ \-I\ 231\ \e\ \ # also temperature
     215.B \ \ \ \ \ \ \ \ \ \ \ \-I 9\ \ \ \ \ \ # power-on hours
    216216.B #
    217217.B ################################################
    218218.fi
    as defaults for the next device entries.  
    237237This configuration:
    238238.PP
    239239.nf
    240 \ \ DEFAULT -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
     240\ \ DEFAULT \-a \-R5! \-W 2,40,45 \-I 194 \-s L/../../7/00 \-m admin@example.com
    241241\ \ /dev/sda
    242242\ \ /dev/sdb
    243243\ \ /dev/sdc
    244 \ \ DEFAULT -H -m admin@example.com
     244\ \ DEFAULT \-H \-m admin@example.com
    245245\ \ /dev/sdd
    246 \ \ /dev/sde -d removable
     246\ \ /dev/sde \-d removable
    247247.fi
    248248.PP
    249249has the same effect as:
    250250.PP
    251251.nf
    252 \ \ /dev/sda -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
    253 \ \ /dev/sdb -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
    254 \ \ /dev/sdc -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
    255 \ \ /dev/sdd -H -m admin@example.com
    256 \ \ /dev/sde -d removable -H -m admin@example.com
     252\ \ /dev/sda \-a \-R5! \-W 2,40,45 \-I 194 \-s L/../../7/00 \-m admin@example.com
     253\ \ /dev/sdb \-a \-R5! \-W 2,40,45 \-I 194 \-s L/../../7/00 \-m admin@example.com
     254\ \ /dev/sdc \-a \-R5! \-W 2,40,45 \-I 194 \-s L/../../7/00 \-m admin@example.com
     255\ \ /dev/sdd \-H \-m admin@example.com
     256\ \ /dev/sde \-d removable \-H \-m admin@example.com
    257257.fi
    258258
    259259
    or  
    264264.B DEFAULT
    265265on any line of the
    266266.B /usr/local/etc/smartd.conf
    267 configuration file. Note that
    268 .B these are NOT command-line options for 
     267configuration file.  Note that
     268.B these are NOT command-line options for
    269269\fBsmartd\fP.
    270270The Directives below may appear in any order, following the device
    271 name. 
     271name.
    272272
    273273.B For an ATA device,
    274274if no Directives appear, then the device will be monitored
    275 as if the \'\-a\' Directive (monitor all SMART properties) had been given.
     275as if the \(aq\-a\(aq Directive (monitor all SMART properties) had been given.
    276276
    277277.B If a SCSI disk is listed,
    278278it will be monitored at the maximum implemented level: roughly
    279 equivalent to using the \'\-H \-l selftest\' options for an ATA disk.
    280 So with the exception of \'\-d\', \'\-m\', \'\-l selftest\', \'\-s\', and
    281 \'\-M\', the Directives below are ignored for SCSI disks.  For SCSI
    282 disks, the \'\-m\' Directive sends a warning email if the SMART status
     279equivalent to using the \(aq\-H \-l selftest\(aq options for an ATA disk.
     280So with the exception of \(aq\-d\(aq, \(aq\-m\(aq, \(aq\-l selftest\(aq, \(aq\-s\(aq, and
     281\(aq\-M\(aq, the Directives below are ignored for SCSI disks.  For SCSI
     282disks, the \(aq\-m\(aq Directive sends a warning email if the SMART status
    283283indicates a disk failure or problem, if the SCSI inquiry about disk
    284284status fails, or if new errors appear in the self-test log.
    285285
    286286.B If a 3ware controller is used
    287287then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?,
    288 /dev/twa?, /dev/twl? or /dev/tws?) must be listed, along with the \'\-d 3ware,N\'
     288/dev/twa?, /dev/twl? or /dev/tws?) must be listed, along with the \(aq\-d 3ware,N\(aq
    289289Directive (see below).  The individual ATA disks hosted by the 3ware
    290290controller appear to \fBsmartd\fP as normal ATA devices.  Hence all
    291291the ATA directives can be used for these disks (but see note below).
    292292
    293293.\" %IF OS Linux FreeBSD
    294294.B If an Areca controller is used
    295 then the corresponding device (SCSI /dev/sg? on Linux or /dev/arcmsr0 on 
    296 FreeBSD) must be listed, along with the \'\-d areca,N\' Directive (see below).
     295then the corresponding device (SCSI /dev/sg? on Linux or /dev/arcmsr0 on
     296FreeBSD) must be listed, along with the \(aq\-d areca,N\(aq Directive (see below).
    297297The individual SATA disks hosted by the Areca controller appear to \fBsmartd\fP
    298298as normal ATA devices.  Hence all the ATA directives can be used for
    299299these disks.  Areca firmware version 1.46 or later which supports
    This is for ATA disks that have a SCSI to ATA Translation (SAT) Layer  
    328328(SATL) between the disk and the operating system.
    329329SAT defines two ATA PASS THROUGH SCSI commands, one 12 bytes long and
    330330the other 16 bytes long.  The default is the 16 byte variant which can be
    331 overridden with either \'\-d sat,12\' or \'\-d sat,16\'.
     331overridden with either \(aq\-d sat,12\(aq or \(aq\-d sat,16\(aq.
    332332
    333 If \'\-d sat,auto\' is specified, device type SAT (for ATA/SATA disks) is
     333If \(aq\-d sat,auto\(aq is specified, device type SAT (for ATA/SATA disks) is
    334334only used if the SCSI INQUIRY data reports a SATL (VENDOR: "ATA     ").
    335335Otherwise device type SCSI (for SCSI/SAS disks) is used.
    336336
    Otherwise device type SCSI (for SCSI/SAS disks) is used.  
    338338\- this device type is for ATA disks that are behind a Cypress USB to PATA
    339339bridge.  This will use the ATACB proprietary scsi pass through command.
    340340The default SCSI operation code is 0x24, but although it can be overridden
    341 with \'\-d usbcypress,0xN\', where N is the scsi operation code,
     341with \(aq\-d usbcypress,0xN\(aq, where N is the scsi operation code,
    342342you're running the risk of damage to the device or filesystems on it.
    343343
    344344.I usbjmicron[,p][,x][,PORT]
    345345\- this device type is for SATA disks that are behind a JMicron USB to
    346 PATA/SATA bridge.  The 48-bit ATA commands (required e.g. for \'\-l xerror\',
     346PATA/SATA bridge.  The 48-bit ATA commands (required e.g.\& for \(aq\-l xerror\(aq,
    347347see below) do not work with all of these bridges and are therefore disabled by
    348 default.  These commands can be enabled by \'\-d usbjmicron,x\'.
     348default.  These commands can be enabled by \(aq\-d usbjmicron,x\(aq.
    349349If two disks are connected to a bridge with two ports, an error message is printed
    350350if no PORT is specified.
    351 The port can be specified by \'\-d usbjmicron[,x],PORT\' where PORT is 0
     351The port can be specified by \(aq\-d usbjmicron[,x],PORT\(aq where PORT is 0
    352352(master) or 1 (slave).  This is not necessary if the device uses a port
    353353multiplier to connect multiple disks to one port.  The disks appear under
    354354separate /dev/ice names then.
    355 CAUTION: Specifying \',x\' for a device which does not support it results
     355CAUTION: Specifying \(aq,x\(aq for a device which does not support it results
    356356in I/O errors and may disconnect the drive.  The same applies if the specified
    357357PORT does not exist or is not connected to a disk.
    358358
    359359The Prolific PL2507/3507 USB bridges with older firmware support a pass-through
    360 command similar to JMicron and work with \'\-d usbjmicron,0\'.
     360command similar to JMicron and work with \(aq\-d usbjmicron,0\(aq.
    361361Newer Prolific firmware requires a modified command which can be selected by
    362 \'\-d usbjmicron,p\'.
     362\(aq\-d usbjmicron,p\(aq.
    363363Note that this does not yet support the SMART status command.
    364364
    365365.I usbprolific
    to a MegaRAID controller. The non-negative integer N (in the range of 0 to  
    384384This interface will also work for Dell PERC controllers.
    385385In log files and email messages this disk will be identified as
    386386megaraid_disk_XXX with XXX in the range from 000 to 127 inclusive.
    387 It is possible to set RAID device name as /dev/bus/N, where N is a SCSI bus 
     387It is possible to set RAID device name as /dev/bus/N, where N is a SCSI bus
    388388number.
    389389Please see the \fBsmartctl\fP(8) man page for further details.
    390390
    Please see the \fBsmartctl\fP(8) man page for further details.  
    420420\- [FreeBSD, Linux, Windows and Cygwin only] the device consists of one or more SATA disks
    421421connected to an Areca SATA RAID controller.  The positive integer N (in the range
    422422from 1 to 24 inclusive) denotes which disk on the controller is monitored.
    423 In log files and email messages this disk will be identifed as
     423In log files and email messages this disk will be identified as
    424424areca_disk_XX with XX in the range from 01 to 24 inclusive.
    425425Please see the \fBsmartctl\fP(8) man page for further details.
    426426
    Please see the \fBsmartctl\fP(8) man page for further details.  
    460460This allows to ignore specific devices which are detected by a following
    461461DEVICESCAN configuration line.
    462462It may also be used to temporary disable longer multi-line configuration entries.
    463 This Directive may be used in conjunction with the other \'\-d\' Directives.
     463This Directive may be used in conjunction with the other \(aq\-d\(aq Directives.
    464464
    465465.I removable
    466466\- the device or its media is removable.  This indicates to
    This Directive may be used in conjunction with the other \'\-d\' Directives.  
    468468that it should continue (instead of exiting, which is the default
    469469behavior) if the device does not appear to be present when
    470470\fBsmartd\fP is started.  This Directive may be used in conjunction
    471 with the other \'\-d\' Directives.
     471with the other \(aq\-d\(aq Directives.
    472472.TP
    473473.B \-n POWERMODE[,N][,q]
    474 [ATA only] This \'nocheck\' Directive is used to prevent a disk from
     474[ATA only] This \(aqnocheck\(aq Directive is used to prevent a disk from
    475475being spun-up when it is periodically polled by \fBsmartd\fP.
    476476
    477 ATA disks have five different power states. In order of increasing
    478 power consumption they are: \'OFF\', \'SLEEP\', \'STANDBY\', \'IDLE\',
    479 and \'ACTIVE\'.  Typically in the OFF, SLEEP, and STANDBY modes the
    480 disk\'s platters are not spinning. But usually, in response to SMART
     477ATA disks have five different power states.  In order of increasing
     478power consumption they are: \(aqOFF\(aq, \(aqSLEEP\(aq, \(aqSTANDBY\(aq, \(aqIDLE\(aq,
     479and \(aqACTIVE\(aq.  Typically in the OFF, SLEEP, and STANDBY modes the
     480disk's platters are not spinning. But usually, in response to SMART
    481481commands issued by \fBsmartd\fP, the disk platters are spun up.  So if
    482482this option is not used, then a disk which is in a low-power mode may
    483483be spun up and put into a higher-power mode when it is periodically
    polled by \fBsmartd\fP.  
    485485
    486486Note that if the disk is in SLEEP mode when \fBsmartd\fP is started,
    487487then it won't respond to \fBsmartd\fP commands, and so the disk won't
    488 be registered as a device for \fBsmartd\fP to monitor. If a disk is in
     488be registered as a device for \fBsmartd\fP to monitor.  If a disk is in
    489489any other low-power mode, then the commands issued by \fBsmartd\fP to
    490490register the disk will probably cause it to spin-up.
    491491
    492 The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s
     492The \(aq\fB\-n\fP\(aq (nocheck) Directive specifies if \fBsmartd\fP's
    493493periodic checks should still be carried out when the device is in a
    494494low-power mode.  It may be used to prevent a disk from being spun-up
    495495by periodic \fBsmartd\fP polling.  The allowed values of POWERMODE
    are:  
    497497
    498498.I never
    499499\- \fBsmartd\fP will poll (check) the device regardless of its power
    500 mode. This may cause a disk which is spun-down to be spun-up when
     500mode.  This may cause a disk which is spun-down to be spun-up when
    501501\fBsmartd\fP checks it.  This is the default behavior if the '\-n'
    502502Directive is not given.
    503503
    In the IDLE state, most disks are still spinning, so this is probably  
    516516not what you want.
    517517
    518518Maximum number of skipped checks (in a row) can be specified by
    519 appending positive number \',N\' to POWERMODE (like \'\-n standby,15\').
     519appending positive number \(aq,N\(aq to POWERMODE (like \(aq\-n standby,15\(aq).
    520520After N checks are skipped in a row, powermode is ignored and the
    521521check is performed anyway.
    522522
    523523When a periodic test is skipped, \fBsmartd\fP normally writes an
    524 informal log message. The message can be suppressed by appending
    525 the option \',q\' to POWERMODE (like \'\-n standby,q\').
     524informal log message.  The message can be suppressed by appending
     525the option \(aq,q\(aq to POWERMODE (like \(aq\-n standby,q\(aq).
    526526This prevents a laptop disk from spinning up due to this message.
    527527
    528 Both \',N\' and \',q\' can be specified together.
     528Both \(aq,N\(aq and \(aq,q\(aq can be specified together.
    529529.TP
    530530.B \-T TYPE
    531531Specifies how tolerant
    Directive are \fIon\fP and \fIoff\fP. Also affects SCSI devices.  
    570570STATUS command.
    571571If this command reports a failing health status, then disk
    572572failure is predicted in less than 24 hours, and a message at loglevel
    573 .B \'LOG_CRIT\'
     573.B \(aqLOG_CRIT\(aq
    574574will be logged to syslog.  [Please see the
    575575.B smartctl \-H
    576576command-line option.]
    error log has increased since the last check.  
    587587\- [ATA only] report if the number of ATA errors reported in the Extended
    588588Comprehensive SMART error log has increased since the last check.
    589589
    590 If both \'\-l error\' and \'\-l xerror\' are specified, smartd checks
     590If both \(aq\-l error\(aq and \(aq\-l xerror\(aq are specified, smartd checks
    591591the maximum of both values.
    592592
    593593[Please see the \fBsmartctl \-l xerror\fP command-line option.]
    Self-Test Log has increased since the last check, or if the timestamp  
    598598associated with the most recent failed test has increased.  Note that
    599599such errors will \fBonly\fP be logged if you run self-tests on the
    600600disk (and it fails a test!).  Self-Tests can be run automatically by
    601 \fBsmartd\fP: please see the \fB\'\-s\'\fP Directive below.
    602 Self-Tests can also be run manually by using the \fB\'\-t\ short\'\fP
    603 and \fB\'\-t\ long\'\fP options of \fBsmartctl\fP and the results of
    604 the testing can be observed using the \fBsmartctl \'\-l\ selftest\'\fP
     601\fBsmartd\fP: please see the \fB\(aq\-s\(aq\fP Directive below.
     602Self-Tests can also be run manually by using the \fB\(aq\-t\ short\(aq\fP
     603and \fB\(aq\-t\ long\(aq\fP options of \fBsmartctl\fP and the results of
     604the testing can be observed using the \fBsmartctl \(aq\-l\ selftest\(aq\fP
    605605command-line option.
    606606[Please see the \fBsmartctl \-l\fP and \fB\-t\fP command-line
    607607options.]
    an extended self-test is run after all bad sectors have been reallocated.  
    615615\- [ATA only] report if the Offline Data Collection status has changed
    616616since the last check.  The report will be logged as LOG_CRIT if the new
    617617status indicates an error.  With some drives the status often changes,
    618 therefore \'\-l offlinests\' is not enabled by '\-a\' Directive.
     618therefore \(aq\-l offlinests\(aq is not enabled by \(aq\-a\(aq Directive.
    619619.\" %IF NOT OS Cygwin Windows
    620 .\"! Appending \',ns\' (no standby) to this directive is not implemented
     620.\"! Appending ',ns' (no standby) to this directive is not implemented
    621621.\"! on OS_MAN_FILTER.
    622622.\" %ENDIF NOT OS Cygwin Windows
    623623.\" %IF OS Cygwin Windows
    624624
    625 [Windows and Cygwin only] If \',ns\' (no standby) is appended to this
     625[Windows and Cygwin only] If \(aq,ns\(aq (no standby) is appended to this
    626626directive, smartd disables system auto standby as long as an Offline
    627 Data Collection is in progress. See \'\-l selfteststs,ns\' below.
     627Data Collection is in progress.  See \(aq\-l selfteststs,ns\(aq below.
    628628.\" %ENDIF OS Cygwin Windows
    629629
    630630.I selfteststs[,ns]
    Data Collection is in progress. See \'\-l selfteststs,ns\' below.  
    632632since the last check.  The report will be logged as LOG_CRIT if the new
    633633status indicates an error.
    634634.\" %IF NOT OS Cygwin Windows
    635 .\"! Appending \',ns\' (no standby) to this directive is not implemented
     635.\"! Appending ',ns' (no standby) to this directive is not implemented
    636636.\"! on OS_MAN_FILTER.
    637637.\" %ENDIF NOT OS Cygwin Windows
    638638.\" %IF OS Cygwin Windows
    639639
    640 [Windows and Cygwin only] If \',ns\' (no standby) is appended to this
     640[Windows and Cygwin only] If \(aq,ns\(aq (no standby) is appended to this
    641641directive, smartd disables system auto standby as long as a Self-Test
    642642is in progress.  This prevents that a Self-Test is aborted because the
    643643OS sets the system to a standby/sleep mode when idle.  Smartd check
    644 interval (\'\-i\' option) should be shorter than the configured idle
     644interval (\(aq\-i\(aq option) should be shorter than the configured idle
    645645timeout.  Auto standby is not disabled if the system is running on
    646646battery.
    647647.\" %ENDIF OS Cygwin Windows
    IDLE mode.  
    683683Run Self-Tests or Offline Immediate Tests, at scheduled times.  A
    684684Self- or Offline Immediate Test will be run at the end of periodic
    685685device polling, if all 12 characters of the string \fBT/MM/DD/d/HH\fP
    686 match the extended regular expression \fBREGEXP\fP. Here:
     686match the extended regular expression \fBREGEXP\fP.  Here:
    687687.RS 7
    688688.IP \fBT\fP 4
    689689is the type of the test.  The values that \fBsmartd\fP will try to
    690 match (in turn) are: \'L\' for a \fBL\fPong Self-Test, \'S\' for a
    691 \fBS\fPhort Self-Test, \'C\' for a \fBC\fPonveyance Self-Test (ATA
    692 only), and \'O\' for an \fBO\fPffline Immediate Test (ATA only).  As
     690match (in turn) are: \(aqL\(aq for a \fBL\fPong Self-Test, \(aqS\(aq for a
     691\fBS\fPhort Self-Test, \(aqC\(aq for a \fBC\fPonveyance Self-Test (ATA
     692only), and \(aqO\(aq for an \fBO\fPffline Immediate Test (ATA only).  As
    693693soon as a match is found, the test will be started and no additional
    694694matches will be sought for that device and that polling cycle.
    695695
    696 To run scheduled Selective Self-Tests, use \'n\' for \fBn\fPext span,
    697 \'r\' to \fBr\fPedo last span, or \'c\' to \fBc\fPontinue with next span
     696To run scheduled Selective Self-Tests, use \(aqn\(aq for \fBn\fPext span,
     697\(aqr\(aq to \fBr\fPedo last span, or \(aqc\(aq to \fBc\fPontinue with next span
    698698or redo last span based on status of last test.
    699699The LBA range is based on the first span from the last test.
    700700See the \fBsmartctl \-t select,[next|redo|cont]\fP options for
    701701further info.
    702702
    703 Some disks (e.g. WD) do not preserve the selective self test log accross
    704 power cycles.  If state persistence (\'\-s\' option) is enabled, the last
     703Some disks (e.g.\& WD) do not preserve the selective self test log across
     704power cycles.  If state persistence (\(aq\-s\(aq option) is enabled, the last
    705705test span is preserved by smartd and used if (and only if) the selective
    706706self test log is empty.
    707707.IP \fBMM\fP 4
    is the month of the year, expressed with two decimal digits. The  
    709709range is from 01 (January) to 12 (December) inclusive.  Do \fBnot\fP
    710710use a single decimal digit or the match will always fail!
    711711.IP \fBDD\fP 4
    712 is the day of the month, expressed with two decimal digits. The
     712is the day of the month, expressed with two decimal digits.  The
    713713range is from 01 to 31 inclusive.  Do \fBnot\fP
    714714use a single decimal digit or the match will always fail!
    715715.IP \fBd\fP 4
    is the day of the week, expressed with one decimal digit. The  
    717717range is from 1 (Monday) to 7 (Sunday) inclusive.
    718718.IP \fBHH\fP 4
    719719is the hour of the day, written with two decimal digits, and given in
    720 hours after midnight.  The range is 00 (midnight to just before 1am)
     720hours after midnight.  The range is 00 (midnight to just before 1 am)
    721721to 23 (11pm to just before midnight) inclusive.  Do \fBnot\fP use a
    722722single decimal digit or the match will always fail!
    723723.RE
    single decimal digit or the match will always fail!  
    726726.TP
    727727.B \&
    728728Some examples follow.  In reading these, keep in mind that in extended
    729 regular expressions a dot \fB\'.\'\fP matches any single character, and
    730 a parenthetical expression such as \fB\'(A|B|C)\'\fP denotes any one of the three possibilities \fBA\fP,
    731 \fBB\fP, or \fBC\fP.
     729regular expressions a dot \fB\(aq.\(aq\fP matches any single character, and
     730a parenthetical expression such as \fB\(aq(A|B|C)\(aq\fP denotes any one
     731of the three possibilities \fBA\fP, \fBB\fP, or \fBC\fP.
    732732
    733 To schedule a short Self-Test between 2-3am every morning, use:
     733To schedule a short Self-Test between 2\(en3 am every morning, use:
    734734.nf
    735735\fB \-s S/../.././02\fP
    736736.fi
    737 To schedule a long Self-Test between 4-5am every Sunday morning, use:
     737To schedule a long Self-Test between 4\(en5 am every Sunday morning, use:
    738738.nf
    739739\fB \-s L/../../7/04\fP
    740740.fi
    741 To schedule a long Self-Test between 10-11pm on the first and
     741To schedule a long Self-Test between 10\(en11 pm on the first and
    742742fifteenth day of each month, use:
    743743.nf
    744744\fB \-s L/../(01|15)/./22\fP
    745745.fi
    746 To schedule an Offline Immediate test after every midnight, 6am,
    747 noon,and 6pm, plus a Short Self-Test daily at 1-2am and a Long
    748 Self-Test every Saturday at 3-4am, use:
     746To schedule an Offline Immediate test after every midnight, 6 am,
     747noon, and 6 pm, plus a Short Self-Test daily at 1\(en2 am and a Long
     748Self-Test every Saturday at 3\(en4 am, use:
    749749.nf
    750750\fB \-s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03)\fP
    751751.fi
    752752If Long Self-Tests of a large disks take longer than the system uptime,
    753753a full disk test can be performed by several Selective Self-Tests.
    754 To setup a full test of a 1TB disk within 20 days (one 50GB span
     754To setup a full test of a 1 TB disk within 20 days (one 50 GB span
    755755each day), run this command once:
    756756.nf
    757   smartctl -t select,0-99999999 /dev/sda
     757  smartctl \-t select,0-99999999 /dev/sda
    758758.fi
    759 To run the next test spans on Monday-Friday between 12-13am, run smartd
     759To run the next test spans on Monday\(enFriday between 12\(en13 am, run smartd
    760760with this directive:
    761761.nf
    762762\fB \-s n/../../[1-5]/12\fP
    Scheduled tests are run immediately following the regularly-scheduled  
    767767device polling, if the current local date, time, and test type, match
    768768\fBREGEXP\fP.  By default the regularly-scheduled device polling
    769769occurs every thirty minutes after starting \fBsmartd\fP.  Take caution
    770 if you use the \'\-i\' option to make this polling interval more than
     770if you use the \(aq\-i\(aq option to make this polling interval more than
    771771sixty minutes: the poll times may fail to coincide with any of the
    772772testing times that you have specified with \fBREGEXP\fP.  In this case
    773773the test will be run following the next device polling.
    test was already started or run in the same hour.  
    782782
    783783To avoid performance problems during system boot, \fBsmartd\fP will
    784784not attempt to run any scheduled tests following the very first
    785 device polling (unless \'\-q onecheck\' is specified).
     785device polling (unless \(aq\-q onecheck\(aq is specified).
    786786
    787787Each time a test is run, \fBsmartd\fP will log an entry to SYSLOG.
    788788You can use these or the '-q showtests' command-line option to verify
    if multiple test types are all scheduled for the same hour, the  
    792792longer test type has precedence.  This is usually the desired behavior.
    793793
    794794If the scheduled tests are used in conjunction with state persistence
    795 (\'\-s\' option), smartd will also try to match the hours since last
    796 shutdown (or 90 days at most). If any test would have been started
     795(\(aq\-s\(aq option), smartd will also try to match the hours since last
     796shutdown (or 90 days at most).  If any test would have been started
    797797during downtime, the longest (see above) of these tests is run after
    798798second device polling.
    799799
    800 If the \'\-n\' directive is used and any test would have been started
     800If the \(aq\-n\(aq directive is used and any test would have been started
    801801during disk standby time, the longest of these tests is run when the
    802802disk is active again.
    803803
    in \fBREGEXP\fP that appear to indicate that you have made this  
    809809mistake.
    810810.TP
    811811.B \-m ADD
    812 Send a warning email to the email address \fBADD\fP if the \'\-H\',
    813 \'\-l\', \'\-f\', \'\-C\', or \'\-O\' Directives detect a failure or a
    814 new error, or if a SMART command to the disk fails. This Directive
     812Send a warning email to the email address \fBADD\fP if the \(aq\-H\(aq,
     813\(aq\-l\(aq, \(aq\-f\(aq, \(aq\-C\(aq, or \(aq\-O\(aq Directives detect a failure or a
     814new error, or if a SMART command to the disk fails.  This Directive
    815815only works in conjunction with these other Directives (or with the
    816 equivalent default \'\-a\' Directive).
     816equivalent default \(aq\-a\(aq Directive).
    817817
    818818To prevent your email in-box from getting filled up with warning
    819819messages, by default only a single warning will be sent for each of
    820 the enabled alert types, \'\-H\', \'\-l\', \'\-f\', \'\-C\', or
    821 \'\-O\' even if more than one failure or error is detected or if the
     820the enabled alert types, \(aq\-H\(aq, \(aq\-l\(aq, \(aq\-f\(aq, \(aq\-C\(aq, or
     821\(aq\-O\(aq even if more than one failure or error is detected or if the
    822822failure or error persists.  [This behavior can be modified; see the
    823 \'\-M\' Directive below.]
     823\(aq\-M\(aq Directive below.]
    824824
    825825To send email to more than one user, please use the following "comma
    826826separated" form for the address: \fBuser1@add1,user2@add2,...,userN@addN\fP
    827827(with no spaces).
    828828
    829 To test that email is being sent correctly, use the \'\-M test\'
     829To test that email is being sent correctly, use the \(aq\-M test\(aq
    830830Directive described below to send one test email message on
    831831\fBsmartd\fP
    832832startup.
    executable must be in the path of the shell or environment from which  
    837837\fBsmartd\fP
    838838was started.  If you wish to specify an explicit path to the mail
    839839executable (for example /usr/local/bin/mail) or a custom script to
    840 run, please use the \'\-M exec\' Directive below.
     840run, please use the \(aq\-M exec\(aq Directive below.
    841841
    842842.\" %IF OS Windows
    843 On Windows, the \'\fBBlat\fP\' mailer
     843On Windows, the \(aq\fBBlat\fP\(aq mailer
    844844(\fBhttp://blat.sourceforge.net/\fP) is used by default.
    845845This mailer uses a different command line syntax, see
    846 \'\-M exec\' below.
     846\(aq\-M exec\(aq below.
    847847
    848848.\" %ENDIF OS Windows
    849849Note also that there is a special argument
    850850.B <nomailer>
    851 which can be given to the \'\-m\' Directive in conjunction with the \'\-M
    852 exec\' Directive. Please see below for an explanation of its effect.
     851which can be given to the \(aq\-m\(aq Directive in conjunction with the \(aq\-M
     852exec\(aq Directive. Please see below for an explanation of its effect.
    853853
    854854If the mailer or the shell running it produces any STDERR/STDOUT
    855855output, then a snippet of that output will be copied to SYSLOG.  The
    856 remainder of the output is discarded. If problems are encountered in
     856remainder of the output is discarded.  If problems are encountered in
    857857sending mail, this should help you to understand and fix them.  If
    858858you have mail problems, we recommend running \fBsmartd\fP in debug
    859 mode with the \'-d\' flag, using the \'-M test\' Directive described
     859mode with the \(aq\-d\(aq flag, using the \(aq\-M test\(aq Directive described
    860860below.
    861861.\" %IF ENABLE_SMARTDPLUGINDIR
    862862.\" %IF NOT OS Windows
    863863
    864 If a word of the comma separated list has the form \'@plugin\', a custom
     864If a word of the comma separated list has the form \(aq@plugin\(aq, a custom
    865865script /usr/local/etc/smartd_warning.d/plugin is run and the word is
    866 removed from the list before sending mail. The string \'plugin\' may be any
    867 valid name except \'ALL\'.
    868 If \'@ALL\' is specified, all scripts in /usr/local/etc/smartd_warning.d/*
     866removed from the list before sending mail.  The string \(aqplugin\(aq may be any
     867valid name except \(aqALL\(aq.
     868If \(aq@ALL\(aq is specified, all scripts in /usr/local/etc/smartd_warning.d/*
    869869are run instead.
    870870This is handled by the script /usr/local/etc/smartd_warning.sh
    871 (see also \'\-M exec\' below).
     871(see also \(aq\-M exec\(aq below).
    872872.\" %ENDIF NOT OS Windows
    873873.\" %ENDIF ENABLE_SMARTDPLUGINDIR
    874874.\" %IF OS Windows
    This is handled by the script /usr/local/etc/smartd_warning.sh  
    876876[Windows only] If one of the following words are used as the first address
    877877in the comma separated list, warning messages are sent via WTSSendMessage().
    878878This displays message boxes on the desktops of the selected sessions.
    879 Address \'\fBconsole\fP\' specifies the console session only,
    880 \'\fBactive\fP\' specifies the console session and all active remote
    881 sessions, and \'\fBconnected\fP\' specifies the console session and
     879Address \(aq\fBconsole\fP\(aq specifies the console session only,
     880\(aq\fBactive\fP\(aq specifies the console session and all active remote
     881sessions, and \(aq\fBconnected\fP\(aq specifies the console session and
    882882all connected (active or waiting for login) remote sessions.
    883883This is handled by the script EXEDIR/smartd_warning.cmd which runs
    884 the tool EXEDIR/wtssendmsg.exe (see also \'\-M exec\' below).
    885 The addresses \'\fBmsgbox\fP\' and \'\fBsysmsgbox\fP\' are now
    886 deprecated and have the same effect as \'\fBconsole\fP\'.
     884the tool EXEDIR/wtssendmsg.exe (see also \(aq\-M exec\(aq below).
     885The addresses \(aq\fBmsgbox\fP\(aq and \(aq\fBsysmsgbox\fP\(aq are now
     886deprecated and have the same effect as \(aq\fBconsole\fP\(aq.
    887887.\" %ENDIF OS Windows
    888888.TP
    889889.B \-M TYPE
    890890These Directives modify the behavior of the
    891891\fBsmartd\fP
    892 email warnings enabled with the \'\-m\' email Directive described above.
    893 These \'\-M\' Directives only work in conjunction with the \'\-m\'
     892email warnings enabled with the \(aq\-m\(aq email Directive described above.
     893These \(aq\-M\(aq Directives only work in conjunction with the \(aq\-m\(aq
    894894Directive and can not be used without it.
    895895
    896896Multiple \-M Directives may be given.  If more than one of the
    three):  
    902902
    903903.I once
    904904\- send only one warning email for each type of disk problem detected.  This
    905 is the default unless state persistence (\'\-s\' option) is enabled.
     905is the default unless state persistence (\(aq\-s\(aq option) is enabled.
    906906
    907907.I daily
    908908\- send additional warning reminder emails, once per day, for each type
    909909of disk problem detected.  This is the default if state persistence
    910 (\'\-s\' option) is enabled.
     910(\(aq\-s\(aq option) is enabled.
    911911
    912912.I diminishing
    913913\- send additional warning reminder emails, after a one-day interval,
    914914then a two-day interval, then a four-day interval, and so on for each
    915 type of disk problem detected. Each interval is twice as long as the
     915type of disk problem detected.  Each interval is twice as long as the
    916916previous interval.
    917917
    918918If a disk problem is no longer detected, the internal email counter is
    immediately upon  
    927927startup.  This allows one to verify that email is delivered correctly.
    928928Note that if this Directive is used,
    929929\fBsmartd\fP
    930 will also send the normal email warnings that were enabled with the \'\-m\' Directive,
     930will also send the normal email warnings that were enabled with the \(aq\-m\(aq Directive,
    931931in addition to the single test email!
    932932
    933933.I exec PATH
    Then it must be included in double quotes.  
    944944By setting PATH to point to a customized script, you can make
    945945\fBsmartd\fP perform useful tricks when a disk problem is detected
    946946(beeping the console, shutting down the machine, broadcasting warnings
    947 to all logged-in users, etc.)  But please be careful. \fBsmartd\fP
     947to all logged-in users, etc.\&)  But please be careful. \fBsmartd\fP
    948948will \fBblock\fP until the executable PATH returns, so if your
    949949executable hangs, then \fBsmartd\fP will also hang.
    950950.\" %IF NOT OS Windows
    Some sample scripts are included in  
    953953.\" %ENDIF NOT OS Windows
    954954
    955955The return status of the executable is recorded by \fBsmartd\fP in
    956 SYSLOG. The executable is not expected to write to STDOUT or
     956SYSLOG.  The executable is not expected to write to STDOUT or
    957957STDERR.  If it does, then this is interpreted as indicating that
    958958something is going wrong with your executable, and a fragment of this
    959959output is logged to SYSLOG to help you to understand the problem.
    should send mail or write to a file or device.  
    962962
    963963Before running the executable, \fBsmartd\fP sets a number of
    964964environment variables.  These environment variables may be used to
    965 control the executable\'s behavior.  The environment variables
     965control the executable's behavior.  The environment variables
    966966exported by \fBsmartd\fP are:
    967967.RS 7
    968968.IP \fBSMARTD_MAILER\fP 4
    969 is set to the argument of \-M exec, if present or else to \'mail\'
     969is set to the argument of \-M exec, if present or else to \(aqmail\(aq
    970970(examples: /usr/local/bin/mail, mail).
    971971.IP \fBSMARTD_DEVICE\fP 4
    972972is set to the device path (example: /dev/sda).
    973973.IP \fBSMARTD_DEVICETYPE\fP 4
    974 is set to the device type specified by \'-d\' directive or
    975 \'auto\' if none.
     974is set to the device type specified by \(aq\-d\(aq directive or
     975\(aqauto\(aq if none.
    976976.IP \fBSMARTD_DEVICESTRING\fP 4
    977977is set to the device description.  For SMARTD_DEVICETYPE of ata or
    978978scsi, this is the same as SMARTD_DEVICE.  For 3ware RAID controllers,
    979 the form used is \'/dev/sdc [3ware_disk_01]\'.  For HighPoint
    980 RocketRAID controller, the form is \'/dev/sdd [hpt_1/1/1]\' under Linux
    981 or \'/dev/hptrr [hpt_1/1/1]\' under FreeBSD.  For Areca controllers, the
    982 form is \'/dev/sg2 [areca_disk_09]\' on Linux or  \'/dev/arcmsr0 [areca_disk_09]\' on FreeBSD.  In these cases the device string
    983 contains a space and is NOT quoted.  So to use $SMARTD_DEVICESTRING in a
     979the form used is \(aq/dev/sdc [3ware_disk_01]\(aq.  For HighPoint
     980RocketRAID controller, the form is \(aq/dev/sdd [hpt_1/1/1]\(aq under Linux
     981or \(aq/dev/hptrr [hpt_1/1/1]\(aq under FreeBSD.  For Areca controllers,
     982the form is \(aq/dev/sg2 [areca_disk_09]\(aq on Linux or  \(aq/dev/arcmsr0
     983[areca_disk_09]\(aq on FreeBSD.
     984In these cases the device string contains a space and is NOT quoted.
     985So to use $SMARTD_DEVICESTRING in a
    984986shell script you should probably enclose it in double quotes.
    985987.IP \fBSMARTD_DEVICEINFO\fP 4
    986988is set to device identify information.  It includes most of the info printed
    one or more disk sectors could not be read.  
    10191021.br
    10201022\fIFailedOpenDevice\fP: the open() command to the device failed.
    10211023.IP \fBSMARTD_ADDRESS\fP 4
    1022 is determined by the address argument ADD of the \'\-m\' Directive.
     1024is determined by the address argument ADD of the \(aq\-m\(aq Directive.
    10231025If ADD is \fB<nomailer>\fP, then \fBSMARTD_ADDRESS\fP is not set.
    10241026Otherwise, it is set to the comma-separated-list of email addresses
    10251027given by the argument ADD, with the commas replaced by spaces
    SMARTD_ADDRESS.  
    10341036.\" %ENDIF OS Windows
    10351037.IP \fBSMARTD_MESSAGE\fP 4
    10361038is set to the one sentence summary warning email message string from
    1037 \fBsmartd\fP. 
    1038 This message string contains space characters and is NOT quoted. So to
     1039\fBsmartd\fP.m46
     1040This message string contains space characters and is NOT quoted.  So to
    10391041use $SMARTD_MESSAGE in a shell script you should probably enclose it in
    10401042double quotes.
    10411043.\" %IF NOT OS Windows
    10421044.IP \fBSMARTD_FULLMESSAGE\fP 4
    10431045is set to the contents of the entire email warning message string from
    1044 \fBsmartd\fP.
    1045 This message string contains space and return characters and is NOT quoted. So to
    1046 use $SMARTD_FULLMESSAGE in a shell script you should probably enclose it in
    1047 double quotes.
     1046\fBsmartd\fP.
     1047This message string contains space and return characters and is NOT
     1048quoted.
     1049So to use $SMARTD_FULLMESSAGE in a shell script you should probably
     1050enclose it in double quotes.
    10481051.\" %ENDIF NOT OS Windows
    10491052.\" %IF OS Windows
    10501053.IP \fBSMARTD_FULLMSGFILE\fP 4
    the mailer or command exits.  
    10551058.\" %ENDIF OS Windows
    10561059.IP \fBSMARTD_TFIRST\fP 4
    10571060is a text string giving the time and date at which the first problem
    1058 of this type was reported. This text string contains space characters
    1059 and no newlines, and is NOT quoted. For example:
     1061of this type was reported.  This text string contains space characters
     1062and no newlines, and is NOT quoted.  For example:
    10601063.br
    10611064Sun Feb  9 14:58:19 2003 CST
    10621065.IP \fBSMARTD_TFIRSTEPOCH\fP 4
    is an integer, which is the unix epoch (number of seconds since Jan 1,  
    106410671970) for \fBSMARTD_TFIRST\fP.
    10651068.IP \fBSMARTD_PREVCNT\fP 4
    10661069is an integer specifying the number of previous messages sent.
    1067 It is set to \'0\' for the first message.
     1070It is set to \(aq0\(aq for the first message.
    10681071.IP \fBSMARTD_NEXTDAYS\fP 4
    10691072is an integer specifying the number of days until the next message will be sent.
    1070 It it set to empty on \'\-M once\' and set to \'1\' on \'\-M daily\'.
     1073It it set to empty on \(aq\-M once\(aq and set to \(aq1\(aq on \(aq\-M daily\(aq.
    10711074.RE
    10721075.\"  The following two lines are a workaround for a man2html bug.  Please leave them.
    10731076.\" They define a non-existent option; useful because man2html can't correctly reset the margins.
    10741077.TP
    10751078.B \&
    1076 If the \'\-m ADD\' Directive is given with a normal address argument,
     1079If the \(aq\-m ADD\(aq Directive is given with a normal address argument,
    10771080then the executable pointed to by PATH will be run in a shell with
    10781081STDIN receiving the body of the email message, and with the same
    10791082command-line arguments:
    10801083.nf
    10811084-s "$SMARTD_SUBJECT" $SMARTD_ADDRESS
    10821085.fi
    1083 that would normally be provided to \'mail\'.  Examples include:
     1086that would normally be provided to \(aqmail\(aq.  Examples include:
    10841087.nf
    1085 .B -m user@home -M exec /usr/bin/mail
    1086 .B -m admin@work -M exec /usr/local/bin/mailto
    1087 .B -m root -M exec /Example_1/shell/script/below
     1088.B \-m user@home \-M exec /usr/bin/mail
     1089.B \-m admin@work \-M exec /usr/local/bin/mailto
     1090.B \-m root \-M exec /Example_1/shell/script/below
    10881091.fi
    10891092
    10901093.\" %IF OS Windows
    1091 [Windows only] On Windows, the syntax of the \'\fBBlat\fP\' mailer is
     1094[Windows only] On Windows, the syntax of the \(aq\fBBlat\fP\(aq mailer is
    10921095used:
    10931096.nf
    1094 - -q -subject "%SMARTD_SUBJECT%" -to %SMARTD_ADDRCSV%
     1097\- \-q \-subject "%SMARTD_SUBJECT%" \-to %SMARTD_ADDRCSV%
    10951098.fi
    10961099
    10971100.\" %ENDIF OS Windows
    1098 If the \'\-m ADD\' Directive is given with the special address argument
     1101If the \(aq\-m ADD\(aq Directive is given with the special address argument
    10991102.B <nomailer>
    11001103then the executable pointed to by PATH is run in a shell with
    11011104.B no
    STDIN and  
    11031106.B no
    11041107command-line arguments, for example:
    11051108.nf
    1106 .B -m <nomailer> -M exec /Example_2/shell/script/below
     1109.B \-m <nomailer> \-M exec /Example_2/shell/script/below
    11071110.fi
    11081111If the executable produces any STDERR/STDOUT output, then \fBsmartd\fP
    11091112assumes that something is going wrong, and a snippet of that output
    11101113will be copied to SYSLOG.  The remainder of the output is then
    11111114discarded.
    11121115
    1113 Some EXAMPLES of scripts that can be used with the \'\-M exec\'
     1116Some EXAMPLES of scripts that can be used with the \(aq\-M exec\(aq
    11141117Directive are given below.
    11151118.\" %IF NOT OS Windows
    11161119Some sample scripts are also included in
    SMARTD_SUBJECT and SMARTD_FULLMESSAGE  
    11421145are set by the script before running the executable.
    11431146.TP
    11441147.B \-f
    1145 [ATA only] Check for \'failure\' of any Usage Attributes.  If these
     1148[ATA only] Check for \(aqfailure\(aq of any Usage Attributes.  If these
    11461149Attributes are less than or equal to the threshold, it does NOT indicate
    11471150imminent disk failure.  It "indicates an advisory condition where the usage
    11481151or age of the device has exceeded its intended design life period."
    or age of the device has exceeded its intended design life period."  
    11501153.TP
    11511154.B \-p
    11521155[ATA only] Report anytime that a Prefail Attribute has changed
    1153 its value since the last check. [Please see the
     1156its value since the last check.  [Please see the
    11541157.B smartctl \-A
    11551158command-line option.]
    11561159.TP
    11571160.B \-u
    11581161[ATA only] Report anytime that a Usage Attribute has changed its value
    1159 since the last check. [Please see the
     1162since the last check.  [Please see the
    11601163.B smartctl \-A
    11611164command-line option.]
    11621165.TP
    11631166.B \-t
    1164 [ATA only] Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'.
     1167[ATA only] Equivalent to turning on the two previous flags \(aq\-p\(aq and \(aq\-u\(aq.
    11651168Tracks changes in \fIall\fP device Attributes (both Prefailure and
    1166 Usage). [Please see the \fBsmartctl\fP \-A command-line option.]
     1169Usage).  [Please see the \fBsmartctl\fP \-A command-line option.]
    11671170.TP
    11681171.B \-i ID
    11691172[ATA only] Ignore device Attribute number \fBID\fP when checking for failure
    11701173of Usage Attributes.  \fBID\fP must be a decimal integer in the range
    1171 from 1 to 255.  This Directive modifies the behavior of the \'\-f\'
     1174from 1 to 255.  This Directive modifies the behavior of the \(aq\-f\(aq
    11721175Directive and has no effect without it.
    11731176
    1174 This is useful, for example, if you have a very old disk and don\'t
     1177This is useful, for example, if you have a very old disk and don't
    11751178want to keep getting messages about the hours-on-lifetime Attribute
    11761179(usually Attribute 9) failing.  This Directive may appear multiple
    11771180times for a single device, if you want to ignore multiple Attributes.
    times for a single device, if you want to ignore multiple Attributes.  
    11791182.B \-I ID
    11801183[ATA only] Ignore device Attribute \fBID\fP when tracking changes in the
    11811184Attribute values.  \fBID\fP must be a decimal integer in the range
    1182 from 1 to 255.  This Directive modifies the behavior of the \'\-p\',
    1183 \'\-u\', and \'\-t\' tracking Directives and has no effect without one
     1185from 1 to 255.  This Directive modifies the behavior of the \(aq\-p\(aq,
     1186\(aq\-u\(aq, and \(aq\-t\(aq tracking Directives and has no effect without one
    11841187of them.
    11851188
    11861189This is useful, for example, if one of the device Attributes is the disk
    1187 temperature (usually Attribute 194 or 231). It\'s annoying to get reports
     1190temperature (usually Attribute 194 or 231).  It's annoying to get reports
    11881191each time the temperature changes.  This Directive may appear multiple
    11891192times for a single device, if you want to ignore multiple Attributes.
    11901193.TP
    times for a single device, if you want to ignore multiple Attributes.  
    11921195[ATA only] When tracking, report the \fIRaw\fP value of Attribute \fBID\fP
    11931196along with its (normally reported) \fINormalized\fP value.  \fBID\fP must
    11941197be a decimal integer in the range from 1 to 255.  This Directive modifies
    1195 the behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives
     1198the behavior of the \(aq\-p\(aq, \(aq\-u\(aq, and \(aq\-t\(aq tracking Directives
    11961199and has no effect without one of them.  This Directive may be given
    11971200multiple times.
    11981201
    11991202A common use of this Directive is to track the device Temperature
    12001203(often ID=194 or 231).
    12011204
    1202 If the optional flag \'!\' is appended, a change of the Normalized
     1205If the optional flag \(aq!\(aq is appended, a change of the Normalized
    12031206value is considered critical.  The report will be logged as LOG_CRIT
    1204 and a warning email will be sent if \'\-m\' is specified.
     1207and a warning email will be sent if \(aq\-m\(aq is specified.
    12051208.TP
    12061209.B \-R ID[!]
    12071210[ATA only] When tracking, report whenever the \fIRaw\fP value of Attribute
    12081211\fBID\fP changes.  (Normally \fBsmartd\fP only tracks/reports changes
    12091212of the \fINormalized\fP Attribute values.)  \fBID\fP must be a decimal
    12101213integer in the range from 1 to 255.  This Directive modifies the
    1211 behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives and
     1214behavior of the \(aq\-p\(aq, \(aq\-u\(aq, and \(aq\-t\(aq tracking Directives and
    12121215has no effect without one of them.  This Directive may be given
    12131216multiple times.
    12141217
    1215 If this Directive is given, it automatically implies the \'\-r\'
     1218If this Directive is given, it automatically implies the \(aq\-r\(aq
    12161219Directive for the same Attribute, so that the Raw value of the
    12171220Attribute is reported.
    12181221
    A common use of this Directive is to track the device Temperature  
    12211224different types of system behavior affects the values of certain
    12221225Attributes.
    12231226
    1224 If the optional flag \'!\' is appended, a change of the Raw
     1227If the optional flag \(aq!\(aq is appended, a change of the Raw
    12251228value is considered critical.  The report will be logged as
    1226 LOG_CRIT and a warning email will be sent if \'\-m\' is specified.
    1227 An example is \'-R 5!\' to warn when new sectors are reallocated.
     1229LOG_CRIT and a warning email will be sent if \(aq\-m\(aq is specified.
     1230An example is \(aq\-R 5!\(aq to warn when new sectors are reallocated.
    12281231.TP
    12291232.B \-C ID[+]
    12301233[ATA only] Report if the current number of pending sectors is
    value is the Current Pending Sector count. The allowed range of  
    12341237ID\ =\ 0.  If the \fB\-C ID\fP option is not given, then it defaults to
    12351238\fB\-C 197\fP (since Attribute 197 is generally used to monitor
    12361239pending sectors).  If the name of this Attribute is changed by a
    1237 \'\-v 197,FORMAT,NAME\' directive, the default is changed to
     1240\(aq\-v 197,FORMAT,NAME\(aq directive, the default is changed to
    12381241\fB\-C 0\fP.
    12391242
    1240 If \'+\' is specified, a report is only printed if the number of sectors
    1241 has increased between two check cycles. Some disks do not reset this
     1243If \(aq+\(aq is specified, a report is only printed if the number of sectors
     1244has increased between two check cycles.  Some disks do not reset this
    12421245attribute when a bad sector is reallocated.
    1243 See also \'\-v 197,increasing\' below.
     1246See also \(aq\-v 197,increasing\(aq below.
    12441247
    12451248The warning email counter is reset if the number of pending sectors
    12461249dropped to 0.  This typically happens when all pending sectors have
    12471250been reallocated or could be read again.
    12481251
    12491252A pending sector is a disk sector (containing 512 bytes of your data)
    1250 which the device would like to mark as ``bad" and reallocate.
     1253which the device would like to mark as "bad" and reallocate.
    12511254Typically this is because your computer tried to read that sector, and
    12521255the read failed because the data on it has been corrupted and has
    12531256inconsistent Error Checking and Correction (ECC) codes.  This is
    value is the Offline Uncorrectable Sector count. The allowed range of  
    12661269ID\ =\ 0.  If the \fB\-U ID\fP option is not given, then it defaults to
    12671270\fB\-U 198\fP (since Attribute 198 is generally used to monitor
    12681271offline uncorrectable sectors).  If the name of this Attribute is changed
    1269 by a \'\-v 198,FORMAT,NAME\' (except \'\-v 198,FORMAT,Offline_Scan_UNC_SectCt\'),
     1272by a \(aq\-v 198,FORMAT,NAME\(aq (except \(aq\-v 198,FORMAT,Offline_Scan_UNC_SectCt\(aq),
    12701273directive, the default is changed to \fB\-U 0\fP.
    12711274
    1272 If \'+\' is specified, a report is only printed if the number of sectors
    1273 has increased since the last check cycle. Some disks do not reset this
     1275If \(aq+\(aq is specified, a report is only printed if the number of sectors
     1276has increased since the last check cycle.  Some disks do not reset this
    12741277attribute when a bad sector is reallocated.
    1275 See also \'\-v 198,increasing\' below.
     1278See also \(aq\-v 198,increasing\(aq below.
    12761279
    12771280The warning email counter is reset if the number of offline uncorrectable
    12781281sectors dropped to 0.  This typically happens when all offline uncorrectable
    sectors have been reallocated or could be read again.  
    12811284An offline uncorrectable sector is a disk sector which was not
    12821285readable during an off-line scan or a self-test.  This is important
    12831286to know, because if you have data stored in this disk sector, and you
    1284 need to read it, the read will fail.  Please see the previous \'\-C\'
     1287need to read it, the read will fail.  Please see the previous \(aq\-C\(aq
    12851288option for more details.
    12861289.TP
    12871290.B \-W DIFF[,INFO[,CRIT]]
    degrees since last report, or if new min or max temperature is detected.  
    12901293Report or Warn if the temperature is greater or equal than one of
    12911294\fBINFO\fP or \fBCRIT\fP degrees Celsius.
    12921295If the limit \fBCRIT\fP is reached, a message with loglevel
    1293 \fB\'LOG_CRIT\'\fP will be logged to syslog and a warning email
    1294 will be send if \'\-m\' is specified. If only the limit \fBINFO\fP is
    1295 reached, a message with loglevel \fB\'LOG_INFO\'\fP will be logged.
     1296\fB\(aqLOG_CRIT\(aq\fP will be logged to syslog and a warning email
     1297will be send if \(aq\-m\(aq is specified. If only the limit \fBINFO\fP is
     1298reached, a message with loglevel \fB\(aqLOG_INFO\(aq\fP will be logged.
    12961299
    12971300The warning email counter is reset if the temperature dropped below
    12981301\fBINFO\fP or \fBCRIT\fP-5 if \fBINFO\fP is not specified.
    12991302
    13001303If this directive is used in conjunction with state persistence
    1301 (\'\-s\' option), the min and max temperature values are preserved
    1302 across boot cycles. The minimum temperature value is not updated
     1304(\(aq\-s\(aq option), the min and max temperature values are preserved
     1305across boot cycles.  The minimum temperature value is not updated
    13031306during the first 30 minutes after startup.
    13041307
    13051308To disable any of the 3 reports, set the corresponding limit to 0.
    1306 Trailing zero arguments may be omitted. By default, all temperature
    1307 reports are disabled (\'-W 0\').
     1309Trailing zero arguments may be omitted.  By default, all temperature
     1310reports are disabled (\(aq\-W 0\(aq).
    13081311
    13091312To track temperature changes of at least 2 degrees, use:
    13101313.nf
    To combine all of the above reports, use:  
    13241327.fi
    13251328
    13261329For ATA devices, smartd interprets Attribute 194 or 190 as Temperature Celsius
    1327 by default. This can be changed to Attribute 9 or 220 by the drive
    1328 database or by the \'\-v 9,temp\' or \'\-v 220,temp\' directive.
     1330by default.  This can be changed to Attribute 9 or 220 by the drive
     1331database or by the \(aq\-v 9,temp\(aq or \(aq\-v 220,temp\(aq directive.
    13291332.TP
    13301333.B \-F TYPE
    13311334[ATA only] Modifies the behavior of \fBsmartd\fP to compensate for some
    multiple times. The valid arguments are:  
    13341337
    13351338.I none
    13361339\- Assume that the device firmware obeys the ATA specifications.  This
    1337 is the default, unless the device has presets for \'\-F\' in the
     1340is the default, unless the device has presets for \(aq\-F\(aq in the
    13381341drive database.  Using this directive will override any preset values.
    13391342
    13401343.I nologdir
    byte-reversed order.  
    13601363.I samsung3
    13611364\- Some Samsung disks (at least SP2514N with Firmware VF100-37) report
    13621365a self-test still in progress with 0% remaining when the test was already
    1363 completed. If this directive is specified, \fBsmartd\fP will not skip the
    1364 next scheduled self-test (see Directive \'\-s\' above) in this case.
     1366completed.  If this directive is specified, \fBsmartd\fP will not skip the
     1367next scheduled self-test (see Directive \(aq\-s\(aq above) in this case.
    13651368
    13661369.I xerrorlba
    13671370\- This only affects \fBsmartctl\fP.
    next scheduled self-test (see Directive \'\-s\' above) in this case.  
    13721375[ATA only] Sets a vendor-specific raw value print FORMAT, an optional
    13731376BYTEORDER and an optional NAME for Attribute ID.
    13741377This directive may be used multiple times.
    1375 Please see \fBsmartctl -v\fP command-line option for further details.
     1378Please see \fBsmartctl \-v\fP command-line option for further details.
    13761379
    13771380The following arguments affect smartd warning output:
    13781381
    13791382.I 197,increasing
    13801383\- Raw Attribute number 197 (Current Pending Sector Count) is not
    1381 reset if uncorrectable sectors are reallocated.  This sets \'-C 197+\'
    1382 if no other \'-C\' directive is specified.
     1384reset if uncorrectable sectors are reallocated.  This sets \(aq\-C 197+\(aq
     1385if no other \(aq\-C\(aq directive is specified.
    13831386
    13841387.I 198,increasing
    13851388\- Raw Attribute number 198 (Offline Uncorrectable Sector Count) is not
    1386 reset if uncorrectable sectors are reallocated.  This sets \'-U 198+\'
    1387 if no other \'-U\' directive is specified.
     1389reset if uncorrectable sectors are reallocated.  This sets \(aq\-U 198+\(aq
     1390if no other \(aq\-U\(aq directive is specified.
    13881391.TP
    13891392.B \-P TYPE
    13901393[ATA only] Specifies whether \fBsmartd\fP should use any preset options
    The valid arguments to this Directive are:  
    14081411command-line option.]
    14091412.TP
    14101413.B \-a
    1411 Equivalent to turning on all of the following Directives: 
    1412 .B \'\-H\'
     1414Equivalent to turning on all of the following Directives:
     1415.B \(aq\-H\(aq
    14131416to check the SMART health status,
    1414 .B \'\-f\'
     1417.B \(aq\-f\(aq
    14151418to report failures of Usage (rather than Prefail) Attributes,
    1416 .B \'\-t\'
     1419.B \(aq\-t\(aq
    14171420to track changes in both Prefailure and Usage Attributes,
    1418 .B \'\-l\ error\'
     1421.B \(aq\-l\ error\(aq
    14191422to report increases in the number of ATA errors,
    1420 .B \'\-l\ selftest\'
     1423.B \(aq\-l\ selftest\(aq
    14211424to report increases in the number of Self-Test Log errors,
    1422 .B \'\-l\ selfteststs\'
     1425.B \(aq\-l\ selfteststs\(aq
    14231426to report changes of Self-Test execution status,
    1424 .B \'\-C 197\'
     1427.B \(aq\-C 197\(aq
    14251428to report nonzero values of the current pending sector count, and
    1426 .B \'\-U 198\'
     1429.B \(aq\-U 198\(aq
    14271430to report nonzero values of the offline pending sector count.
    14281431
    14291432Note that \-a is the default for ATA devices.  If none of these other
    configuration file Directives might be:  
    14481451.B \-H \-l\ selftest \-l\ error \-f.
    14491452.fi
    14501453If you want more frequent information, use:
    1451 .B -a.
     1454.B \-a.
    14521455
    14531456.TP
    14541457.B ADDITIONAL DETAILS ABOUT DEVICESCAN
    SMART properties of any devices that are found.  
    14651468which will be applied to all devices that are found in the scan.  For
    14661469example
    14671470.nf
    1468 .B DEVICESCAN -m root@example.com
     1471.B DEVICESCAN \-m root@example.com
    14691472.fi
    14701473will scan for all devices, and then monitor them.  It will send one
    14711474email warning per device for any problems that are found.
    14721475.nf
    1473 .B  DEVICESCAN -d ata -m root@example.com
     1476.B  DEVICESCAN \-d ata \-m root@example.com
    14741477.fi
    1475 will do the same, but restricts the scan to ATA devices only. 
     1478will do the same, but restricts the scan to ATA devices only.
    14761479.nf
    1477 .B  DEVICESCAN -H -d ata -m root@example.com
     1480.B  DEVICESCAN \-H \-d ata \-m root@example.com
    14781481.fi
    14791482will do the same, but only monitors the SMART health status of the
    14801483devices, (rather than the default \-a, which monitors all SMART
    properties).  
    14831486Configuration entries for specific devices may precede the \fBDEVICESCAN\fP entry.
    14841487For example
    14851488.nf
    1486 .B  DEFAULT -m root@example.com
    1487 .B  /dev/sda -s S/../.././02
    1488 .B  /dev/sdc -d ignore
    1489 .B  DEVICESCAN -s L/../.././02
     1489.B  DEFAULT \-m root@example.com
     1490.B  /dev/sda \-s S/../.././02
     1491.B  /dev/sdc \-d ignore
     1492.B  DEVICESCAN \-s L/../.././02
    14901493.fi
    14911494will scan for all devices except /dev/sda and /dev/sdc, monitor them, and run a long
    1492 test between 2-3am every morning.  Device /dev/sda will also be monitored, but
     1495test between 2\(en3 am every morning.  Device /dev/sda will also be monitored, but
    14931496only a short test will be run.  Device /dev/sdc will be ignored.
    14941497Warning emails will be sent for all monitored devices.
    14951498
    14961499.TP
    1497 .B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\'
    1498 These are two examples of shell scripts that can be used with the \'\-M
    1499 exec PATH\' Directive described previously.  The paths to these scripts
    1500 and similar executables is the PATH argument to the \'\-M exec PATH\'
     1500.B EXAMPLES OF SHELL SCRIPTS FOR \(aq\-M exec\(aq
     1501These are two examples of shell scripts that can be used with the \(aq\-M
     1502exec PATH\(aq Directive described previously.  The paths to these scripts
     1503and similar executables is the PATH argument to the \(aq\-M exec PATH\(aq
    15011504Directive.
    15021505
    1503 Example 1: This script is for use with \'\-m ADDRESS -M exec PATH\'.  It appends
     1506Example 1: This script is for use with \(aq\-m ADDRESS \-M exec PATH\(aq.  It appends
    15041507the output of
    1505 .B smartctl -a
     1508.B smartctl \-a
    15061509to the output of the smartd email warning message and sends it to ADDRESS.
    15071510
    15081511.nf
    to the output of the smartd email warning message and sends it to ADDRESS.  
    15121515# Save the email message (STDIN) to a file:
    15131516cat > /root/msg
    15141517
    1515 # Append the output of smartctl -a to the message:
    1516 /usr/local/sbin/smartctl -a -d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg
    1517  
     1518# Append the output of smartctl \-a to the message:
     1519/usr/local/sbin/smartctl \-a \-d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg
     1520
    15181521# Now email the message to the user at address ADD:
    1519 /usr/bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg
     1522/usr/bin/mail \-s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg
    15201523\fP
    15211524.fi
    15221525
    1523 Example 2: This script is for use with \'\-m <nomailer> \-M exec
    1524 PATH\'. It warns all users about a disk problem, waits 30 seconds, and
     1526Example 2: This script is for use with \(aq\-m <nomailer> \-M exec
     1527PATH\(aq. It warns all users about a disk problem, waits 30 seconds, and
    15251528then powers down the machine.
    15261529
    15271530.nf
    EOF  
    15391542sleep 30
    15401543
    15411544# Power down the machine
    1542 /sbin/shutdown -hf now
     1545/sbin/shutdown \-hf now
    15431546\fP
    15441547.fi
    15451548