new patch: manpage improvements

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

diff --git a/update-smart-drivedb.8.in b/update-smart-drivedb.8.in
index 24e6afc1c1b8be82c006dc431c60b7f7f6d4bf75..e072d7b8650783c7faba987cd84fb05823224d26 100644 (file)
--- a/update-smart-drivedb.8.in
+++ b/update-smart-drivedb.8.in
@@ -1,8 +1,8 @@
 .ig
 Copyright (C) 2013 Hannes von Haugwitz <hannes@vonhaugwitz.com>
-Copyright (C) 2014 Christian Franke <smartmontools-support@lists.sourceforge.net>
+Copyright (C) 2014-15 Christian Franke
 
-$Id: update-smart-drivedb.8.in 3961 2014-07-19 16:44:10Z chrfranke $
+$Id: update-smart-drivedb.8.in 4193 2015-12-19 14:43:50Z chrfranke $
 
 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
@@ -13,19 +13,21 @@ 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 CURRENT_SVN_DATE
+.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
-.RB [ -v ]
+.RI [ OPTIONS ]
 .RI [ DESTFILE ]
 
-.SH PACKAGE VERSION
-CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
-
 .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
@@ -36,18 +38,18 @@ 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) 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).
 
 The old file is kept if the downloaded file is identical (ignoring
 the differences in Id string) otherwise it is moved to
@@ -55,8 +57,60 @@ the differences in Id string) otherwise it is moved to
 
 .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 \'\-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 HTTP),
+.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
@@ -83,22 +137,30 @@ current drive database.
 previous drive database.
 .TP
 .B /usr/local/share/smartmontools/drivedb.h.error
-new drive database rejected due to syntax errors.
+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 "SEE ALSO"
-.BR smartctl (8),
-.BR smartd (8).
-
 .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 $
+.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
+$Id: update-smart-drivedb.8.in 4193 2015-12-19 14:43:50Z chrfranke $