update-smart-drivedb.8.in

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