1. Summary
  2. Files
  3. Support
  4. Report Spam
  5. Create account
  6. Log in

root/trunk/sm5/INSTALL @ 993

Revision 993, 12.1 KB (checked in by pervalidus, 11 years ago)

Some minor changes. That's all for now.

Maybe I should do a single commit instead of a dozen...

Line 
1Any recent Linux distribution should support this package.  Note that
2smartmontools requires Linux kernel 2.2.14 or greater in order to run at
3all.  But to give the ATA RETURN SMART STATUS command, the kernel needs
4to support the HDIO_DRIVE_TASK ioctl().  Any 2.4 series kernel should
5provide this support.  I am told that some of the 2.2.20 and later
6kernels also provide this support if they are properly
7patched/configured.
8
9To install from sources, use the commands:
10
11./autogen.sh
12
13The above command is only required when installing from CVS. You need
14GNU Autoconf, GNU Automake, and their dependencies installed in order to
15run it.
16
17./configure
18
19This defaults to --prefix=/usr --sysconfdir=/etc --mandir=/usr/share/man
20--docdir=/usr/share/doc --exampledir=/usr/share/doc/examplescripts ,
21which are correct for Red Hat, Slackware, and probably other Linux
22distributions.
23
24For FHS compliance, use --prefix=/usr/local , and for a full list of
25options --help
26
27make
28make install (only root can do this)
29
30To compile from another directory, you can replace ./configure by the
31following:
32
33mkdir objdir
34cd objdir
35../configure
36
37And to install to another destination, used mainly by package
38maintainers:
39
40make DESTDIR=/home/myself/smartmontools-package install
41
42Use a full PATH. ~/smartmontools-package may not work.
43
44After installing it, you can read the man pages, and try out the
45commands:
46   
47man smartd.conf
48man smartctl
49man smartd
50
51/usr/sbin/smartctl -s on -o on -S on /dev/hda (only root can do this)
52/usr/sbin/smartctl -a /dev/hda (only root can do this)
53
54Note that the default location for the manual pages are
55/usr/share/man/man5 and /usr/share/man/man8.  If "man" doesn't find
56them, then you may need to add /usr/share/man to your MANPATH
57environment variable.
58
59Source and binary RPM packages are available at
60http://sourceforge.net/project/showfiles.php?group_id=64297
61
62Refer to http://smartmontools.sourceforge.net/index.html#howtodownload
63for any additional installation instructions.
64
65Seventeen files are installed:
66/usr/sbin/smartctl                              [Executable command-line utility]
67/usr/sbin/smartd                                [Executable daemon]
68/etc/rc.d/init.d/smartd                         [Init/Startup script for smartd]
69/usr/share/man/man5/smartd.conf.5.gz            [Manual page]
70/usr/share/man/man8/smartctl.8.gz               [Manual page]
71/usr/share/man/man8/smartd.8.gz                 [Manual page]
72/usr/share/doc/smartmontools-5.1/AUTHORS        [Names and e-mail addresses of the authors and developers]
73/usr/share/doc/smartmontools-5.1/COPYING        [GNU General Public License Version 2]
74/usr/share/doc/smartmontools-5.1/INSTALL        [What you're reading!]
75/usr/share/doc/smartmontools-5.1/NEWS           [A log of changes. Also see CVS]
76/usr/share/doc/smartmontools-5.1/README         [Overview]
77/usr/share/doc/smartmontools-5.1/TODO           [Things that need to be done/fixed]
78/usr/share/doc/smartmontools-5.1/VERSION        [Version number]
79/usr/share/doc/smartmontools-5.1/WARNINGS       [Systems where lockups or other serious problems reported]
80/usr/share/doc/smartmontools-5.1/smartd.conf    [Example Configuration file for /etc/]
81/usr/share/doc/smartmontools-5.1/examplescripts [Executable scripts for -M exec of smartd.conf (4 files)]
82
83
84What follows is the standard INSTALL file from GNU Automake.
85
86
87Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
88Foundation, Inc.
89
90   This file is free documentation; the Free Software Foundation gives
91unlimited permission to copy, distribute and modify it.
92
93Basic Installation
94==================
95
96   These are generic installation instructions.
97
98   The `configure' shell script attempts to guess correct values for
99various system-dependent variables used during compilation.  It uses
100those values to create a `Makefile' in each directory of the package.
101It may also create one or more `.h' files containing system-dependent
102definitions.  Finally, it creates a shell script `config.status' that
103you can run in the future to recreate the current configuration, and a
104file `config.log' containing compiler output (useful mainly for
105debugging `configure').
106
107   It can also use an optional file (typically called `config.cache'
108and enabled with `--cache-file=config.cache' or simply `-C') that saves
109the results of its tests to speed up reconfiguring.  (Caching is
110disabled by default to prevent problems with accidental use of stale
111cache files.)
112
113   If you need to do unusual things to compile the package, please try
114to figure out how `configure' could check whether to do them, and mail
115diffs or instructions to the address given in the `README' so they can
116be considered for the next release.  If you are using the cache, and at
117some point `config.cache' contains results you don't want to keep, you
118may remove or edit it.
119
120   The file `configure.ac' (or `configure.in') is used to create
121`configure' by a program called `autoconf'.  You only need
122`configure.ac' if you want to change it or regenerate `configure' using
123a newer version of `autoconf'.
124
125The simplest way to compile this package is:
126
127  1. `cd' to the directory containing the package's source code and type
128     `./configure' to configure the package for your system.  If you're
129     using `csh' on an old version of System V, you might need to type
130     `sh ./configure' instead to prevent `csh' from trying to execute
131     `configure' itself.
132
133     Running `configure' takes awhile.  While running, it prints some
134     messages telling which features it is checking for.
135
136  2. Type `make' to compile the package.
137
138  3. Optionally, type `make check' to run any self-tests that come with
139     the package.
140
141  4. Type `make install' to install the programs and any data files and
142     documentation.
143
144  5. You can remove the program binaries and object files from the
145     source code directory by typing `make clean'.  To also remove the
146     files that `configure' created (so you can compile the package for
147     a different kind of computer), type `make distclean'.  There is
148     also a `make maintainer-clean' target, but that is intended mainly
149     for the package's developers.  If you use it, you may have to get
150     all sorts of other programs in order to regenerate files that came
151     with the distribution.
152
153Compilers and Options
154=====================
155
156   Some systems require unusual options for compilation or linking that
157the `configure' script does not know about.  Run `./configure --help'
158for details on some of the pertinent environment variables.
159
160   You can give `configure' initial values for configuration parameters
161by setting variables in the command line or in the environment.  Here
162is an example:
163
164     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
165
166   *Note Defining Variables::, for more details.
167
168Compiling For Multiple Architectures
169====================================
170
171   You can compile the package for more than one kind of computer at the
172same time, by placing the object files for each architecture in their
173own directory.  To do this, you must use a version of `make' that
174supports the `VPATH' variable, such as GNU `make'.  `cd' to the
175directory where you want the object files and executables to go and run
176the `configure' script.  `configure' automatically checks for the
177source code in the directory that `configure' is in and in `..'.
178
179   If you have to use a `make' that does not support the `VPATH'
180variable, you have to compile the package for one architecture at a
181time in the source code directory.  After you have installed the
182package for one architecture, use `make distclean' before reconfiguring
183for another architecture.
184
185Installation Names
186==================
187
188   By default, `make install' will install the package's files in
189`/usr/local/bin', `/usr/local/man', etc.  You can specify an
190installation prefix other than `/usr/local' by giving `configure' the
191option `--prefix=PATH'.
192
193   You can specify separate installation prefixes for
194architecture-specific files and architecture-independent files.  If you
195give `configure' the option `--exec-prefix=PATH', the package will use
196PATH as the prefix for installing programs and libraries.
197Documentation and other data files will still use the regular prefix.
198
199   In addition, if you use an unusual directory layout you can give
200options like `--bindir=PATH' to specify different values for particular
201kinds of files.  Run `configure --help' for a list of the directories
202you can set and what kinds of files go in them.
203
204   If the package supports it, you can cause programs to be installed
205with an extra prefix or suffix on their names by giving `configure' the
206option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
207
208Optional Features
209=================
210
211   Some packages pay attention to `--enable-FEATURE' options to
212`configure', where FEATURE indicates an optional part of the package.
213They may also pay attention to `--with-PACKAGE' options, where PACKAGE
214is something like `gnu-as' or `x' (for the X Window System).  The
215`README' should mention any `--enable-' and `--with-' options that the
216package recognizes.
217
218   For packages that use the X Window System, `configure' can usually
219find the X include and library files automatically, but if it doesn't,
220you can use the `configure' options `--x-includes=DIR' and
221`--x-libraries=DIR' to specify their locations.
222
223Specifying the System Type
224==========================
225
226   There may be some features `configure' cannot figure out
227automatically, but needs to determine by the type of machine the package
228will run on.  Usually, assuming the package is built to be run on the
229_same_ architectures, `configure' can figure that out, but if it prints
230a message saying it cannot guess the machine type, give it the
231`--build=TYPE' option.  TYPE can either be a short name for the system
232type, such as `sun4', or a canonical name which has the form:
233
234     CPU-COMPANY-SYSTEM
235
236where SYSTEM can have one of these forms:
237
238     OS KERNEL-OS
239
240   See the file `config.sub' for the possible values of each field.  If
241`config.sub' isn't included in this package, then this package doesn't
242need to know the machine type.
243
244   If you are _building_ compiler tools for cross-compiling, you should
245use the `--target=TYPE' option to select the type of system they will
246produce code for.
247
248   If you want to _use_ a cross compiler, that generates code for a
249platform different from the build platform, you should specify the
250"host" platform (i.e., that on which the generated programs will
251eventually be run) with `--host=TYPE'.
252
253Sharing Defaults
254================
255
256   If you want to set default values for `configure' scripts to share,
257you can create a site shell script called `config.site' that gives
258default values for variables like `CC', `cache_file', and `prefix'.
259`configure' looks for `PREFIX/share/config.site' if it exists, then
260`PREFIX/etc/config.site' if it exists.  Or, you can set the
261`CONFIG_SITE' environment variable to the location of the site script.
262A warning: not all `configure' scripts look for a site script.
263
264Defining Variables
265==================
266
267   Variables not defined in a site shell script can be set in the
268environment passed to `configure'.  However, some packages may run
269configure again during the build, and the customized values of these
270variables may be lost.  In order to avoid this problem, you should set
271them in the `configure' command line, using `VAR=value'.  For example:
272
273     ./configure CC=/usr/local2/bin/gcc
274
275will cause the specified gcc to be used as the C compiler (unless it is
276overridden in the site shell script).
277
278`configure' Invocation
279======================
280
281   `configure' recognizes the following options to control how it
282operates.
283
284`--help'
285`-h'
286     Print a summary of the options to `configure', and exit.
287
288`--version'
289`-V'
290     Print the version of Autoconf used to generate the `configure'
291     script, and exit.
292
293`--cache-file=FILE'
294     Enable the cache: use and save the results of the tests in FILE,
295     traditionally `config.cache'.  FILE defaults to `/dev/null' to
296     disable caching.
297
298`--config-cache'
299`-C'
300     Alias for `--cache-file=config.cache'.
301
302`--quiet'
303`--silent'
304`-q'
305     Do not print messages saying which checks are being made.  To
306     suppress all normal output, redirect it to `/dev/null' (any error
307     messages will still be shown).
308
309`--srcdir=DIR'
310     Look for the package's source code in directory DIR.  Usually
311     `configure' can determine that directory automatically.
312
313`configure' also accepts some other, not widely useful, options.  Run
314`configure --help' for more details.
315
Note: See TracBrowser for help on using the browser.