Merge branch 'upstream' of git.debian.org:/git/collab-maint/smartmontools into upstream

[mirror_smartmontools-debian.git] / update-smart-drivedb.8.in

.ig
Copyright (C) 2013 Hannes von Haugwitz <hannes@vonhaugwitz.com>
<<<<<<< HEAD
Copyright (C) 2014-16 Christian Franke

$Id: update-smart-drivedb.8.in 4223 2016-02-26 20:18:40Z chrfranke $
=======
Copyright (C) 2014-15 Christian Franke <smartmontools-support@lists.sourceforge.net>

$Id: update-smart-drivedb.8.in 4054 2015-04-15 19:04:49Z chrfranke $
>>>>>>> 3d8ad6fa4529eb02ae1391a1e937bf57aad3fb74

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

You should have received a copy of the GNU General Public License
(for example COPYING); If not, see <http://www.gnu.org/licenses/>.

..
.TH UPDATE-SMART-DRIVEDB 8 "CURRENT_SVN_DATE" "CURRENT_SVN_VERSION" "SMART Monitoring Tools"
.SH NAME
update-smart-drivedb \- update smartmontools drive database

.SH "SYNOPSIS"
.B update-smart-drivedb
.RI [ OPTIONS ]
.RI [ DESTFILE ]

.SH "DESCRIPTION"
.\" %IF NOT OS ALL
.\"! [This man page is generated for the OS_MAN_FILTER version of smartmontools.
.\"! It does not contain info specific to other platforms.]
.\"! .PP
.\" %ENDIF NOT OS ALL
.B update-smart-drivedb
updates
.B /usr/local/share/smartmontools/drivedb.h
or
.I DESTFILE
from smartmontools SVN repository.

It tries to download first from the current branch and then from
trunk. The tools used for downloading are either
.BR curl (1),
.BR wget (1),
.BR lynx (1),
.\" %IF OS FreeBSD
.BR fetch (1)
[FreeBSD only],
.\" %ENDIF OS FreeBSD
.\" %IF OS OpenBSD
.BR ftp (1)
[OpenBSD only],
.\" %ENDIF OS OpenBSD
or
.BR svn (1).

The old file is kept if the downloaded file is identical (ignoring
the differences in Id string) otherwise it is moved to
.BR drivedb.h.old .

.SH "OPTIONS"
.TP
.B \-s SMARTCTL
Use the
.BR smartctl (8)
executable at path SMARTCTL for drive database syntax check.
The form \'\-s \-\' disables the syntax check.
The default is
.BR /usr/local/sbin/smartctl .
.TP
.B \-t TOOL
Use TOOL for download.
TOOL is one of:
.I curl wget lynx
.\" %IF OS FreeBSD
.I fetch
.\" %ENDIF OS FreeBSD
.\" %IF OS OpenBSD
.I ftp
.\" %ENDIF OS OpenBSD
.IR svn .
The default is the first one found in PATH.
.TP
.B \-u LOCATION
Use URL of LOCATION for download. LOCATION is one of:
.br
.I sf
(Sourceforge code browser via HTTPS),
.br
.I svn
(SVN repository via HTTPS),
.br
.I svni
(SVN repository via HTTP),
.br
.I trac
(Trac code browser via HTTPS).
.br
The default is
.IR svn .
.TP
.B \-\-cacert FILE
Use CA certificates from FILE to verify the peer.
.TP
.B \-\-capath DIR
Use CA certificate files from DIR to verify the peer.
.TP
.B \-\-insecure
Don't abort download if certificate verification fails.
This option is also required if a HTTP URL is selected with \'-u\' option.
.TP
.B \-\-dryrun
Print download commands only.
.TP
.B \-v
Verbose output.

.SH "EXAMPLES"
.nf
# update-smart-drivedb
/usr/local/share/smartmontools/drivedb.h updated from branches/RELEASE_6_0_DRIVEDB
.fi

.SH "EXIT STATUS"
The exit status is 0 if the database has been successfully
updated. If an error occurs the exit status is 1.

.SH FILES
.TP
.B /usr/local/sbin/update-smart-drivedb
full path of this script.
.TP
.B /usr/local/sbin/smartctl
used to check syntax of new drive database.
.TP
.B /usr/local/share/smartmontools/drivedb.h
current drive database.
.TP
.B /usr/local/share/smartmontools/drivedb.h.old
previous drive database.
.TP
.B /usr/local/share/smartmontools/drivedb.h.error
new drive database if rejected due to syntax errors.
.TP
.B /usr/local/share/smartmontools/drivedb.h.lastcheck
empty file created if downloaded file was identical.

.SH AUTHORS
\fBChristian Franke\fP.
.br
This manual page was originally written by
.BR "Hannes von Haugwitz <hannes@vonhaugwitz.com>" .

.SH REPORTING BUGS
To submit a bug report, create a ticket in smartmontools wiki:
.br
<\fBhttp://www.smartmontools.org/\fP>.
.br
Alternatively send the info to the smartmontools support mailing list:
.br
<\fBhttps://lists.sourceforge.net/lists/listinfo/smartmontools-support\fB>.

.SH SEE ALSO
\fBsmartctl\fP(8), \fBsmartd\fP(8).

.SH PACKAGE VERSION
CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
.br
<<<<<<< HEAD
$Id: update-smart-drivedb.8.in 4223 2016-02-26 20:18:40Z chrfranke $
=======
$Id: update-smart-drivedb.8.in 4054 2015-04-15 19:04:49Z chrfranke $
>>>>>>> 3d8ad6fa4529eb02ae1391a1e937bf57aad3fb74