X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famgetconf.8;h=c23972b58a0ac86a807398d67f28e6501664779d;hb=refs%2Fheads%2Fmaster;hp=07e7524c4ec7b7607aec29b152e0e9888198f55c;hpb=afaa71b3866b46b082b6c895772e15b36d8865fe;p=debian%2Famanda diff --git a/man/amgetconf.8 b/man/amgetconf.8 index 07e7524..c23972b 100644 --- a/man/amgetconf.8 +++ b/man/amgetconf.8 @@ -1,161 +1,22 @@ +'\" t .\" Title: amgetconf .\" Author: Jean-Louis Martineau -.\" Generator: DocBook XSL Stylesheets v1.74.0 -.\" Date: 01/22/2009 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 01/10/2013 .\" Manual: System Administration Commands -.\" Source: Amanda 2.6.1 +.\" Source: Amanda 3.3.3 .\" Language: English .\" -.TH "AMGETCONF" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands" +.TH "AMGETCONF" "8" "01/10/2013" "Amanda 3\&.3\&.3" "System Administration Commands" .\" ----------------------------------------------------------------- -.\" * (re)Define some macros +.\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" toupper - uppercase a string (locale-aware) +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.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 -.\} -.. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -166,13 +27,11 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- -.SH "Name" +.SH "NAME" amgetconf \- look up configuration parameters and manipulate debug logs -.SH "Synopsis" -.fam C +.SH "SYNOPSIS" .HP \w'\fBamgetconf\fR\ 'u -\fBamgetconf\fR [\fI\-l|\-\-list\fR] [\-o\ \fIconfigoption\fR]... [\fI\-\-client\fR] [\fI\-\-execute\-where\ client|server\fR] [\fIconfig\fR] \fIparameter\fR -.fam +\fBamgetconf\fR [\fI\-l|\-\-list\fR] [\fI\-\-client\fR] [\fI\-\-execute\-where\ client|server\fR] [\fB\-o\fR\ \fIconfigoption\fR...] [\fIconfig\fR] \fIparameter\fR .SH "DESCRIPTION" .PP \fBAmgetconf\fR @@ -187,13 +46,13 @@ assumes it is being run from the configuration directory and that \fIamanda\&.conf\fR is present\&. The order of options and arguments does not matter\&. \fIparameter\fR -is always case\-insensitive, and \'\-\' and \'_\' are treated as identical, just as in +is always case\-insensitive, and \*(Aq\-\*(Aq and \*(Aq_\*(Aq are treated as identical, just as in \fBamanda.conf\fR(5)\&. .PP See the "\fBCONFIGURATION OVERRIDE\fR" section in \fBamanda\fR(8) for information on the -\FC\-o\F[] +\-o option\&. .SS "AMANDA CONFIGURATION" .PP @@ -203,146 +62,144 @@ is a configuration keyword (from \fBamanda.conf\fR(5)), then amgetconf will return the corresponding value\&. For keywords which can take multiple values, amgetconf will return all values, one on each line\&. .PP Values in configuration subsections are specified with parameters of the form -\FCTYPE:NAME:PARAMETER\F[], where -\FCTYPE\F[] +TYPE:NAME:PARAMETER, where +TYPE is the subsection type (one of -\FCdumptype\F[], -\FCtapetype\F[], -\FCinterface\F[], -\FCholdingdisk\F[], -\FCapplication\-tool\F[], or -\FCscript\-tool\F[]; -\FCNAME\F[] +dumptype, +tapetype, +interface, +holdingdisk, +application\-tool, or +script\-tool; +NAME is the name of the subsection (e\&.g\&., -\FCuser\-tar\F[]), and -\FCPARAMETER\F[] +user\-tar), and +PARAMETER is the name of the disired parameter within that subsection\&. .PP The -\FC\-\-list\F[] +\-\-list option lists the subsections of a certain type, where the type is givein as the parameter\&. .PP The -\FC\-\-client\F[] +\-\-client option is equivalent to -\FC\-\-execute\-where server\F[] +\-\-execute\-where server (below)\&. .PP The -\FC\-\-execute\-where\F[] +\-\-execute\-where option tells amgetconf whether to operate on the client or the server; the server is the default\&. .SS "BUILD CONFIGURATION" .PP If \fIparameter\fR begins with -\FCbuild\&.\F[], then the following name is a build environment variable\&. Variables without a value (e\&.g\&. -\FCXFSDUMP\F[] +build\&., then the following name is a build environment variable\&. Variables without a value (e\&.g\&. +XFSDUMP on a system that does not support that type of file system) will not report an error and will return an empty string as the value\&. Some boolean variables (e\&.g\&. \fIUSE_AMANDAHOSTS\fR) will return -\FC1\F[] +1 if the flag is set or an empty string if it is not, while others return -\FCyes\F[] +yes or -\FCno\F[], as indicated below (the difference is historical)\&. +no, as indicated below (the difference is historical)\&. .PP Combining the -\FC\-\-list\F[] +\-\-list option with the parameter -\FCbuild\F[] +build will enumerate all available build parameters\&. .PP \fBBuild Parameters\fR .PP -\FCbindir\F[], \FCsbindir\F[], \FClibexecdir\F[], \FCmandir\F[] +bindir, sbindir, libexecdir, mandir .RS 4 Install directories .RE .PP -\FCAMANDA_TMPDIR\F[], \FCCONFIG_DIR\F[], \FCAMANDA_DBGDIR\F[], \FCGNUTAR_LISTED_INCREMENTAL_DIR\F[] +AMANDA_TMPDIR, CONFIG_DIR, AMANDA_DBGDIR, GNUTAR_LISTED_INCREMENTAL_DIR .RS 4 Runtime directories .RE .PP -\FClisted_inc_dir\F[] +listed_inc_dir .RS 4 Same as -\FCGNUTAR_LISTED_INCREMENTAL_DIR\F[] +GNUTAR_LISTED_INCREMENTAL_DIR .RE .PP -\FCCC\F[], \FCVERSION\F[], \FCASSERTIONS\F[], \FCLOCKING\F[], \FCUSE_VERSION_SUFFIXES\F[] +CC, VERSION, ASSERTIONS, LOCKING .RS 4 Build information\&. -\FCASSERTIONS\F[] -is 1 or empty, while -\FCUSE_VERSION_SUFFIXES\F[] -is yes/no\&. +ASSERTIONS +is 1 or empty\&. .RE .PP -\FCDUMP\F[], \FCRESTORE\F[], \FCVDUMP\F[], \FCVRESTORE\F[], \FCXFSDUMP\F[], \FCXFSRESTORE\F[], \FCVXDUMP\F[], \FCVXRESTORE\F[], \FCSAMBA_CLIENT\F[], \FCGNUTAR\F[], \FCSTAR\F[], \FCCOMPRESS_PATH\F[], \FCUNCOMPRESS_PATH\F[] +DUMP, RESTORE, VDUMP, VRESTORE, XFSDUMP, XFSRESTORE, VXDUMP, VXRESTORE, SAMBA_CLIENT, GNUTAR, STAR, COMPRESS_PATH, UNCOMPRESS_PATH .RS 4 Paths to various utility progarms (empty if they are not found or not used) .RE .PP -\FCAIX_BACKUP\F[] +AIX_BACKUP .RS 4 Is -\FCDUMP\F[] +DUMP the AIX backup program? (empty or 1) .RE .PP -\FCDUMP_RETURNS_1\F[] +DUMP_RETURNS_1 .RS 4 Does -\FCDUMP\F[] +DUMP return 1 on success? (empty or 1) .RE .PP -\FCBSD_SECURITY\F[], \FCBSDUDP_SECURITY\F[], \FCBSDTCP_SECURITY\F[], \FCKRB4_SECURITY\F[], \FCKRB5_SECURITY\F[], \FCSSH_SECURITY\F[], \FCRSH_SECURITY\F[] +BSD_SECURITY, BSDUDP_SECURITY, BSDTCP_SECURITY, KRB5_SECURITY, SSH_SECURITY, RSH_SECURITY .RS 4 Indicate which authentication mechanisms are available (yes or no)\&. .RE .PP -\FCUSE_AMANDAHOSTS\F[] +USE_AMANDAHOSTS .RS 4 Should the "bsd" authentication mechanism use -\FCamandahosts\F[]? (yes or no)\&. +amandahosts? (yes or no)\&. .RE .PP -\FCAMANDA_DEBUG_DAYS\F[] +AMANDA_DEBUG_DAYS .RS 4 Number of days after which debug logs are deleted\&. .RE .PP -\FCDEFAULT_SERVER\F[], \FCDEFAULT_CONFIG\F[], \FCDEFAULT_TAPE_SERVER\F[], \FCDEFAULT_TAPE_DEVICE\F[] +DEFAULT_SERVER, DEFAULT_CONFIG, DEFAULT_TAPE_SERVER, DEFAULT_TAPE_DEVICE .RS 4 Default values for configuration parameters .RE .PP -\FCCLIENT_LOGIN\F[] +CLIENT_LOGIN .RS 4 Userid under which the client runs (from -\FC\-\-with\-user\F[])\&. +\-\-with\-user)\&. .RE .PP -\FCUSE_RUNDUMP\F[] +USE_RUNDUMP .RS 4 Should Amanda use the -\FCrundump\F[] +rundump wrapper? (empty or 1) .RE .PP -\FCCHECK_USERID\F[] +CHECK_USERID .RS 4 Does Amanda check that userids are correct? (empty or 1) .RE .PP -\FCCOMPRESS_SUFFIX\F[], \FCCOMPRESS_FAST_OPT\F[], \FCCOMPRESS_BEST_OPT\F[], \FCUNCOMPRESS_OPT\F[] +COMPRESS_SUFFIX, COMPRESS_FAST_OPT, COMPRESS_BEST_OPT, UNCOMPRESS_OPT .RS 4 Command\-line options for the compression program\&. .RE .PP -\FCTICKET_LIFETIME\F[], \FCSERVER_HOST_PRINCIPAL\F[], \FCSERVER_HOST_INSTANCE\F[], \FCSERVER_HOST_KEY_FILE\F[], \FCCLIENT_HOST_PRINCIPAL\F[], \FCCLIENT_HOST_INSTANCE\F[], \FCCLIENT_HOST_KEY_FILE\F[] +TICKET_LIFETIME, SERVER_HOST_PRINCIPAL, SERVER_HOST_INSTANCE, SERVER_HOST_KEY_FILE, CLIENT_HOST_PRINCIPAL, CLIENT_HOST_INSTANCE, CLIENT_HOST_KEY_FILE .RS 4 Kerberos parameters\&. .RE @@ -351,7 +208,6 @@ Kerberos parameters\&. .sp .\} .RS 4 -.BM yellow .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 @@ -361,16 +217,14 @@ Kerberos parameters\&. .ps -1 .br That this application is responsible for debug logs is a -historical quirk, but the functionality is widely used\&..sp .5v -.EM yellow +historical quirk, but the functionality is widely used\&. +.sp .5v .RE .PP If \fIparameter\fR begins with -\fIdbopen\&.\fR, the string following the period is a program name and an -\fIAmanda\fR -debug file will be created for the caller\&. The name of the logfile is returned\&. +\fIdbopen\&.\fR, the string following the period is a program name and an Amanda debug file will be created for the caller\&. The name of the logfile is returned\&. .PP If \fIparameter\fR @@ -391,7 +245,7 @@ Find out the current tape type: DLT4000\-IV .fi .PP -Find out that tape type\'s length: +Find out that tape type\*(Aqs length: .nf % amgetconf daily tapetype:DLT4000\-IV:length 1024000 @@ -439,12 +293,15 @@ keyword)\&. .RE .SH "SEE ALSO" .PP - \fBamanda\fR(8), -: http://wiki.zmanda.com -.SH "Author" +\fBamanda.conf\fR(5), +\fBamanda-client.conf\fR(5) +.PP +The Amanda Wiki: +: http://wiki.zmanda.com/ +.SH "AUTHOR" .PP \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&> .RS 4 -Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[]) +Zmanda, Inc\&. (http://www\&.zmanda\&.com) .RE