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

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

$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
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 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
# 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
$Id: update-smart-drivedb.8.in 4193 2015-12-19 14:43:50Z chrfranke $
Commit	Line	Data
d2e702cf GI	1	.ig
d2e702cf GI	2	Copyright (C) 2013 Hannes von Haugwitz <hannes@vonhaugwitz.com>
6b80b4d2	3	Copyright (C) 2014-15 Christian Franke
d2e702cf	4
6b80b4d2	5	$Id: update-smart-drivedb.8.in 4193 2015-12-19 14:43:50Z chrfranke $
d2e702cf GI	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	..
293b5ab8	16	.TH UPDATE-SMART-DRIVEDB 8 "CURRENT_SVN_DATE" "CURRENT_SVN_VERSION" "SMART Monitoring Tools"
d2e702cf GI	17	.SH NAME
	18	update-smart-drivedb \- update smartmontools drive database
	19
	20	.SH "SYNOPSIS"
	21	.B update-smart-drivedb
6b80b4d2	22	.RI [ OPTIONS ]
d2e702cf GI	23	.RI [ DESTFILE ]
d2e702cf GI	24
d2e702cf	25	.SH "DESCRIPTION"
6b80b4d2 JD	26	.\" %IF NOT OS ALL
	27	.\"! [This man page is generated for the OS_MAN_FILTER version of smartmontools.
	28	.\"! It does not contain info specific to other platforms.]
	29	.\"! .PP
	30	.\" %ENDIF NOT OS ALL
d2e702cf GI	31	.B update-smart-drivedb
	32	updates
	33	.B /usr/local/share/smartmontools/drivedb.h
	34	or
	35	.I DESTFILE
	36	from smartmontools SVN repository.
	37
	38	It tries to download first from the current branch and then from
	39	trunk. The tools used for downloading are either
	40	.BR curl (1),
6b80b4d2 JD	41	.BR wget (1),
6b80b4d2 JD	42	.BR lynx (1),
d2e702cf	43	.\" %IF OS FreeBSD
d2e702cf	44	.BR fetch (1)
6b80b4d2	45	[FreeBSD only],
d2e702cf GI	46	.\" %ENDIF OS FreeBSD
d2e702cf GI	47	.\" %IF OS OpenBSD
d2e702cf	48	.BR ftp (1)
6b80b4d2	49	[OpenBSD only],
d2e702cf	50	.\" %ENDIF OS OpenBSD
6b80b4d2 JD	51	or
6b80b4d2 JD	52	.BR svn (1).
d2e702cf GI	53
	54	The old file is kept if the downloaded file is identical (ignoring
	55	the differences in Id string) otherwise it is moved to
	56	.BR drivedb.h.old .
	57
	58	.SH "OPTIONS"
	59	.TP
6b80b4d2 JD	60	.B \-s SMARTCTL
	61	Use the
	62	.BR smartctl (8)
	63	executable at path SMARTCTL for drive database syntax check.
	64	The form \'\-s \-\' disables the syntax check.
	65	The default is
	66	.BR /usr/local/sbin/smartctl .
	67	.TP
	68	.B \-t TOOL
	69	Use TOOL for download.
	70	TOOL is one of:
	71	.I curl wget lynx
	72	.\" %IF OS FreeBSD
	73	.I fetch
	74	.\" %ENDIF OS FreeBSD
	75	.\" %IF OS OpenBSD
	76	.I ftp
	77	.\" %ENDIF OS OpenBSD
	78	.IR svn .
	79	The default is the first one found in PATH.
	80	.TP
	81	.B \-u LOCATION
	82	Use URL of LOCATION for download. LOCATION is one of:
	83	.br
	84	.I sf
	85	(Sourceforge code browser via HTTP),
	86	.br
	87	.I svn
	88	(SVN repository via HTTPS),
	89	.br
	90	.I svni
	91	(SVN repository via HTTP),
	92	.br
	93	.I trac
	94	(Trac code browser via HTTPS).
	95	.br
	96	The default is
	97	.IR svn .
	98	.TP
	99	.B \-\-cacert FILE
	100	Use CA certificates from FILE to verify the peer.
	101	.TP
	102	.B \-\-capath DIR
	103	Use CA certificate files from DIR to verify the peer.
	104	.TP
	105	.B \-\-insecure
	106	Don't abort download if certificate verification fails.
	107	This option is also required if a HTTP URL is selected with \'-u\' option.
	108	.TP
	109	.B \-\-dryrun
	110	Print download commands only.
	111	.TP
	112	.B \-v
	113	Verbose output.
d2e702cf GI	114
	115	.SH "EXAMPLES"
	116	.nf
	117	# update-smart-drivedb
	118	/usr/local/share/smartmontools/drivedb.h updated from branches/RELEASE_6_0_DRIVEDB
	119	.fi
	120
	121	.SH "EXIT STATUS"
	122	The exit status is 0 if the database has been successfully
	123	updated. If an error occurs the exit status is 1.
	124
	125	.SH FILES
	126	.TP
	127	.B /usr/local/sbin/update-smart-drivedb
	128	full path of this script.
	129	.TP
	130	.B /usr/local/sbin/smartctl
	131	used to check syntax of new drive database.
	132	.TP
	133	.B /usr/local/share/smartmontools/drivedb.h
	134	current drive database.
	135	.TP
	136	.B /usr/local/share/smartmontools/drivedb.h.old
	137	previous drive database.
	138	.TP
	139	.B /usr/local/share/smartmontools/drivedb.h.error
6b80b4d2	140	new drive database if rejected due to syntax errors.
d2e702cf GI	141	.TP
	142	.B /usr/local/share/smartmontools/drivedb.h.lastcheck
	143	empty file created if downloaded file was identical.
	144
d2e702cf	145	.SH AUTHORS
293b5ab8	146	\fBChristian Franke\fP.
d2e702cf GI	147	.br
	148	This manual page was originally written by
	149	.BR "Hannes von Haugwitz <hannes@vonhaugwitz.com>" .
	150
293b5ab8 JD	151	.SH REPORTING BUGS
	152	To submit a bug report, create a ticket in smartmontools wiki:
	153	.br
	154	<\fBhttp://www.smartmontools.org/\fP>.
	155	.br
	156	Alternatively send the info to the smartmontools support mailing list:
	157	.br
	158	<\fBhttps://lists.sourceforge.net/lists/listinfo/smartmontools-support\fB>.
	159
	160	.SH SEE ALSO
	161	\fBsmartctl\fP(8), \fBsmartd\fP(8).
	162
	163	.SH PACKAGE VERSION
	164	CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
	165	.br
6b80b4d2	166	$Id: update-smart-drivedb.8.in 4193 2015-12-19 14:43:50Z chrfranke $