X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famdevcheck.8;h=95d6c14c0515c6278e85e35876881af48889bcc4;hb=fd48f3e498442f0cbff5f3606c7c403d0566150e;hp=452c4450d383ad1a6dce9ea274fce11bb7302d04;hpb=2627875b7d18858bc1f9f7652811e4d8c15a23eb;p=debian%2Famanda diff --git a/man/amdevcheck.8 b/man/amdevcheck.8 index 452c445..95d6c14 100644 --- a/man/amdevcheck.8 +++ b/man/amdevcheck.8 @@ -1,161 +1,13 @@ +'\" t .\" Title: amdevcheck .\" Author: Ian Turner -.\" Generator: DocBook XSL Stylesheets v1.74.0 -.\" Date: 01/22/2009 +.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 +.\" Date: 06/01/2010 .\" Manual: System Administration Commands -.\" Source: Amanda 2.6.1 +.\" Source: Amanda 3.1.0 .\" Language: English .\" -.TH "AMDEVCHECK" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands" -.\" ----------------------------------------------------------------- -.\" * (re)Define some macros -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" toupper - uppercase a string (locale-aware) -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de toupper -.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ -\\$* -.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH-xref - format a cross-reference to an SH section -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de SH-xref -.ie n \{\ -.\} -.toupper \\$* -.el \{\ -\\$* -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH - level-one heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SH -.\" put an extra blank line of space above the head in non-TTY output -.if t \{\ -.sp 1 -.\} -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[an-margin]u -.ti 0 -.HTML-TAG ".NH \\n[an-level]" -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -\." make the size of the head bigger -.ps +3 -.ft B -.ne (2v + 1u) -.ie n \{\ -.\" if n (TTY output), use uppercase -.toupper \\$* -.\} -.el \{\ -.nr an-break-flag 0 -.\" if not n (not TTY), use normal case (not uppercase) -\\$1 -.in \\n[an-margin]u -.ti 0 -.\" if not n (not TTY), put a border/line under subheading -.sp -.6 -\l'\n(.lu' -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SS - level-two heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SS -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[IN]u -.ti \\n[SN]u -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.ps \\n[PS-SS]u -\." make the size of the head bigger -.ps +2 -.ft B -.ne (2v + 1u) -.if \\n[.$] \&\\$* -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BB/BE - put background/screen (filled box) around block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BB -.if t \{\ -.sp -.5 -.br -.in +2n -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EB -.if t \{\ -.if "\\$2"adjust-for-leading-newline" \{\ -.sp -1 -.\} -.br -.di -.in -.ll -.gcolor -.nr BW \\n(.lu-\\n(.i -.nr BH \\n(dn+.5v -.ne \\n(BHu+.5v -.ie "\\$2"adjust-for-leading-newline" \{\ -\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.el \{\ -\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.in 0 -.sp -.5v -.nf -.BX -.in -.sp .5v -.fi -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BM/EM - put colored marker in margin next to block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BM -.if t \{\ -.br -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EM -.if t \{\ -.br -.di -.ll -.gcolor -.nr BH \\n(dn -.ne \\n(BHu -\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] -.in 0 -.nf -.BX -.in -.fi -.\} -.. +.TH "AMDEVCHECK" "8" "06/01/2010" "Amanda 3\&.1\&.0" "System Administration Commands" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -166,55 +18,62 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- -.SH "Name" -amdevcheck \- Validate an \fIAmanda\fR device and volume\&. -.SH "Synopsis" -.fam C +.SH "NAME" +amdevcheck \- Validate an Amanda device and volume\&. +.SH "SYNOPSIS" .HP \w'\fBamdevcheck\fR\ 'u -\fBamdevcheck\fR \fIconfig\fR [\fIdevice\ name\fR] [\-o\ \fIconfigoption\fR]... -.fam +\fBamdevcheck\fR \fIconfig\fR [\fIdevice\-name\fR] [\-\-label] [\-properties\ \fIlist\fR] [{\fB\-o\fR\ \fIconfigoption\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\'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\&. Optionally this tools lists the properties for the device\&. .PP See the \fBamanda\fR(8) -man page for more details about -\fIAmanda\fR\&. See +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\&. .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 +Get the device\'s 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 \'=\', 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" -\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 +\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 @@ -252,13 +111,14 @@ 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 -.SH "Author" +\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\&. (\FChttp://www\&.zmanda\&.com\F[]) +Zmanda, Inc\&. (http://www\&.zmanda\&.com) .RE