update-smart-drivedb.8.in

   1 .ig
   2 Copyright (C) 2013 Hannes von Haugwitz <hannes@vonhaugwitz.com>
   3 Copyright (C) 2014-17 Christian Franke
   4
   5 $Id: update-smart-drivedb.8.in 4584 2017-11-03 22:43:32Z chrfranke $
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 You should have received a copy of the GNU General Public License
  13 (for example COPYING); If not, see <http://www.gnu.org/licenses/>.
  14
  15 ..
  16 .\" Macros borrowed from pages generated with Pod::Man
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Use groff extension \(aq (apostrophe quote, ASCII 0x27) if possible
  27 .ie \n(.g .ds Aq \(aq
  28 .el       .ds Aq '
  29 .TH UPDATE-SMART-DRIVEDB 8 "CURRENT_SVN_DATE" "CURRENT_SVN_VERSION" "SMART Monitoring Tools"
  30 .SH NAME
  31 update-smart-drivedb \- update smartmontools drive database
  32 .Sp
  33 .SH "SYNOPSIS"
  34 .B update-smart-drivedb
  35 .RI [ OPTIONS ]
  36 .RI [ DESTFILE ]
  37 .Sp
  38 .SH "DESCRIPTION"
  39 .\" %IF NOT OS ALL
  40 .\"! [This man page is generated for the OS_MAN_FILTER version of smartmontools.
  41 .\"! It does not contain info specific to other platforms.]
  42 .\"! .PP
  43 .\" %ENDIF NOT OS ALL
  44 .B update-smart-drivedb
  45 updates
  46 .B /usr/local/share/smartmontools/drivedb.h
  47 or
  48 .I DESTFILE
  49 from branches/RELEASE_6_0_DRIVEDB of smartmontools SVN repository.
  50 .PP
  51 The tools used for downloading are either
  52 .BR curl (1),
  53 .BR wget (1),
  54 .BR lynx (1),
  55 .\" %IF OS FreeBSD
  56 .BR fetch (1)
  57 [FreeBSD only],
  58 .\" %ENDIF OS FreeBSD
  59 .\" %IF OS OpenBSD
  60 .BR ftp (1)
  61 [OpenBSD only],
  62 .\" %ENDIF OS OpenBSD
  63 or
  64 .BR svn (1).
  65 .PP
  66 [NEW EXPERIMENTAL UPDATE-SMART-DRIVEDB FEATURE]
  67 The downloaded file is verified with OpenPGP/GPG key ID DFD22559.
  68 The public key block is included in the script.
  69 .PP
  70 The old file is kept if the downloaded file is identical (ignoring
  71 the differences in Id string) otherwise it is moved to
  72 .BR drivedb.h.old .
  73 .Sp
  74 .SH "OPTIONS"
  75 .TP
  76 .B \-s SMARTCTL
  77 Use the
  78 .BR smartctl (8)
  79 executable at path SMARTCTL for drive database syntax check.
  80 The form \*(Aq\-s \-\*(Aq disables the syntax check.
  81 The default is
  82 .BR /usr/local/sbin/smartctl .
  83 .TP
  84 .B \-t TOOL
  85 Use TOOL for download.
  86 TOOL is one of:
  87 .I curl wget lynx
  88 .\" %IF OS FreeBSD
  89 .I fetch
  90 .\" %ENDIF OS FreeBSD
  91 .\" %IF OS OpenBSD
  92 .I ftp
  93 .\" %ENDIF OS OpenBSD
  94 .IR svn .
  95 The default is the first one found in PATH.
  96 .TP
  97 .B \-u LOCATION
  98 Use URL of LOCATION for download.
  99 LOCATION is one of:
 100 .br
 101 .I sf
 102 (Sourceforge code browser via HTTPS),
 103 .br
 104 .I svn
 105 (SVN repository via HTTPS),
 106 .br
 107 .I svni
 108 (SVN repository via HTTP),
 109 .br
 110 .I trac
 111 (Trac code browser via HTTPS).
 112 .br
 113 The default is
 114 .IR svn .
 115 .TP
 116 .B \-\-trunk
 117 Download from SVN trunk.
 118 This requires \*(Aq\-\-no\-verify\*(Aq unless the trunk version is still
 119 identical to branches/RELEASE_6_0_DRIVEDB.
 120 .TP
 121 .B \-\-cacert FILE
 122 Use CA certificates from FILE to verify the peer.
 123 .TP
 124 .B \-\-capath DIR
 125 Use CA certificate files from DIR to verify the peer.
 126 .TP
 127 .B \-\-insecure
 128 Don't abort download if certificate verification fails.
 129 This option is also required if a HTTP URL is selected with \*(Aq\-u\*(Aq
 130 option.
 131 .TP
 132 .B \-\-no\-verify
 133 Don't verify signature with GnuPG.
 134 .TP
 135 .B \-\-export\-key
 136 Print the OpenPGP/GPG public key block.
 137 .TP
 138 .B \-\-dryrun
 139 Print download commands only.
 140 .TP
 141 .B \-v
 142 Verbose output.
 143 .Sp
 144 .SH "EXAMPLES"
 145 .Vb 2
 146 # update-smart-drivedb
 147 /usr/local/share/smartmontools/drivedb.h updated from \e
 148 branches/RELEASE_6_0_DRIVEDB
 149 .Ve
 150 .Sp
 151 .SH "EXIT STATUS"
 152 The exit status is 0 if the database has been successfully
 153 updated.
 154 If an error occurs the exit status is 1.
 155 .Sp
 156 .SH FILES
 157 .TP
 158 .B /usr/local/sbin/update-smart-drivedb
 159 full path of this script.
 160 .TP
 161 .B /usr/local/sbin/smartctl
 162 used to check syntax of new drive database.
 163 .TP
 164 .B /usr/local/share/smartmontools/drivedb.h
 165 current drive database.
 166 .TP
 167 .B /usr/local/share/smartmontools/drivedb.h.raw
 168 current drive database with unexpanded SVN Id string.
 169 .TP
 170 .B /usr/local/share/smartmontools/drivedb.h.raw.asc
 171 signature file.
 172 .TP
 173 .B /usr/local/share/smartmontools/drivedb.h.*old*
 174 previous files.
 175 .TP
 176 .B /usr/local/share/smartmontools/drivedb.h.*error*
 177 new files if rejected due to errors.
 178 .TP
 179 .B /usr/local/share/smartmontools/drivedb.h.lastcheck
 180 empty file created if downloaded file was identical.
 181 .Sp
 182 .SH AUTHORS
 183 \fBChristian Franke\fP.
 184 .br
 185 This manual page was originally written by
 186 .BR "Hannes von Haugwitz <hannes@vonhaugwitz.com>" .
 187 .Sp
 188 .SH REPORTING BUGS
 189 To submit a bug report, create a ticket in smartmontools wiki:
 190 .br
 191 <\fBhttps://www.smartmontools.org/\fP>.
 192 .br
 193 Alternatively send the info to the smartmontools support mailing list:
 194 .br
 195 <\fBhttps://listi.jpberlin.de/mailman/listinfo/smartmontools-support\fB>.
 196 .Sp
 197 .SH SEE ALSO
 198 \fBsmartctl\fP(8), \fBsmartd\fP(8).
 199 .Sp
 200 .SH PACKAGE VERSION
 201 CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
 202 .br
 203 $Id: update-smart-drivedb.8.in 4584 2017-11-03 22:43:32Z chrfranke $