diff --git a/doc/ChangeLog b/doc/ChangeLog index 79a8c9532..d7015bd85 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,12 @@ +2004-09-29 Werner Koch + + Changed license of the manual stuff to GPL. + + * gnupg.texi (Top): New menu item Helper Tools. + + * tools.texi (Helper Tools): New. + * Makefile.am (gnupg_TEXINFOS): Add tools.texi. + 2004-08-05 Werner Koch * scdaemon.texi (Card applications): New section. diff --git a/doc/Makefile.am b/doc/Makefile.am index 9dc917de4..3ac312049 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -21,8 +21,8 @@ info_TEXINFOS = gnupg.texi gnupg_TEXINFOS = \ - gpgsm.texi gpg-agent.texi scdaemon.texi assuan.texi\ - debugging.texi glossary.texi contrib.texi gpl.texi fdl.texi + gpgsm.texi gpg-agent.texi scdaemon.texi assuan.texi tools.texi \ + debugging.texi glossary.texi contrib.texi gpl.texi DISTCLEANFILES = gnupg.tmp gnupg.ops diff --git a/doc/Notes b/doc/Notes index 4a990776e..3598bc7a7 100644 --- a/doc/Notes +++ b/doc/Notes @@ -1,3 +1,6 @@ + +Add an infor page for watchgnupg. + > * How to mark a CA certificate as trusted. There are two ways: diff --git a/doc/gnupg.texi b/doc/gnupg.texi index 0beb97e69..ec82fe425 100644 --- a/doc/gnupg.texi +++ b/doc/gnupg.texi @@ -5,26 +5,14 @@ @include version.texi @macro copyrightnotice -Copyright @copyright{} 2002 Free Software Foundation, Inc. +Copyright @copyright{} 2002, 2004 Free Software Foundation, Inc. @end macro @macro permissionnotice Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.1 or -any later version published by the Free Software Foundation; with the -Invariant Sections being ``GNU General Public License'', the Front-Cover -texts being (a) (see below), and with the Back-Cover Texts being (b) -(see below). A copy of the license is included in the section entitled -``GNU Free Documentation License''. - -(a) The FSF's Front-Cover Text is: - - A GNU Manual - -(b) The FSF's Back-Cover Text is: - - You have freedom to copy and modify this GNU Manual, like GNU - software. Copies published by the Free Software Foundation raise - funds for GNU development. +under the terms of the GNU General Public License as published by the +Free Software Foundation; either version 2 of the License, or (at your +option) any later version. The text of the license can be found in the +section entitled ``Copying''. @end macro @@ -126,10 +114,10 @@ Developer information Miscellaneous +* Helper Tools:: Description of small helper tools * Debugging:: How to solve problems * Copying:: GNU General Public License says how you can copy and share GnuPG -* GNU Free Documentation License:: How you can copy and share this manual. * Contributors:: People who have contributed to GnuPG. Indices @@ -145,10 +133,10 @@ Indices @include assuan.texi +@include tools.texi @include debugging.texi @include gpl.texi -@include fdl.texi @include contrib.texi diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi index 460cca45a..ab28eeb7d 100644 --- a/doc/gpg-agent.texi +++ b/doc/gpg-agent.texi @@ -282,7 +282,7 @@ command. @opindex ttyname @opindex ttytype @opindex lc-type -@opindex lc-messa +@opindex lc-messages These options are used with the server mode to pass localization information. diff --git a/doc/tools.texi b/doc/tools.texi new file mode 100644 index 000000000..d04b01277 --- /dev/null +++ b/doc/tools.texi @@ -0,0 +1,74 @@ +@c Copyright (C) 2004 Free Software Foundation, Inc. +@c This is part of the GnuPG manual. +@c For copying conditions, see the file GnuPG.texi. + +@node Helper Tools +@chapter Helper Tools + +GnuPG comes with a couple of smaller tools: + +@menu +* watchgnupg:: Read logs from a socket. +* addgnupghome:: Create .gnupg home directories +@end menu + + +@node watchgnupg +@section Read logs from a socket + +Most of the main utilities are able to write there log files to a +Unix Domain socket if configured that way. 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. + +@noindent +watchgnupg is commonly invoked as + +@samp{watchgnupg --force ~/.gnupg/S.log} + +@noindent +This starts it on the current terminal for listening on the socket +@file{~/.gnupg/S.log}. + +@noindent +watchgnupg understands these options: + +@table @gnupgtabopt + +@item --force +@opindex force +Delete an already existing socket file. + +@item --verbose +@opindex verbose +Enable extra informational output. + +@item --version +@opindex version +print version of the program and exit + +@item --help +@opindex help +Display a brief help page and exit + +@end table + + + +@node addgnupghome +@section Create .gnupg home directories + +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 +initial certificates are often desired. This scripts help to do this +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. + +@noindent +addgnupghome is invoked by root as: + +@samp{addgnupghome account1 account2 ... accountn} +