Imported Upstream version 2.6.1p1
[debian/amanda] / man / amdevcheck.8
index a0602e29cc867ac3090641016bef00c4f59f1a86..28f207f80c6616d2ebe221fe9583294d7bcb643b 100644 (file)
@@ -1,19 +1,27 @@
+'\" t
 .\"     Title: amdevcheck
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 05/14/2008
-.\"    Manual: 
-.\"    Source: 
+.\"    Author: Ian Turner <ian@zmanda.com>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 04/10/2009
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 2.6.1p1
+.\"  Language: English
 .\"
-.TH "AMDEVCHECK" "8" "05/14/2008" "" ""
+.TH "AMDEVCHECK" "8" "04/10/2009" "Amanda 2\&.6\&.1p1" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * 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 \fIAmanda\fR device and volume\&.
 .SH "SYNOPSIS"
-.HP 11
+.HP \w'\fBamdevcheck\fR\ 'u
 \fBamdevcheck\fR \fIconfig\fR [\fIdevice\ name\fR] [\-o\ \fIconfigoption\fR]...
 .SH "DESCRIPTION"
 .PP
@@ -21,49 +29,86 @@ amdevcheck - Validate an Amanda device and volume.
 \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\.
+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\&.
 .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\.
+\fIAmanda\fR\&. See
+\fBamanda-devices\fR(7)
+for more information on devices\&.
 .SH "OPTIONS"
 .PP
 \fIconfig\fR
 .RS 4
 
 \fIAmanda\fR
-configuration to use\. Note that
+configuration to use\&. Note that
 \fBamdevcheck\fR
-ignores any tape changer configuration\.
+ignores any tape changer configuration\&.
 .RE
 .PP
 \fI device\fR
 .RS 4
 
 \fIAmanda\fR
-device to use\. This option overrides any tapedev configuration specified in the configuration file\.
+device to use\&. This option overrides any tapedev configuration specified in the configuration file\&.
 .RE
 .PP
 \fB\-o\fR \fIclientconfigoption\fR
 .RS 4
 See the "\fBCONFIGURATION OVERRIDE\fR" section in
-\fBamanda\fR(8)\.
+\fBamanda\fR(8)\&.
+.RE
+.SH "OUTPUT"
+\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
+.PP
+\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
-.SH "AUTHOR"
 .PP
-Ian Turner
-<ian@zmanda\.com>
-and others\. Authorship of this tool and its documentation was funded by Zmanda, Inc\.
+\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),
-\fI\%http://wiki.zmanda.com\fR
+: http://wiki.zmanda.com
+.SH "AUTHOR"
+.PP
+\fBIan Turner\fR <\&ian@zmanda\&.com\&>
+.RS 4
+Zmanda, Inc\&. (http://www\&.zmanda\&.com)
+.RE