INSTALL

   1 Smartmontools installation instructions
   2 =======================================
   3
   4 $Id: INSTALL,v 1.71 2006/11/03 20:01:32 chrfranke Exp $
   5
   6 Please also see the smartmontools home page:
   7 http://smartmontools.sourceforge.net/
   8
   9 Table of contents:
  10
  11 [1] System requirements
  12 [2] Installing from CVS
  13 [3] Installing from source tarball
  14 [4] Guidelines for different Linux distributions
  15 [5] Guidelines for FreeBSD
  16 [6] Guidelines for Darwin
  17 [7] Guidelines for NetBSD
  18 [8] Guidelines for Solaris
  19 [9] Guidelines for Cygwin
  20 [10] Guidelines for Windows
  21 [11] Guidelines for OS/2, eComStation
  22 [12] Guidelines for OpenBSD
  23 [13] Comments
  24 [14] Detailed description of ./configure options
  25
  26 [1] System requirements
  27 =======================
  28
  29     A) Linux
  30
  31     Any Linux distribution will support smartmontools if it has a
  32     kernel version greater than or equal to 2.2.14. So any recent
  33     Linux distribution should support smartmontools.
  34
  35     There are two parts of smartmontools that may require a patched or
  36     nonstandard kernel:
  37
  38     (1) To get the ATA RETURN SMART STATUS command, the kernel needs
  39     to support the HDIO_DRIVE_TASK ioctl().
  40
  41     (2) To run Selective Self-tests, the kernel needs to support the
  42     HDIO_DRIVE_TASKFILE ioctl().
  43
  44     If your kernel does not support one or both of these ioctls, then
  45     smartmontools will "mostly" work.  The things that don't work will
  46     give you harmless warning messages.
  47
  48     Although "not officially supported" by the developers, smartmontools
  49     has also been successfully build and run on a legacy Linux system
  50     with kernel 2.0.33 and libc.so.5. On such systems, the restrictions
  51     above apply.
  52
  53     For item (1) above, any 2.4 or 2.6 series kernel will provide
  54     HDIO_DRIVE_TASK support.  Some 2.2.20 and later kernels also
  55     provide this support IF they're properly patched and
  56     configured. [Andre Hedrick's IDE patches may be found at
  57     http://www.funet.fi/pub/linux/kernel/people/hedrick/ide-2.2.20/ or
  58     are available from your local kernel.org mirror.  They are not
  59     updated for 2.2.21 or later, and may contain a few bugs.].
  60     If the configuration option CONFIG_IDE_TASK_IOCTL
  61     exists in your 2.2.X kernel source code tree, then your 2.2.X
  62     kernel will probably support this ioctl. [Note that this kernel
  63     configuration option does NOT need to be enabled. Its presence
  64     merely indicates that the required HDIO_DRIVE_TASK ioctl() is
  65     supported.]
  66
  67     For item (2) above, your kernel must be configured with the kernel
  68     configuration option CONFIG_IDE_TASKFILE_IO enabled.  This
  69     configuration option is present in all 2.4 and 2.6 series
  70     kernels. Some 2.2.20 and later kernels also provide this support
  71     IF they're properly patched and configured as described above.
  72
  73     Please see FAQ section of the URL above for additional details.
  74
  75     If you are using 3ware controllers, for full functionality you
  76     must either use version 1.02.00.037 or greater of the 3w-xxxx
  77     driver, or patch earlier 3ware 3w-xxxx drivers.  See
  78     http://smartmontools.sourceforge.net/3w-xxxx.txt
  79     for the patch.  The version 1.02.00.037 3w-xxxx.c driver was
  80     incorporated into kernel 2.4.23-bk2 on 3 December 2003 and into
  81     kernel 2.6.0-test5-bk11 on 23 September 2003.
  82
  83     B) FreeBSD
  84
  85     For FreeBSD support, a 5-current kernel that includes ATAng is
  86     required in order to support ATA drives.  Even current versions of
  87     ATAng will not support 100% operation, as the SMART status can not
  88     be reliably retrieved.  There is patch pending approval of the
  89     ATAng driver maintainer that will address this issue.
  90
  91     C) Solaris
  92
  93     The SCSI code has been tested on a variety of Solaris 8 and 9
  94     systems.  ATA/IDE code only works on SPARC platform.  All tested
  95     kernels worked correctly.
  96
  97     D) NetBSD/OpenBSD
  98
  99     The code was tested on a 1.6ZG (i.e., 1.6-current) system. It should
 100     also function under 1.6.1 and later releases (unverified).  Currently
 101     it doesn't support ATA devices on 3ware RAID controllers.
 102
 103     E) Cygwin
 104
 105     The code was tested on Cygwin 1.5.7, 1.5.11 and 1.5.18-21. It should
 106     also work on other recent releases.
 107
 108     Release 1.5.15 or later is recommended for Cygwin smartd. Older versions
 109     do not provide syslogd support.
 110
 111     Both Cygwin and Windows versions of smartmontools share the same code
 112     to access the IDE/ATA or SCSI devices. The information in the "Windows"
 113     section below also applies to the Cygwin version.
 114
 115     F) Windows
 116
 117     The code was tested on Windows 98SE, NT4(SP5,SP6), 2000(SP4),
 118     XP(no SP,SP1a,SP2) and Vista RC 1. It should also work on Windows
 119     95(OSR2), 98, ME and 2003.
 120
 121     On 9x/ME, only standard (legacy) IDE/ATA devices 0-3 are supported.
 122     The driver SMARTVSD.VXD must be present in WINDOWS\SYSTEM\IOSUBSYS
 123     to get loaded at Windows startup. The default location in a new
 124     installation of some versions of Windows is the WINDOWS\SYSTEM folder.
 125     In this case, move SMARTVSD.VXD to WINDOWS\SYSTEM\IOSUBSYS and reboot
 126     (http://support.microsoft.com/kb/265854/en-us).
 127     SMARTVSD.VXD may also be missing in a new installation
 128     (http://support.microsoft.com/kb/199886/en-us).
 129
 130     SMARTVSD.VXD relies on the standard IDE port driver ESDI_506.PDR.
 131     If the system uses a vendor specific driver, access of SMART data
 132     is not possible on 9x/ME. This is the case if e.g. the optional
 133     "IDE miniport driver" is installed on a system with VIA chipset.
 134
 135     Some ATA controllers (e.g. Promise) provided a custom SMARTVSD.VXD
 136     for their Win9x/ME driver. To access SMART data from both the legacy
 137     (/dev/h[a-d]) and this additional (/dev/hd[e-h]) controller, rename
 138     this file to SMARTVSE.VXD. Open the file with a hex editor and replace
 139     all occurrences of the string "SMARTVSD" with "SMARTVSE". Then reinstall
 140     the original Windows SMARTVSD.VXD.
 141
 142     On NT4/2000/XP/2003, ATA or SATA devices are supported if the device
 143     driver implements the SMART IOCTL.
 144
 145     The IDE/ATA read log command (smartctl -l, --log, -a, --all) is
 146     not supported by the SMART IOCTL of NT4/2000/XP. Undocumented
 147     and possibly buggy system calls are used for this purpose,
 148     see WARNINGS file for details.
 149
 150     SCSI devices are supported on all versions of Windows. An installed
 151     ASPI interface (WNASPI32.DLL) is required to access SCSI devices.
 152     The code was tested with Adaptec Windows ASPI drivers 4.71.2.
 153     (http://www.adaptec.com/en-US/support/scsi_soft/ASPI/ASPI-4.70/)
 154     Links to other ASPI drivers can be found at http://www.nu2.nu/aspi/.
 155
 156     3ware 9000 RAID controllers are supported using new features available
 157     in the Windows driver release 9.4.0 (3wareDrv.sys 3.0.2.70) or later.
 158     Older drivers provide SMART access to the first physical drive (port)
 159     of each logical drive (unit).
 160
 161     G) MacOS/Darwin
 162
 163     The code was tested on MacOS 10.3.4.  It should work from 10.3
 164     forwards.  It doesn't support 10.2.
 165
 166     It's important to know that on 10.3.x, some things don't work
 167     (see WARNINGS): due to bugs in the libraries used, you cannot run
 168     a short test or switch SMART support off on a drive; if you try,
 169     you will just run an extended test or switch SMART support on.  So
 170     don't panic when your "short" test seems to be taking hours.
 171
 172     It's also not possible at present to control when the offline
 173     routine runs. If your drive doesn't have it running automatically by
 174     default, you can't run it at all.
 175
 176     SCSI devices are not currently supported.  Detecting the power
 177     status of a drive is also not currently supported.
 178
 179     To summarize this, from another point of view, the things that
 180     are not supported fall into two categories:
 181
 182    * Can't be implemented easily without more kernel-level support,
 183      so far as I know:
 184      - running immediate offline, conveyance, or selective tests
 185      - running any test in captive mode
 186      - aborting tests
 187      - switching automatic offline testing on or off
 188      - support for SCSI
 189      - checking the power mode [-n Directive of smartd] (this is not
 190        completely impossible, but not by using a documented API)
 191
 192    * Work on 10.4 and later, but not on 10.3:
 193      - switching off SMART (switching *on* works fine)
 194      - switching off auto-save (but why would you want to?)
 195      - running the short test (that leaves you with only the extended test)
 196
 197     However, some things do work well.  For ATA devices, all the
 198     informational output is available, unless you want something that only
 199     an offline test updates.  On many newer Mac OS systems, the
 200     hard drive comes with the offline test switched on by default, so
 201     even that works.
 202
 203     H) OS/2, eComStation
 204
 205     The code was tested on eComStation 1.1, but it should work on all versions
 206     of OS/2.
 207     Innotek LibC 0.5 runtime is required.
 208     Currently only ATA disks are supported, SCSI support will be added.
 209
 210
 211 [2] Installing from CVS
 212 =======================
 213     Get the sources from the CVS repository:
 214     cvs -d :pserver:anonymous@smartmontools.cvs.sourceforge.net:/cvsroot/smartmontools login
 215     cvs -d :pserver:anonymous@smartmontools.cvs.sourceforge.net:/cvsroot/smartmontools co sm5
 216     (when prompted for a password, just press Enter)
 217
 218     Then type:
 219     ./autogen.sh
 220     and continue with step [3] below, skipping the "unpack the tarball" step.
 221
 222     Further details of using CVS can be found at the URL above.
 223
 224     The autogen.sh command is ONLY required when installing from
 225     CVS. You need GNU Autoconf (version 2.50 or greater), GNU Automake
 226     (version 1.6 or greater) and their dependencies installed in order
 227     to run it.  You can get these here:
 228     http://www.gnu.org/directory/GNU/autoconf.html
 229     http://www.gnu.org/directory/GNU/automake.html
 230
 231 [3] Installing from the source tarball
 232 ======================================
 233
 234     If you are NOT installing from CVS, then unpack the tarball:
 235     tar zxvf smartmontools-5.VERSION.tar.gz
 236
 237     Then:
 238     ./configure
 239     make
 240     make install (you may need to be root to do this)
 241
 242     As shown (with no options to ./configure) this defaults to the
 243     following set of installation directories:
 244     --prefix=/usr/local
 245     --sbindir=/usr/local/sbin
 246     --sysconfdir=/usr/local/etc
 247     --mandir=/usr/local/share/man
 248     --with-docdir=/usr/local/share/doc/smartmontools-VERSION
 249     --with-initscriptdir=/usr/local/etc/rc.d/init.d
 250     --disable-sample
 251
 252     These will usually not overwrite existing "distribution" installations on
 253     Linux Systems since the FHS reserves this area for use by the system
 254     administrator.
 255
 256     For different installation locations or distributions, simply add
 257     arguments to ./configure as shown in [4] below.
 258
 259     If you wish to alter the default C compiler flags, set an
 260     environment variable CFLAGS='your options' before doing
 261     ./configure, or else do:
 262     make CFLAGS='your options'
 263
 264 [4] Guidelines for different Linux distributions
 265 ================================================
 266
 267 Note: Please send corrections/additions to:
 268 smartmontools-support@lists.sourceforge.net
 269
 270 Debian:
 271   If you don't want to overwrite any distribution package, use:
 272   ./configure
 273
 274 Filesystem Hierarchy Standard (FHS, http://www.pathname.com/fhs/):
 275   ./configure --sbindir=/usr/local/sbin                               \
 276               --sysconfdir=/usr/local/etc                             \
 277               --mandir=/usr/local/man                                 \
 278               --with-initscriptdir=/usr/local/etc/rc.d/init.d         \
 279               --with-docdir=/usr/local/share/doc/smartmontools-VERSION
 280
 281 Red Hat:
 282   ./configure --sbindir=/usr/sbin                               \
 283               --sysconfdir=/etc                                 \
 284               --mandir=/usr/share/man                           \
 285               --with-initscriptdir=/etc/rc.d/init.d             \
 286               --with-docdir=/usr/share/doc/smartmontools-VERSION
 287
 288 Slackware:
 289   If you don't want to overwrite any "distribution" package, use:
 290   ./configure
 291
 292   Otherwise use:
 293   ./configure --sbindir=/usr/sbin                               \
 294               --sysconfdir=/etc                                 \
 295               --mandir=/usr/share/man                           \
 296               --with-initscriptdir=/etc/rc.d                    \
 297               --with-docdir=/usr/share/doc/smartmontools-VERSION
 298
 299   And
 300   removepkg smartmontools smartsuite (only root can do this)
 301   before make install
 302
 303   The init script works on Slackware. You just have to add an entry like
 304   the following in /etc/rc.d/rc.M or /etc/rc.d/rc.local:
 305
 306   if [ -x /etc/rc.d/smartd ]; then
 307     . /etc/rc.d/smartd start
 308   fi
 309
 310   To disable it:
 311   chmod 644 /etc/rc.d/smartd
 312
 313   For a list of options:
 314   /etc/rc.d/smartd
 315
 316 SuSE:
 317   ./configure --sbindir=/usr/sbin                                        \
 318               --sysconfdir=/etc                                          \
 319               --mandir=/usr/share/man                                    \
 320               --with-initscriptdir=/etc/init.d                           \
 321               --with-docdir=/usr/share/doc/packages/smartmontools-VERSION
 322
 323 [5] Guidelines for FreeBSD
 324 ==========================
 325   To match the way it will installed when it becomes available as a PORT, use
 326   the following:
 327
 328   ./configure --prefix=/usr/local                                      \
 329               --with-initscriptdir=/usr/local/etc/rc.d/                \
 330               --with-docdir=/usr/local/share/doc/smartmontools-VERSION \
 331               --enable-sample
 332
 333   Also, it is important that you use GNU make (gmake from /usr/ports/devel/gmake)
 334   to build smartmontools, as the default FreeBSD make doesn't know how to build
 335   the man pages.
 336
 337   NOTE: --enable-sample will cause the smartd.conf and smartd RC files to
 338   be installed with the string '.sample' append to the name, so you will end
 339   up with the following:
 340         /usr/local/etc/smartd.conf.sample
 341         /usr/local/etc/rc.d/smartd.sample
 342
 343
 344 [6] Guidelines for Darwin
 345 =========================
 346   ./configure --with-initscriptdir=/Library/StartupItems
 347
 348   If you'd like to build the i386 version on a powerpc machine, you can
 349   use
 350
 351   CC='gcc -isysroot /Developer/SDKs/MacOSX10.4u.sdk -arch i386' \
 352     ./configure --host=i386-apple-darwin \
 353                 --with-initscriptdir=/Library/StartupItems
 354
 355 [7] Guidelines for NetBSD/OpenBSD
 356 =================================
 357   ./configure --prefix=/usr/pkg                                       \
 358               --with-docdir=/usr/pkg/share/doc/smartmontools
 359
 360   On OpenBSD, it is important that you use GNU make (gmake from
 361   /usr/ports/devel/gmake) to build smartmontools, as the BSD make doesn't
 362   know how to make the manpages.
 363
 364 [8] Guidelines for Solaris
 365 ==========================
 366
 367     smartmontools has been partially but not completely ported to
 368     Solaris.  It includes complete SCSI support but no ATA or 3ware
 369     support.  It can be compiled with either cc or gcc. To compile
 370     with gcc:
 371
 372     ./configure [args]
 373     make
 374
 375     To compile with Sun cc:
 376
 377     setenv CC cc  [csh syntax], or
 378     CC=cc         [sh syntax]
 379     ./configure [args]
 380     make
 381
 382     The correct arguments [args] to configure are:
 383      --sbindir=/usr/sbin                                \
 384      --sysconfdir=/etc                                  \
 385      --mandir=/usr/share/man                            \
 386      --with-docdir=/usr/share/doc/smartmontools-VERSION \
 387      --with-initscriptdir=/etc/init.d
 388
 389     To start the script automatically on bootup, create hardlinks that
 390     indicate when to start/stop in:
 391                     /etc/rc[S0123].d/
 392     pointing to /etc/init.d/smartd. Create:
 393             K<knum>smartd in rcS.d, rc0.d, rc1.d, rc2.d
 394             S<snum>smartd in rc3.d
 395     where <knum> is related to <snum> such that the higher snum is the
 396     lower knum must be.
 397
 398     On usual configuration, '95' would be suitable for <snum> and '05'
 399     for <knum> respectively.  If you choose these value, you can
 400     create hardlinks by:
 401
 402     cd /etc
 403     sh -c 'for n in S 0 1 2; do ln init.d/smartd rc$n.d/K05smartd; done'
 404     sh -c 'for n in 3      ; do ln init.d/smartd rc$n.d/S95smartd; done'
 405
 406 [9] Guidelines for Cygwin
 407 =========================
 408
 409 Same as Red Hat:
 410   ./configure --prefix=/usr                 \
 411               --sysconfdir=/etc             \
 412               --mandir='${prefix}/share/man'
 413
 414   OR EQUIVALENTLY
 415   ./configure --sbindir=/usr/sbin                               \
 416               --sysconfdir=/etc                                 \
 417               --mandir=/usr/share/man                           \
 418               --with-initscriptdir=/etc/rc.d/init.d             \
 419               --with-docdir=/usr/share/doc/smartmontools-VERSION
 420
 421   Using DOS text file type as default for the working directories ("textmode"
 422   mount option) is not recommended. Building the binaries and man pages using
 423   "make" is possible, but "make dist" and related targets work only with UNIX
 424   file type ("binmode" mount option) set. The "autogen.sh" script prints a
 425   warning if DOS type is selected.
 426
 427   If installing from CVS, you may check out all files either with CR/LF
 428   or LF line endings. Starting with release 3.1-7, Cygwin's bash does no
 429   longer accept scripts with CR/LF by default. To run the initial script
 430   ./autogen.sh checked out with CR/LF on a "binmode" mount, type:
 431
 432   bash -O igncr ./autogen.sh
 433
 434   instead. This is not necessary for the generated ./configure script.
 435
 436 [10] Guidelines for Windows
 437 ==========================
 438
 439 To compile the Windows release with MinGW, use the following on Cygwin:
 440
 441   ./configure --build=mingw32
 442   make
 443
 444   Instead of using "make install", copy the .exe files into
 445   some directory in the PATH.
 446
 447 To build the Windows binary distribution, use:
 448
 449   make dist-win32
 450
 451   This builds the distribution in directory
 452
 453   ./smartmontools-VERSION.win32/
 454
 455   and packs it into
 456
 457   ./smartmontools-VERSION.win32.zip
 458
 459 To create a Windows installer, use:
 460
 461   make installer-win32
 462
 463   This builds the distribution directory and packs it into the
 464   self-extracting install program
 465
 466   ./smartmontools-VERSION.win32-setup.exe
 467
 468   The installer is build using the command "makensis" from the NSIS
 469   package. See http://nsis.sourceforge.net/ for documentation and
 470   download location. The install script was tested with NSIS 2.17.
 471
 472 To both create and run the (interactive) installer, use:
 473
 474   make install-win32
 475
 476   Additional make targets are distdir-win32 to build the directory
 477   only and cleandist-win32 for cleanup.
 478
 479   The binary distribution includes all documentation files converted
 480   to DOS text file format and *.html and *.txt preformatted man pages.
 481   The tools unix2dos.exe (package cygutils) and zip.exe (package zip
 482   or a native Win32 release of Info-ZIP, http://www.info-zip.org) are
 483   necessary but may be not installed by Cygwin's default settings.
 484
 485   It is also possible to compile smartmontools with MSVC 6.0.
 486   The project files (smartmontools_vc6.dsw, smart{ctl,d}_vc6.dsp) are
 487   included in CVS (but not in source tarball). The config_vc6.h is no
 488   longer maintained in CVS. The command:
 489
 490   make config-vc6
 491
 492   builds config_vc6.h from MinGW's config.h. Unlike MinGW, MSVC 6.0
 493   can also be used to build the syslog message file tool syslogevt.exe.
 494   See smartd man page for usage information about this tool.
 495
 496
 497 [11] Guidelines for OS/2, eComStation
 498 =====================================
 499
 500 To compile the OS/2 code, please run
 501
 502   ./os_os2/configure.os2
 503   make
 504   make install
 505
 506 [12] Guidelines for OpenBSD
 507 ==========================
 508   To match the way it will installed when it becomes available as a PORT, use
 509   the following:
 510
 511   ./configure --prefix=/usr/local                                      \
 512               --sysconfdir=/etc
 513               --with-initscriptdir=/usr/local/share/doc/smartmontools-VERSION \
 514               --with-docdir=/usr/local/share/doc/smartmontools-VERSION \
 515               --enable-sample
 516
 517   It is important that you use GNU make (gmake from /usr/ports/devel/gmake)
 518   to build smartmontools, as the default OpenBSD make doesn't know how to build
 519   the man pages.
 520
 521   NOTE1: --with-initscriptdir installs a SystemV startup script.  It really
 522   should be --without-initscriptdir, but the Makefile code is incorrect and
 523   trys to install the initscript (smartd) to /no.  So, an interim fix it to
 524   set the initscript dir to the doc dir.
 525
 526   NOTE2: --enable-sample will cause the smartd.conf and smartd RC files to
 527   be installed with the string '.sample' append to the name, so you will end
 528   up with the following:
 529         /usr/local/etc/smartd.conf.sample
 530         /usr/local/etc/rc.d/smartd.sample
 531
 532 [13] Comments
 533 ============
 534
 535 To compile from another directory, you can replace the step
 536   ./configure [options]
 537 by the following:
 538   mkdir objdir
 539   cd objdir
 540   ../configure [options]
 541
 542 To install to another destination (used mainly by package maintainers,
 543 or to examine the package contents without risk of modifying any
 544 system files) you can replace the step:
 545   make install
 546 with:
 547   make DESTDIR=/home/myself/smartmontools-package install
 548
 549 Use a full path. Paths like ~/smartmontools-package may not work.
 550
 551 After installing smartmontools, you can read the man pages, and try
 552 out the commands:
 553
 554 man smartd.conf
 555 man smartctl
 556 man smartd
 557
 558 /usr/sbin/smartctl -s on -o on -S on /dev/hda (only root can do this)
 559 /usr/sbin/smartctl -a /dev/hda (only root can do this)
 560
 561 Note that the default location for the manual pages are
 562 /usr/share/man/man5 and /usr/share/man/man8.  If "man" doesn't find
 563 them, you may need to add /usr/share/man to your MANPATH environment
 564 variable.
 565
 566 Source and binary RPM packages are available at
 567 http://sourceforge.net/project/showfiles.php?group_id=64297
 568
 569 Refer to http://smartmontools.sourceforge.net/index.html#howtodownload
 570 for any additional download and installation instructions.
 571
 572 The following files are installed if ./configure has no options:
 573
 574 /usr/local/sbin/smartd                                  [Executable daemon]
 575 /usr/local/sbin/smartctl                                [Executable command-line utility]
 576 /usr/local/etc/smartd.conf                              [Configuration file for smartd daemon]
 577 /usr/local/etc/rc.d/init.d/smartd                       [Init/Startup script for smartd]
 578 /usr/local/share/man/man5/smartd.conf.5                 [Manual page]
 579 /usr/local/share/man/man8/smartctl.8                    [Manual page]
 580 /usr/local/share/man/man8/smartd.8                      [Manual page]
 581 /usr/local/share/doc/smartmontools-5.X/AUTHORS          [Information about the authors and developers]
 582 /usr/local/share/doc/smartmontools-5.X/CHANGELOG        [A log of changes. Also see CVS]
 583 /usr/local/share/doc/smartmontools-5.X/COPYING          [GNU General Public License Version 2]
 584 /usr/local/share/doc/smartmontools-5.X/INSTALL          [Installation instructions: what you're reading!]
 585 /usr/local/share/doc/smartmontools-5.X/NEWS             [Significant bugs discovered in old versions]
 586 /usr/local/share/doc/smartmontools-5.X/README           [Overview]
 587 /usr/local/share/doc/smartmontools-5.X/TODO             [Things that need to be done/fixed]
 588 /usr/local/share/doc/smartmontools-5.X/WARNINGS         [Systems where lockups or other serious problems were reported]
 589 /usr/local/share/doc/smartmontools-5.X/smartd.conf      [Example configuration file for smartd]
 590 /usr/local/share/doc/smartmontools-5.X/examplescripts   [Executable scripts for -M exec of smartd.conf (4 files)]
 591
 592 The commands:
 593
 594 make htmlman
 595 make txtman
 596
 597 may be used to build .html and .txt preformatted man pages.
 598 These are used by the dist-win32 make target to build the Windows
 599 distribution.
 600 The commands also work on other operating system configurations
 601 if suitable versions of man2html, groff and grotty are installed.
 602 On systems without man2html, the following command should work
 603 if groff is available:
 604
 605 make MAN2HTML='groff -man -Thtml' htmlman
 606
 607
 608 [14] Detailed description of arguments to configure command
 609 ===========================================================
 610
 611 When you type:
 612 ./configure [options]
 613 there are six particularly important variables that affect where the
 614 smartmontools software is installed.  The variables are listed here,
 615 with their default values in square brackets, and the quantities that
 616 they affect described following that.  This is a very wide table: please read
 617 it in a wide window.
 618
 619 OPTIONS              DEFAULT                                      AFFECTS
 620 -------              -------                                      -------
 621 --prefix             /usr/local                                   Please see below
 622 --sbindir            ${prefix}/sbin                               Directory for smartd/smartctl executables;
 623                                                                   Contents of smartd/smartctl man pages
 624 --mandir             ${prefix}/share/man                          Directory for smartctl/smartd/smartd.conf man pages
 625 --sysconfdir         ${prefix}/etc                                Directory for smartd.conf;
 626                                                                   Contents of smartd executable;
 627                                                                   Contents of smartd/smartd.conf man pages;
 628                                                                   Directory for rc.d/init.d/smartd init script
 629 --with-initscriptdir  ${sysconfdir}/init.d/rc.d                   Location of init scripts
 630 --with-docdir         ${prefix}/share/doc/smartmontools-5.X       Location of the documentation
 631 --enable-sample       --disable-sample                            Adds the string '.sample' to the names of the smartd.conf file and the smartd RC file
 632
 633 Here's an example:
 634 If you set --prefix=/home/joe and none of the other four
 635 variables then the different directories that are used would be:
 636 --sbindir             /home/joe/sbin
 637 --mandir              /home/joe/share/man
 638 --sysconfdir          /home/joe/etc
 639 --with-initscriptdir  /home/joe/etc/init.d/rc.d
 640 --with-docdir         /home/joe/doc/smartmontools-5.X
 641
 642 This is useful for test installs in a harmless subdirectory somewhere.
 643
 644 Here are the four possible cases for the four variables above:
 645
 646 Case 1:
 647 --prefix not set
 648 --variable not set
 649 ===> VARIABLE gets default value above
 650
 651 Case 2:
 652 --prefix set
 653 --variable not set
 654 ===> VARIABLE gets PREFIX/ prepended to default value above
 655
 656 Case 3:
 657 --prefix not set
 658 --variable set
 659 ===> VARIABLE gets value that is set
 660
 661 Case 4:
 662 --prefix is set
 663 --variable is set
 664 ===> PREFIX is IGNORED, VARIABLE gets value that is set
 665
 666
 667 Here are the differences with and without --enable-sample, assuming
 668 no other options specified (see above for details)
 669
 670 Case 1:
 671 --enable-sample provided
 672 ==> Files installed are:
 673         /usr/local/etc/smartd.conf.sample
 674         /usr/local/etc/rc.d/init.d/smartd.sample
 675
 676 Case 2:
 677 --disable-sample provided or parameter left out
 678 ==> Files installed are:
 679         /usr/local/etc/smartd.conf
 680         /usr/local/etc/rc.d/init.d/smartd
 681
 682 Additional information about using configure can be found here:
 683 http://www.gnu.org/software/autoconf/manual/autoconf-2.57/html_mono/autoconf.html#SEC139