]> git.proxmox.com Git - mirror_smartmontools-debian.git/blobdiff - update-smart-drivedb.8.in
import smartmontools 7.0
[mirror_smartmontools-debian.git] / update-smart-drivedb.8.in
index 24e6afc1c1b8be82c006dc431c60b7f7f6d4bf75..3ed66eaf6a30da727348c79e82dc043be303e54d 100644 (file)
 .ig
 Copyright (C) 2013 Hannes von Haugwitz <hannes@vonhaugwitz.com>
-Copyright (C) 2014 Christian Franke <smartmontools-support@lists.sourceforge.net>
+Copyright (C) 2014-18 Christian Franke
 
-$Id: update-smart-drivedb.8.in 3961 2014-07-19 16:44:10Z chrfranke $
+SPDX-License-Identifier: GPL-2.0-or-later
 
-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/>.
+$Id: update-smart-drivedb.8.in 4879 2018-12-28 22:05:12Z chrfranke $
 
 ..
-.TH UPDATE-SMART-DRIVEDB 8 CURRENT_SVN_DATE CURRENT_SVN_VERSION CURRENT_SVN_DATE
+.\" Macros borrowed from pages generated with Pod::Man
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Use groff extension \(aq (apostrophe quote, ASCII 0x27) if possible
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.TH UPDATE-SMART-DRIVEDB 8 "CURRENT_SVN_DATE" "CURRENT_SVN_VERSION" "SMART Monitoring Tools"
 .SH NAME
 update-smart-drivedb \- update smartmontools drive database
-
+.Sp
 .SH "SYNOPSIS"
 .B update-smart-drivedb
-.RB [ -v ]
+.RI [ OPTIONS ]
 .RI [ DESTFILE ]
-
-.SH PACKAGE VERSION
-CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
-
+.Sp
 .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
+from branches/RELEASE_6_0_DRIVEDB of smartmontools SVN repository.
+.PP
+The tools used for downloading are either
 .BR curl (1),
-.BR wget "(1) or"
-.BR lynx (1).
+.BR wget (1),
+.BR lynx (1),
 .\" %IF OS FreeBSD
-On FreeBSD,
 .BR fetch (1)
-is used as a fallback.
+[FreeBSD only],
 .\" %ENDIF OS FreeBSD
 .\" %IF OS OpenBSD
-On OpenBSD,
 .BR ftp (1)
-is used as a fallback.
+[OpenBSD only],
 .\" %ENDIF OS OpenBSD
-
+or
+.BR svn (1).
+.PP
+[NEW EXPERIMENTAL UPDATE-SMART-DRIVEDB FEATURE]
+The downloaded file is verified with OpenPGP/GPG key ID 721042C5.
+The public key block is included in the script.
+.PP
 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 .
-
+.Sp
 .SH "OPTIONS"
 .TP
-\-v
-verbose output
-
+.B \-s SMARTCTL
+Use the
+.BR smartctl (8)
+executable at path SMARTCTL for drive database syntax check.
+The form \*(Aq\-s \-\*(Aq 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 github
+(GitHub mirror of SVN repository),
+.br
+.I sf
+(Sourceforge code browser),
+.br
+.I svn
+(SVN repository),
+.br
+.I svni
+(SVN repository via HTTP instead of HTTPS),
+.br
+.I trac
+(Trac code browser).
+.br
+The default is
+.IR svn .
+.TP
+.B \-\-trunk
+Download from SVN trunk.
+This requires \*(Aq\-\-no\-verify\*(Aq unless the trunk version is still
+identical to branches/RELEASE_6_0_DRIVEDB.
+.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 \*(Aq\-u\*(Aq
+option.
+.TP
+.B \-\-no\-verify
+Don't verify signature with GnuPG.
+.TP
+.B \-\-export\-key
+Print the OpenPGP/GPG public key block.
+.TP
+.B \-\-dryrun
+Print download commands only.
+.TP
+.B \-v
+Verbose output.
+.Sp
 .SH "EXAMPLES"
-.nf
+.Vb 2
 # update-smart-drivedb
-/usr/local/share/smartmontools/drivedb.h updated from branches/RELEASE_6_0_DRIVEDB
-.fi
-
+/usr/local/share/smartmontools/drivedb.h updated from \e
+branches/RELEASE_6_0_DRIVEDB
+.Ve
+.Sp
 .SH "EXIT STATUS"
 The exit status is 0 if the database has been successfully
-updated. If an error occurs the exit status is 1.
-
+updated.
+If an error occurs the exit status is 1.
+.Sp
 .SH FILES
 .TP
 .B /usr/local/sbin/update-smart-drivedb
@@ -79,26 +161,40 @@ used to check syntax of new drive database.
 .B /usr/local/share/smartmontools/drivedb.h
 current drive database.
 .TP
-.B /usr/local/share/smartmontools/drivedb.h.old
-previous drive database.
+.B /usr/local/share/smartmontools/drivedb.h.raw
+current drive database with unexpanded SVN Id string.
 .TP
-.B /usr/local/share/smartmontools/drivedb.h.error
-new drive database rejected due to syntax errors.
+.B /usr/local/share/smartmontools/drivedb.h.raw.asc
+signature file.
+.TP
+.B /usr/local/share/smartmontools/drivedb.h.*old*
+previous files.
+.TP
+.B /usr/local/share/smartmontools/drivedb.h.*error*
+new files if rejected due to errors.
 .TP
 .B /usr/local/share/smartmontools/drivedb.h.lastcheck
 empty file created if downloaded file was identical.
-
-.SH "SEE ALSO"
-.BR smartctl (8),
-.BR smartd (8).
-
+.Sp
 .SH AUTHORS
-\fBChristian Franke\fP
-.br
-\fBsmartmontools\-support@lists.sourceforge.net\fP
+\fBChristian Franke\fP.
 .br
 This manual page was originally written by
 .BR "Hannes von Haugwitz <hannes@vonhaugwitz.com>" .
-
-.SH SVN ID OF THIS PAGE
-$Id: update-smart-drivedb.8.in 3961 2014-07-19 16:44:10Z chrfranke $
+.Sp
+.SH REPORTING BUGS
+To submit a bug report, create a ticket in smartmontools wiki:
+.br
+<\fBhttps://www.smartmontools.org/\fP>.
+.br
+Alternatively send the info to the smartmontools support mailing list:
+.br
+<\fBhttps://listi.jpberlin.de/mailman/listinfo/smartmontools-support\fB>.
+.Sp
+.SH SEE ALSO
+\fBsmartctl\fP(8), \fBsmartd\fP(8).
+.Sp
+.SH PACKAGE VERSION
+CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
+.br
+$Id: update-smart-drivedb.8.in 4879 2018-12-28 22:05:12Z chrfranke $