X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famdevcheck.8;h=30797f0b674431e77545e28e9b06c5f8ff50cec9;hb=HEAD;hp=a9b403ecbcf2a043abfb9568464585b02f500848;hpb=fb2bd066c2f8b34addafe48d62550e3033a59431;p=debian%2Famanda
diff --git a/man/amdevcheck.8 b/man/amdevcheck.8
index a9b403e..30797f0 100644
--- a/man/amdevcheck.8
+++ b/man/amdevcheck.8
@@ -1,69 +1,133 @@
+'\" t
.\" Title: amdevcheck
-.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.73.2
-.\" Date: 08/22/2008
-.\" Manual:
-.\" Source:
+.\" Author: Ian Turner
+.\" Generator: DocBook XSL Stylesheets v1.76.1
+.\" Date: 01/10/2013
+.\" Manual: System Administration Commands
+.\" Source: Amanda 3.3.3
+.\" Language: English
.\"
-.TH "AMDEVCHECK" "8" "08/22/2008" "" ""
+.TH "AMDEVCHECK" "8" "01/10/2013" "Amanda 3\&.3\&.3" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-amdevcheck - Validate an Amanda device and volume.
+amdevcheck \- Validate an Amanda device and volume\&.
.SH "SYNOPSIS"
-.HP 11
-\fBamdevcheck\fR \fIconfig\fR [\fIdevice\ name\fR] [\-o\ \fIconfigoption\fR]...
+.HP \w'\fBamdevcheck\fR\ 'u
+\fBamdevcheck\fR [\-\-label] [\-properties\ \fIlist\fR] [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR [\fIdevice\-name\fR]
.SH "DESCRIPTION"
.PP
\fBAmdevcheck\fR
-provides a way to check that a particular
-\fIAmanda\fR
-device is accessible, whether or not it contains a volume, and whether or not that volume is labeled\. Some devices can\'t distinguish between all of these cases; a missing volume and an unlabeled volume might generate the same error code, for example\. In those cases, this tool reports all possible causes of the error\.
+provides a way to check that a particular Amanda device is accessible, whether or not it contains a volume, and whether or not that volume is labeled\&. Some devices can\*(Aqt distinguish between all of these cases; a missing volume and an unlabeled volume might generate the same error code, for example\&. In those cases, this tool reports all possible causes of the error\&. Optionally this tools lists the properties for the device\&.
.PP
See the
\fBamanda\fR(8)
-man page for more details about
-\fIAmanda\fR\. See the
-\fBOUTPUT DRIVERS\fR
-section of
-\fIamanda(8)\fR
-for more information on the
-\fIAmanda\fR
-output drivers\.
+man page for more details about Amanda\&. See
+\fBamanda-devices\fR(7)
+for more information on devices\&.
.SH "OPTIONS"
.PP
\fIconfig\fR
.RS 4
-
-\fIAmanda\fR
-configuration to use\. Note that
+Amanda configuration to use\&. Note that
\fBamdevcheck\fR
-ignores any tape changer configuration\.
+ignores any tape changer configuration\&.
.RE
.PP
-\fI device\fR
+\fIdevice\fR
.RS 4
-
-\fIAmanda\fR
-device to use\. This option overrides any tapedev configuration specified in the configuration file\.
+Amanda device to use\&. This option overrides any tapedev configuration specified in the configuration file\&.
.RE
.PP
-\fB\-o\fR \fIclientconfigoption\fR
+\fI\-\-label\fR
.RS 4
-See the "\fBCONFIGURATION OVERRIDE\fR" section in
-\fBamanda\fR(8)\.
+Get the device\*(Aqs label\&. If this option is given, the usual check output is omitted, and the label of the loaded volume is printed to stdout\&. Returns with error if the label is not found\&.
+.RE
+.PP
+\fI\-\-properties [list]\fR
+.RS 4
+List device properties\&. If this option is given, the usual check output is omitted, and property values are printed to stdout, one per line, as a property name, followed by \*(Aq=\*(Aq, followed by the property value\&. Returns with error if properties are not available\&.
+.sp
+If
+\fIlist\fR
+is given, it is treated as a comma\-separated list of properties to display\&. If it is omitted, all supported properties are displayed\&.
+.RE
+.PP
+\fB\-o \fR\fB\fIconfigoption\fR\fR
+.RS 4
+See the "CONFIGURATION OVERRIDE" section in
+\fBamanda\fR(8)\&.
+.RE
+.SH "OUTPUT"
+.PP
+\fBamdevcheck\fR
+exit with code 0 if the device is working of if it get an expected error, look at the MESSAGE line for the error\&. It exit with code 1 if it get an unexpected error\&.
+.PP
+\fBAmdevcheck\fR
+returns one or more of the following lines\&. If multiple lines appear, then at least one, but not necessarily all of the messages apply\&. This situation can occur when working with hardware or operating systems which cannot distinguish, for example, between a malfunctioning drive and a functional but unloaded drive\&.
+.PP
+\fBSUCCESS\fR
+.RS 4
+A tape is ready\&.
.RE
-.SH "AUTHOR"
.PP
-Ian Turner
-
-and others\. Authorship of this tool and its documentation was funded by Zmanda, Inc\.
+\fBDEVICE_ERROR\fR
+.RS 4
+A device error has occurred\&.
+.RE
+.PP
+\fBDEVICE_BUSY\fR
+.RS 4
+The device is busy\&.
+.RE
+.PP
+\fBVOLUME_MISSING\fR
+.RS 4
+No tape is loaded in the drive\&.
+.RE
+.PP
+\fBVOLUME_UNLABELED\fR
+.RS 4
+The tape in the drive is unlabeled\&.
+.RE
+.PP
+\fBVOLUME_ERROR\fR
+.RS 4
+A volume error has occurred\&.
+.RE
+.PP
+\fBMESSAGE\fR \fItext\fR
+.RS 4
+Where text provides a human\-readable description of the problem\&.
+.RE
.SH "SEE ALSO"
.PP
-
\fBamanda\fR(8),
-\fBammt\fR(8),
-: http://wiki.zmanda.com
+\fBamanda-devices\fR(7)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHOR"
+.PP
+\fBIan Turner\fR <\&ian@zmanda\&.com\&>
+.RS 4
+Zmanda, Inc\&. (http://www\&.zmanda\&.com)
+.RE