X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famdevcheck.8.xml;h=6232e5aac3ad4cffd0ee6bafd5bab95241ca5410;hb=cb38d19aa8dc2c5d380ab2d7ad9724a5d99eee5d;hp=d4ca82df9e7c4e79a6aa47330b04b23f5585978e;hpb=a6127998ee6dcab6bb034f6ca985b07804a86f9a;p=debian%2Famanda diff --git a/man/xml-source/amdevcheck.8.xml b/man/xml-source/amdevcheck.8.xml index d4ca82d..6232e5a 100644 --- a/man/xml-source/amdevcheck.8.xml +++ b/man/xml-source/amdevcheck.8.xml @@ -3,7 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ - + %global_entities; ]> @@ -12,42 +12,51 @@ amdevcheck 8 + &rmi.source; + &rmi.version; + &rmi.manual.8; amdevcheck - Validate an &A; device and volume. + Validate an Amanda device and volume. + + &author.ian; + amdevcheck + + --label + + + -properties list + + &configoverride.synopsis; config - device name + device-name - -o - configoption DESCRIPTION Amdevcheck provides a way to check that a - particular &A; device is accessible, whether or not it contains a volume, + 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. + reports all possible causes of the error. Optionally this tools lists the + properties for the device. - + See the - amanda8 - man page for more details about &A;. - See the - OUTPUT DRIVERS - section of - amanda(8) - for more information on the &A; output drivers. + + man page for more details about Amanda. See + + for more information on devices. @@ -57,45 +66,97 @@ config - &A; configuration to use. Note that amdevcheck + Amanda configuration to use. Note that amdevcheck ignores any tape changer configuration. - device + device - &A; device to use. This option overrides any tapedev configuration + Amanda device to use. This option overrides any tapedev configuration specified in the configuration file. - -o clientconfigoption + --label - See the "CONFIGURATION OVERRIDE" - section in - amanda8. + + 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. + + + + --properties [list] + + + 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. + + + If list is given, it is treated as a + comma-separated list of properties to display. If it is omitted, + all supported properties are displayed. + + + + + &configoverride.varlistentry; + - AUTHOR - - Ian Turner ian@zmanda.com and others. Authorship of this - tool and its documentation was funded by Zmanda, Inc. - + OUTPUT + amdevcheck 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. + Amdevcheck 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. + + + + SUCCESS + A tape is ready. + + + DEVICE_ERROR + A device error has occurred. + + + DEVICE_BUSY + The device is busy. + + + VOLUME_MISSING + No tape is loaded in the drive. + + + VOLUME_UNLABELED + The tape in the drive is unlabeled. + + + VOLUME_ERROR + A volume error has occurred. + + + MESSAGE text + Where text provides a human-readable description of the problem. + + - SEE ALSO - - amanda8, - ammt8, - - - + + + +