summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog5
-rw-r--r--doc/gnupg.texi16
-rw-r--r--doc/gpg-agent.texi6
-rw-r--r--doc/tools.texi45
4 files changed, 65 insertions, 7 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index c4d263513..d93a473a2 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,8 @@
+2005-08-16 Werner Koch <wk@g10code.com>
+
+ * gpg-agent.texi (Agent Options): Note default file name for
+ --write-env-file.
+
2005-06-03 Werner Koch <wk@g10code.com>
* debugging.texi (Architecture Details): New section, mostly empty.
diff --git a/doc/gnupg.texi b/doc/gnupg.texi
index d92f01cd9..efa54bd14 100644
--- a/doc/gnupg.texi
+++ b/doc/gnupg.texi
@@ -3,6 +3,18 @@
@setfilename gnupg.info
@include version.texi
@settitle Using the GNU Privacy Guard
+
+@c A couple of macros with no effect on texinfo
+@c but used by the yat2m processor.
+@macro manpage {a}
+@end macro
+@macro mansect {a}
+@end macro
+@macro manpause
+@end macro
+@macro mancont
+@end macro
+
@c Create a separate index for command line options.
@defcodeindex op
@c Merge the standard indexes into a single one.
@@ -13,8 +25,8 @@
@syncodeindex tp cp
@c %**end of header
@copying
-This is the @cite{The GNU Privacy Guard Manual}
-(version @value{VERSION}, @value{UPDATED}).
+This is the @cite{The GNU Privacy Guard Manual} (version
+@value{VERSION}, @value{UPDATED}).
@iftex
Published by the Free Software Foundation@*
diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi
index 144745b4c..066f8e937 100644
--- a/doc/gpg-agent.texi
+++ b/doc/gpg-agent.texi
@@ -253,8 +253,9 @@ Often it is required to connect to the agent from a process not being an
inferior of @command{gpg-agent} and thus the environment variable with
the socket name is not available. To help setting up those variables in
other sessions, this option may be used to write the information into
-@var{file}. The format is suitable to be evaluated by a Bourne shell
-like in this simple example:
+@var{file}. If @var{file} is not specified the default name
+@file{$@{HOME@}/.gpg-agent-info} will be used. The format is suitable
+to be evaluated by a Bourne shell like in this simple example:
@example
eval `cat @var{file}`
@@ -262,6 +263,7 @@ eval `cut -d= -f 1 < @var{file} | xargs echo export`
@end example
+
@item --no-grab
@opindex no-grab
Tell the pinentryo not to grab the keyboard and mouse. This option
diff --git a/doc/tools.texi b/doc/tools.texi
index b2463c351..850202bd5 100644
--- a/doc/tools.texi
+++ b/doc/tools.texi
@@ -20,19 +20,29 @@ GnuPG comes with a couple of smaller tools:
@c
@c WATCHGNUPG
@c
+@manpage watchgnupg.1
@node watchgnupg
@section Read logs from a socket
+@ifset manverb
+ watchgnupg \- Read and print logs from a socket
+@end ifset
+@mansect description
Most of the main utilities are able to write there log files to a
Unix Domain socket if configured that way. @command{watchgnupg} is a simple
listener for such a socket. It ameliorates the output with a time
stamp and makes sure that long lines are not interspersed with log
output from other utilities.
+@manpause
@noindent
@command{watchgnupg} is commonly invoked as
-@samp{watchgnupg --force ~/.gnupg/S.log}
+@mansect synopsis
+@example
+watchgnupg --force ~/.gnupg/S.log
+@end example
+@manpause
@noindent
This starts it on the current terminal for listening on the socket
@@ -42,6 +52,7 @@ This starts it on the current terminal for listening on the socket
@command{watchgnupg} understands these options:
@table @gnupgtabopt
+@mansect options
@item --force
@opindex force
@@ -59,15 +70,21 @@ print version of the program and exit
@opindex help
Display a brief help page and exit
+@manpause
@end table
@c
@c ADDGNUPGHOME
@c
+@manpage addgnupghome.8
@node addgnupghome
@section Create .gnupg home directories.
+@ifset manverb
+ addgnupghome \- Create .gnupg home directories
+@end ifset
+@mansect description
If GnuPG is installed on a system with existing user accounts, it is
sometimes required to populate the GnuPG home directory with existing
files. Especially a @file{trustlist.txt} and a keybox with some
@@ -76,18 +93,27 @@ by copying all files from @file{/etc/skel/.gnupg} to the home
directories of the accounts given on the command line. It takes care
not to overwrite existing GnuPG home directories.
+@manpause
@noindent
@command{addgnupghome} is invoked by root as:
-@samp{addgnupghome account1 account2 ... accountn}
+@mansect synopsis
+@example
+addgnupghome account1 account2 ... accountn
+@end example
@c
@c GPGCONF
@c
+@manpage gpgconf.1
@node gpgconf
@section Modify .gnupg home directories.
+@ifset manverb
+ gpgconf \- Modify .gnupg home directories
+@end ifset
+@mansect description
The @command{gpgconf} is a utility to automatically and reasonable
safely query and modify configuration files in the @file{.gnupg} home
directory. It is designed not to be invoked manually by the user, but
@@ -121,6 +147,7 @@ changes can then be made active with @command{gpgconf} again. Such a
program that uses @command{gpgconf} in this way will be called GUI
throughout this section.
+@manpause
@menu
* Invoking gpgconf:: List of all commands and options.
* Format conventions:: Formatting conventions relevant for all commands.
@@ -133,9 +160,13 @@ throughout this section.
@node Invoking gpgconf
@subsection Invoking gpgconf
+@mansect commands
One of the following commands must be given:
+@manpause
@table @gnupgtabopt
+@mancont
+
@item --list-components
List all components. This is the default command used if none is
specified.
@@ -145,11 +176,16 @@ List all options of the component @var{component}.
@item --change-options @var{component}
Change the options of the component @var{component}.
+@manpause
@end table
+@mansect options
+
The following options may be used:
+@manpause
@table @gnupgtabopt
+@mancont
@c FIXME: Not yet supported.
@c @item -o @var{file}
@c @itemx --output @var{file}
@@ -176,6 +212,7 @@ changing.
This means that the changes will take effect at run-time, as far as
this is possible. Otherwise, they will take effect at the next start
of the respective backend programs.
+@manpause
@end table
@@ -295,6 +332,7 @@ the locale environment of the @command{gpgconf} program.
@c to change it via the command line?
+@mansect usage
@node Listing components
@subsection Listing components
@@ -580,6 +618,7 @@ $ echo 'force:16:' | gpgconf --change-options dirmngr
The @code{--runtime} option can influence when the changes take
effect.
+@manpause
@c
@c GPGSM-GENCERT.SH
@c
@@ -587,7 +626,7 @@ effect.
@section Generate an X.509 certificate request
This is a simple tool to interactivly generate a certificate request
-whicl will be printed to stdout.
+which will be printed to stdout.
@noindent
@command{gpgsm-gencert.sh} is invoked as: