fix for #693333, hard-coding of amandabackup as user in many scripts and docs
[debian/amanda] / man / amgpgcrypt.8
index 94c993c8a9bc2021c53b3475d312a025daa0b03c..3ea03b2670375716b7b7e012dc0bfd8cc547f8cf 100644 (file)
+'\" t
 .\"     Title: amgpgcrypt
 .\"    Author: Kevin Till <kevin.till@zmanda.com>
-.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
-.\"      Date: 01/22/2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 07/25/2012
 .\"    Manual: System Administration Commands
-.\"    Source: Amanda 2.6.1
+.\"    Source: Amanda 3.3.2
 .\"  Language: English
 .\"
-.TH "AMGPGCRYPT" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
+.TH "AMGPGCRYPT" "8" "07/25/2012" "Amanda 3\&.3\&.2" "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
 .\" -----------------------------------------------------------------
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
-.SH "Name"
-amgpgcrypt \- reference crypt program for \fIAmanda\fR public\-key data encryption
-.SH "Synopsis"
-.fam C
+.SH "NAME"
+amgpgcrypt \- reference crypt program for Amanda public\-key data encryption
+.SH "SYNOPSIS"
 .HP \w'\fBamgpgcrypt\fR\ 'u
-\fBamgpgcrypt\fR  to be called by \fIAmanda\fR only 
-.fam
+\fBamgpgcrypt\fR  to be called by Amanda only 
 .SH "DESCRIPTION"
 .PP
 
 \fBamgpgcrypt\fR
 calls
 \fBgpg\fR
-to perform public\-key data encryption on
-\fIAmanda\fR
-backup\&.
+to perform public\-key data encryption on Amanda backup\&.
 \fBamgpgcrypt\fR
 will search for the gpg program in the following directories: /usr/local/bin:/usr/bin:/usr/sbin:/bin:/sbin
 .PP
@@ -189,23 +46,17 @@ will search for the gpg program in the following directories: /usr/local/bin:/us
 \fBamgpgcrypt\fR
 sets GNUPGHOME to $AMANDA_HOME/\&.gnupg where gpg will look for the gpg keys\&.
 \fBamgpgcrypt\fR
-uses the public key to encrypt the
-\fIAmanda\fR
-data and uses the private key to decrypt the
-\fIAmanda\fR
-backup data\&. Thus, passphrase is only required at the time of data restore\&.
-.SH "Key and Passphrase"
+uses the public key to encrypt the Amanda data and uses the private key to decrypt the Amanda backup data\&. Thus, passphrase is only required at the time of data restore\&.
+.SH "KEY AND PASSPHRASE"
 .PP
 
 \fBamgpgcrypt\fR
-uses the private key to decrypt
-\fIAmanda\fR
-backup data\&.
+uses the private key to decrypt Amanda backup data\&.
 
 It is very important to store, manage and  protect the key and the passphrase
 properly\&. Encrypted backup data can \fBonly\fR be recovered with the correct key and
 passphrase\&.
-.SH "How to create encryption keys and Passphrase for amgpgcrypt"
+.SH "HOW TO CREATE ENCRYPTION KEYS AND PASSPHRASE FOR AMGPGCRYPT"
 .PP
 Store the passphrase that you used in following "gpg \-\-gen\-key" command inside the home\-directory of the AMANDA\-user($amanda_user) and protect it with proper permissions:
 
@@ -247,11 +98,11 @@ You need a User\-ID to identify your key; the software constructs the user id
 from Real Name, Comment and Email Address in this form:
     "Heinrich Heine (Der Dichter) (heinrichh@duesseldorf\&.de)"
 
-Real name: amandabackup
+Real name: backup
 Email address:
-Comment: gpg keys for amandabackup
+Comment: gpg keys for backup
 You selected this USER\-ID:
-    "amandabackup (gpg keys for amandabackup)"
+    "backup (gpg keys for backup)"
 
 Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? o
 You need a Passphrase to protect your secret key\&.
@@ -269,11 +120,11 @@ generator a better chance to gain enough entropy\&.
 public and secret key created and signed\&.
 key marked as ultimately trusted\&.
 
-pub  1024D/4417A8CB 2006\-02\-07 amandabackup (gpg keys for amandabackup)
+pub  1024D/4417A8CB 2006\-02\-07 backup (gpg keys for backup)
      Key fingerprint = 139C 6369 44FC 7F1A 655C  E5E9 7EAA 515A 4417 A8CB
 sub  1024g/8C3A6A78 2006\-02\-07 [expires: 2006\-08\-06]
 .fi
-.SH "Files"
+.SH "FILES"
 .PP
 \fB$AMANDA_HOME/\&.gnupg/pubring\&.gpg\fR
 .RS 4
@@ -284,31 +135,31 @@ encrypt data with this public key along with the cipher algorithm\&.
 .PP
 \fB$AMANDA_HOME/\&.gnupg/secring\&.gpg\fR
 .RS 4
-The private/secret key\&. It\'s only needed during amrecover/amrestore\&. Store and protect it properly during other time\&.
+The private/secret key\&. It\*(Aqs only needed during amrecover/amrestore\&. Store and protect it properly during other time\&.
 .RE
 .PP
 \fB$AMANDA_HOME/\&.am_passphrase\fR
 .RS 4
-The passphrase\&. It\'s only needed during amrecover/amrestore\&. Store and protect it properly during other time\&.
+The passphrase\&. It\*(Aqs only needed during amrecover/amrestore\&. Store and protect it properly during other time\&.
 .RE
 .SH "BUGS"
 .PP
-\fIAmanda\fR
-has problem with gpg mdc(modification detection code) in the binary mode\&.
+Amanda has problem with gpg mdc(modification detection code) in the binary mode\&.
 \fBamgpgcrypt\fR
 calls gpg with mdc disabled
 .SH "SEE ALSO"
 .PP
-
 \fBamanda\fR(8),
 \fBamanda.conf\fR(5),
 \fBamcrypt\fR(8),
 \fBamrestore\fR(8),
-\fBgpg\fR(1),
-: http://wiki.zmanda.com
-.SH "Author"
+\fBgpg\fR(1)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHOR"
 .PP
 \fBKevin Till\fR <\&kevin\&.till@zmanda\&.com\&>
 .RS 4
-Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
+Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 .RE