aboutsummaryrefslogtreecommitdiffstats
path: root/doc/tools.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/tools.texi')
-rw-r--r--doc/tools.texi59
1 files changed, 45 insertions, 14 deletions
diff --git a/doc/tools.texi b/doc/tools.texi
index d39d950f4..ec147601b 100644
--- a/doc/tools.texi
+++ b/doc/tools.texi
@@ -25,7 +25,16 @@ GnuPG comes with a couple of smaller tools:
@node watchgnupg
@section Read logs from a socket
@ifset manverb
- watchgnupg \- Read and print logs from a socket
+.B watchgnupg
+\- Read and print logs from a socket
+@end ifset
+
+@mansect synopsis
+@ifset manverb
+.B watchgnupg
+.RB [ \-\-force ]
+.RB [ \-\-verbose ]
+.I socketname
@end ifset
@mansect description
@@ -35,11 +44,9 @@ 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
-@mansect synopsis
@example
watchgnupg --force ~/.gnupg/S.log
@end example
@@ -49,11 +56,11 @@ watchgnupg --force ~/.gnupg/S.log
This starts it on the current terminal for listening on the socket
@file{~/.gnupg/S.log}.
+@mansect options
@noindent
@command{watchgnupg} understands these options:
@table @gnupgtabopt
-@mansect options
@item --force
@opindex force
@@ -71,9 +78,15 @@ print version of the program and exit
@opindex help
Display a brief help page and exit
-@manpause
@end table
+@mansect see also
+@command{gpg}(1),
+@command{gpgsm}(1),
+@command{gpg-agent}(1),
+@command{scdaemon}(1)
+@include see-also-note.texi
+
@c
@c ADDGNUPGHOME
@@ -82,7 +95,15 @@ Display a brief help page and exit
@node addgnupghome
@section Create .gnupg home directories.
@ifset manverb
- addgnupghome \- Create .gnupg home directories
+.B addgnupghome
+\- Create .gnupg home directories
+@end ifset
+
+@mansect synopsis
+@ifset manverb
+.B addgnupghome
+.I account_1
+.IR account_2 ... account_n
@end ifset
@mansect description
@@ -94,11 +115,9 @@ 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:
-@mansect synopsis
@example
addgnupghome account1 account2 ... accountn
@end example
@@ -111,9 +130,26 @@ addgnupghome account1 account2 ... accountn
@node gpgconf
@section Modify .gnupg home directories.
@ifset manverb
- gpgconf \- Modify .gnupg home directories
+.B gpgconf
+\- Modify .gnupg home directories
+@end ifset
+
+@mansect synopsis
+@ifset manverb
+.B gpgconf
+.RI [ options ]
+.BI --list-components
+.br
+.B gpgconf
+.RI [ options ]
+.BI --list-options component
+.br
+.B gpgconf
+.RI [ options ]
+.BI --change-options component
@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
@@ -148,7 +184,6 @@ 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.
@@ -164,9 +199,7 @@ throughout this section.
@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
@@ -184,9 +217,7 @@ Change the options of the component @var{component}.
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}