Changed license of the manual stuff to GPL.
[gnupg.git] / doc / tools.texi
1 @c Copyright (C) 2004 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file GnuPG.texi.
4
5 @node Helper Tools
6 @chapter Helper Tools
7
8 GnuPG comes with a couple of smaller tools:
9
10 @menu
11 * watchgnupg::            Read logs from a socket.
12 * addgnupghome::          Create .gnupg home directories
13 @end menu
14
15
16 @node watchgnupg
17 @section Read logs from a socket
18
19 Most of the main utilities are able to write there log files to a
20 Unix Domain socket if configured that way.  watchgnupg is a simple
21 listener for such a socket.  It ameliorates the output with a time
22 stamp and makes sure that long lines are not interspersed with log
23 output from other utilities.
24
25 @noindent
26 watchgnupg is commonly invoked as
27
28 @samp{watchgnupg --force ~/.gnupg/S.log}
29
30 @noindent
31 This starts it on the current terminal for listening on the socket
32 @file{~/.gnupg/S.log}.  
33
34 @noindent
35 watchgnupg understands these options:
36
37 @table @gnupgtabopt
38
39 @item --force 
40 @opindex force
41 Delete an already existing socket file.
42
43 @item --verbose
44 @opindex verbose
45 Enable extra informational output.
46
47 @item --version
48 @opindex version
49 print version of the program and exit
50
51 @item --help
52 @opindex help
53 Display a brief help page and exit
54
55 @end table
56
57
58
59 @node addgnupghome
60 @section Create .gnupg home directories
61
62 If GnuPG is installed on a system with existing user accounts, it is
63 sometimes required to populate the GnuPG home directory with existing
64 files.  Especially a @file{trustlist.txt} and a keybox with some
65 initial certificates are often desired.  This scripts help to do this
66 by copying all files from @file{/etc/skel/.gnupg} to the home
67 directories of the accounts given on the command line.  It takes care
68 not to overwrite existing GnuPG home directories.
69
70 @noindent
71 addgnupghome is invoked by root as:
72
73 @samp{addgnupghome account1 account2 ... accountn}
74