[svn] GnuPG - r4224 - in trunk: . doc
svn author wk
cvs at cvs.gnupg.org
Fri Aug 18 15:05:40 CEST 2006
Author: wk
Date: 2006-08-18 15:05:39 +0200 (Fri, 18 Aug 2006)
New Revision: 4224
Added:
trunk/doc/opt-homedir.texi
trunk/doc/see-also-note.texi
Modified:
trunk/NEWS
trunk/README
trunk/doc/Makefile.am
trunk/doc/gpg-agent.texi
trunk/doc/gpg.texi
trunk/doc/gpgsm.texi
trunk/doc/scdaemon.texi
trunk/doc/tools.texi
trunk/doc/yat2m.c
Log:
More man pages. Added include files for 2 common paragraphs.
Modified: trunk/NEWS
===================================================================
--- trunk/NEWS 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/NEWS 2006-08-18 13:05:39 UTC (rev 4224)
@@ -1,8 +1,15 @@
Noteworthy changes in version 1.9.23
-------------------------------------------------
+ * man pages for most tools are now build directly from the texinfo
+ source.
+ * The gpg code from 1.4.5 has been fully merged into this release.
+ The configure option --enable-gpg is still required to build this
+ gpg part. For production use of OpenPGP the gpg version 1.4.5 is
+ still recommended.
+
Noteworthy changes in version 1.9.22 (2006-07-27)
-------------------------------------------------
Modified: trunk/README
===================================================================
--- trunk/README 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/README 2006-08-18 13:05:39 UTC (rev 4224)
@@ -55,11 +55,12 @@
installation. gpg2 behaves just like gpg; it is however suggested to
keep using gpg 1.2.x or 1.3.x. gpg2 is not even build by default.
-In case of problem please ask on gpa-dev at gnupg.org for advise. Note
+In case of problem please ask on gnupg-dev at gnupg.org for advise. Note
that this release is only expected to build on GNU and *BSD systems.
-A texinfo manual named `gnupg.info' will get installed. Some commands
-and options given below. See also the section `SMARTCARD INTRO'.
+A texinfo manual named `gnupg.info' will get installed. man pages for
+all major components are also provided. Some commands and options
+given below. See also the section `SMARTCARD INTRO'.
COMMANDS
Modified: trunk/doc/Makefile.am
===================================================================
--- trunk/doc/Makefile.am 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/doc/Makefile.am 2006-08-18 13:05:39 UTC (rev 4224)
@@ -22,7 +22,8 @@
EXTRA_DIST = gnupg-badge-openpgp.eps gnupg-badge-openpgp.jpg \
gnupg-badge-openpgp.pdf \
gnupg-card-architecture.eps gnupg-card-architecture.png \
- gnupg-card-architecture.pdf
+ gnupg-card-architecture.pdf \
+ opt-homedir.texi see-also-note.texi
BUILT_SOURCES = gnupg-card-architecture.eps gnupg-card-architecture.png \
gnupg-card-architecture.pdf
@@ -38,12 +39,16 @@
tools.texi debugging.texi glossary.texi contrib.texi gpl.texi \
sysnotes.texi gnupg-card-architecture.fig
-YAT2M_OPTIONS = \
+AM_MAKEFINFOFLAGS = -I $(srcdir)
+
+YAT2M_OPTIONS = -I $(srcdir) \
--release "GnuPG @PACKAGE_VERSION@" --source "GNU Privacy Guard"
myman_sources = gpg.texi gpgsm.texi gpg-agent.texi scdaemon.texi tools.texi
myman_pages = gpg2.1 gpgsm.1 gpg-agent.1 scdaemon.1 \
- watchgnupg.1 gpgconf.1 addgnupghome.8
+ watchgnupg.1 gpgconf.1 addgnupghome.8 gpg-preset-passphrase.1 \
+ gpg-connect-agent.1 gpgparsemail.1 symcryptrun.1 \
+ gpgsm-gencert.sh.1
man_MANS = $(myman_pages)
Modified: trunk/doc/gpg-agent.texi
===================================================================
--- trunk/doc/gpg-agent.texi 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/doc/gpg-agent.texi 2006-08-18 13:05:39 UTC (rev 4224)
@@ -168,15 +168,9 @@
below the home directory of the user.
@anchor{option --homedir}
- at item --homedir @var{dir}
- at opindex homedir
-Set the name of the home directory to @var{dir}. If his option is not
-used, the home directory defaults to @file{~/.gnupg}. It is only
-recognized when given on the command line. It also overrides any home
-directory stated through the environment variable @env{GNUPGHOME} or
-(on W32 systems) by means on the Registry entry
- at var{HKCU\Software\GNU\GnuPG:HomeDir}.
+ at include opt-homedir.texi
+
@item -v
@item --verbose
@opindex v
Modified: trunk/doc/gpg.texi
===================================================================
--- trunk/doc/gpg.texi 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/doc/gpg.texi 2006-08-18 13:05:39 UTC (rev 4224)
@@ -1501,12 +1501,9 @@
be in the GnuPG home directory ("~/.gnupg" if --homedir or $GNUPGHOME
is not used).
- at item --homedir @code{directory}
-Set the name of the home directory to @code{directory} If this option is not
-used it defaults to "~/.gnupg". It does not make sense to use this in
-a options file. This also overrides the environment variable
-$GNUPGHOME.
+ at include opt-homedir.texi
+
@item --pcsc-driver @code{file}
Use @code{file} to access the smartcard reader. The current default is
`libpcsclite.so.1' for GLIBC based systems,
Modified: trunk/doc/gpgsm.texi
===================================================================
--- trunk/doc/gpgsm.texi 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/doc/gpgsm.texi 2006-08-18 13:05:39 UTC (rev 4224)
@@ -286,14 +286,7 @@
@file{gpgsm.conf} and expected in the @file{.gnupg} directory directly
below the home directory of the user.
- at item --homedir @var{dir}
- at opindex homedir
-Set the name of the home directory to @var{dir}. If his option is not
-used, the home directory defaults to @file{~/.gnupg}. It is only
-recognized when given on the command line. It also overrides any home
-directory stated through the environment variable @env{GNUPGHOME} or
-(on W32 systems) by means on the Registry entry
- at var{HKCU\Software\GNU\GnuPG:HomeDir}.
+ at include opt-homedir.texi
@item -v
Added: trunk/doc/opt-homedir.texi
===================================================================
--- trunk/doc/opt-homedir.texi 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/doc/opt-homedir.texi 2006-08-18 13:05:39 UTC (rev 4224)
@@ -0,0 +1,14 @@
+ at c This option is included at several places.
+ at item --homedir @var{dir}
+ at opindex homedir
+Set the name of the home directory to @var{dir}. If his option is not
+used, the home directory defaults to @file{~/.gnupg}. It is only
+recognized when given on the command line. It also overrides any home
+directory stated through the environment variable @env{GNUPGHOME} or
+(on W32 systems) by means on the Registry entry
+ at ifset isman
+ at var{HKCU\\Software\\GNU\\GnuPG:HomeDir}.
+ at end ifset
+ at ifclear isman
+ at var{HKCU\Software\GNU\GnuPG:HomeDir}.
+ at end ifclear
Modified: trunk/doc/scdaemon.texi
===================================================================
--- trunk/doc/scdaemon.texi 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/doc/scdaemon.texi 2006-08-18 13:05:39 UTC (rev 4224)
@@ -114,15 +114,9 @@
@file{scdaemon.conf} and expected in the @file{.gnupg} directory directly
below the home directory of the user.
- at item --homedir @var{dir}
- at opindex homedir
-Set the name of the home directory to @var{dir}. If his option is not
-used, the home directory defaults to @file{~/.gnupg}. It is only
-recognized when given on the command line. It also overrides any home
-directory stated through the environment variable @env{GNUPGHOME} or
-(on W32 systems) by means on the Registry entry
- at var{HKCU\Software\GNU\GnuPG:HomeDir}.
+ at include opt-homedir.texi
+
@item -v
@item --verbose
@opindex v
Added: trunk/doc/see-also-note.texi
===================================================================
--- trunk/doc/see-also-note.texi 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/doc/see-also-note.texi 2006-08-18 13:05:39 UTC (rev 4224)
@@ -0,0 +1,14 @@
+ at c We append this note to all ``see also'' sections of the man pages
+
+ at ifset isman
+The full documentation for this tool is maintained as a Texinfo manual.
+If GnuPG and the info program are properly installed at your site, the
+command
+
+ at example
+info gnupg
+ at end example
+
+should give you access to the complete manual including a menu structure
+and an index.
+ at end ifset
Modified: trunk/doc/tools.texi
===================================================================
--- trunk/doc/tools.texi 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/doc/tools.texi 2006-08-18 13:05:39 UTC (rev 4224)
@@ -138,15 +138,17 @@
@ifset manverb
.B gpgconf
.RI [ options ]
-.BI --list-components
+.B \-\-list-components
.br
.B gpgconf
.RI [ options ]
-.BI --list-options component
+.B \-\-list-options
+.I component
.br
.B gpgconf
.RI [ options ]
-.BI --change-options component
+.B \-\-change-options
+.I component
@end ifset
@@ -192,7 +194,7 @@
* Changing options:: Changing options of a component.
@end menu
-
+ at manpause
@node Invoking gpgconf
@subsection Invoking gpgconf
@@ -210,7 +212,6 @@
@item --change-options @var{component}
Change the options of the component @var{component}.
- at manpause
@end table
@mansect options
@@ -650,29 +651,70 @@
The @code{--runtime} option can influence when the changes take
effect.
+ at mansect see also
+ at command{gpg}(1),
+ at command{gpgsm}(1),
+ at command{gpg-agent}(1),
+ at command{scdaemon}(1),
+ at command{dirmngr}(1)
+ at include see-also-note.texi
+
+
@manpause
@c
@c GPGSM-GENCERT.SH
@c
@node gpgsm-gencert.sh
@section Generate an X.509 certificate request
+ at manpage gpgsm-gencert.sh.1
+ at ifset manverb
+.B gpgsm-gencert.sh
+\- Generate an X.509 certificate request
+ at end ifset
+ at mansect synopsis
+ at ifset manverb
+.B gpgsm-gencert.sh
+ at end ifset
+
+ at mansect description
This is a simple tool to interactivly generate a certificate request
which will be printed to stdout.
+ at manpause
@noindent
@command{gpgsm-gencert.sh} is invoked as:
@samp{gpgsm-cencert.sh}
+ at mansect see also
+ at command{gpgsm}(1),
+ at command{gpg-agent}(1),
+ at command{scdaemon}(1)
+ at include see-also-note.texi
+
@c
@c GPG-PRESET-PASSPHRASE
@c
@node gpg-preset-passphrase
@section Put a passphrase into the cache.
+ at manpage gpg-preset-passphrase.1
+ at ifset manverb
+.B gpg-preset-passphrase
+\- Put a passphrase into gpg-agent's cache
+ at end ifset
+ at mansect synopsis
+ at ifset manverb
+.B gpg-preset-passphrase
+.RI [ options ]
+.RI [ command ]
+.I keygrip
+ at end ifset
+
+ at mansect description
The @command{gpg-preset-passphrase} is a utility to seed the internal
cache of a running @command{gpg-agent} with passphrases. It is mainly
useful for unattended machines, where the usual @command{pinentry} tool
@@ -690,9 +732,10 @@
* Invoking gpg-preset-passphrase:: List of all commands and options.
@end menu
-
+ at manpause
@node Invoking gpg-preset-passphrase
@subsection List of all commands and options.
+ at mancont
@noindent
@command{gpg-preset-passphrase} is invoked this way:
@@ -709,11 +752,13 @@
@table @gnupgtabopt
@item --preset
+ at opindex preset
Preset a passphrase. This is what you usually will
use. @command{gpg-preset-passphrase} will then read the passphrase from
@code{stdin}.
@item --forget
+ at opindex forget
Flush the passphrase for the given keygrip from the cache.
@end table
@@ -735,6 +780,12 @@
for other users.
@end table
+ at mansect see also
+ at command{gpg}(1),
+ at command{gpgsm}(1),
+ at command{gpg-agent}(1),
+ at command{scdaemon}(1)
+ at include see-also-note.texi
@@ -743,8 +794,20 @@
@c GPG-CONNECT-AGENT
@c
@node gpg-connect-agent
- at section Communicate with a runnig agent.
+ at section Communicate with a running agent.
+ at manpage gpg-connect-agent.1
+ at ifset manverb
+.B gpg-connect-agent
+\- Communicate with a running agent
+ at end ifset
+ at mansect synopsis
+ at ifset manverb
+.B gpg-connect-agent
+.RI [ options ]
+ at end ifset
+
+ at mansect description
The @command{gpg-connect-agent} is a utility to communicate with a
running @command{gpg-agent}. It is useful to check out the commands
gpg-agent provides using the Assuan interface. It might also be useful
@@ -758,9 +821,10 @@
* Invoking gpg-connect-agent:: List of all commands and options.
@end menu
-
+ at manpause
@node Invoking gpg-connect-agent
@subsection List of all commands and options.
+ at mancont
@noindent
@command{gpg-connect-agent} is invoked this way:
@@ -784,16 +848,8 @@
@opindex quiet
Try to be as quiet as possible.
- at item --homedir @var{dir}
- at opindex homedir
-Set the name of the home directory to @var{dir}. If his option is not
-used, the home directory defaults to @file{~/.gnupg}. It is only
-recognized when given on the command line. It also overrides any home
-directory stated through the environment variable @env{GNUPGHOME} or
-(on W32 systems) by means on the Registry entry
- at var{HKCU\Software\GNU\GnuPG:HomeDir}.
+ at include opt-homedir.texi
-
@item -S
@itemx --raw-socket @var{name}
@opindex S
@@ -802,16 +858,36 @@
Do not run any special initializations or environment checks. This may
be used to directly connect to any Assuan style socket server.
-
@end table
+ at mansect see also
+ at command{gpg-agent}(1),
+ at command{scdaemon}(1)
+ at include see-also-note.texi
+
+
+
@c
@c GPGPARSEMAIL
@c
@node gpgparsemail
@section Parse a mail message into an annotated format
-The @command{gpgparsemail} is a utility currentlu only useful for
+ at manpage gpgparsemail.1
+ at ifset manverb
+.B gpgparsemail
+\- Parse a mail message into an annotated format
+ at end ifset
+
+ at mansect synopsis
+ at ifset manverb
+.B gpgparsemail
+.RI [ options ]
+.RI [ file ]
+ at end ifset
+
+ at mansect description
+The @command{gpgparsemail} is a utility currently only useful for
debugging. Run it with @code{--help} for usage information.
@@ -821,7 +897,26 @@
@c
@node symcryptrun
@section Call a simple symmetric encryption tool.
+ at manpage symcryptrun.1
+ at ifset manverb
+.B symcryptrun
+\- Call a simple symmetric encryption tool
+ at end ifset
+ at mansect synopsis
+ at ifset manverb
+.B symcryptrun
+.B \-\-class
+.I class
+.B \-\-program
+.I program
+.B \-\-keyfile
+.I keyfile
+.RB [ --decrypt | --encrypt ]
+.RI [ inputfile ]
+ at end ifset
+
+ at mansect description
Sometimes simple encryption tools are already in use for a long time and
there might be a desire to integrate them into the GnuPG framework. The
protocols and encryption methods might be non-standard or not even
@@ -838,7 +933,7 @@
* Invoking symcryptrun:: List of all commands and options.
@end menu
-
+ at manpause
@node Invoking symcryptrun
@subsection List of all commands and options.
@@ -849,6 +944,7 @@
symcryptrun --class CLASS --program PROGRAM --keyfile KEYFILE
[--decrypt | --encrypt] [inputfile]
@end example
+ at mancont
For encryption, the plain text must be provided on STDIN or as the
argument @var{inputfile}, and the ciphertext will be output to STDOUT.
@@ -882,15 +978,9 @@
@opindex quiet
Try to be as quiet as possible.
- at item --homedir @var{dir}
- at opindex homedir
-Set the name of the home directory to @var{dir}. If his option is not
-used, the home directory defaults to @file{~/.gnupg}. It is only
-recognized when given on the command line. It also overrides any home
-directory stated through the environment variable @env{GNUPGHOME} or
-(on W32 systems) by means on the Registry entry
- at var{HKCU\Software\GNU\GnuPG:HomeDir}.
+ at include opt-homedir.texi
+
@item --log-file @var{file}
@opindex log-file
Append all logging output to @var{file}. Default is to write logging
@@ -913,3 +1003,9 @@
@end table
+ at mansect see also
+ at command{gpg}(1),
+ at command{gpgsm}(1),
+ at command{gpg-agent}(1),
+ at include see-also-note.texi
+
Modified: trunk/doc/yat2m.c
===================================================================
--- trunk/doc/yat2m.c 2006-08-17 19:58:28 UTC (rev 4223)
+++ trunk/doc/yat2m.c 2006-08-18 13:05:39 UTC (rev 4224)
@@ -85,6 +85,7 @@
static const char *opt_source;
static const char *opt_release;
static const char *opt_select;
+static const char *opt_include;
static int opt_store;
@@ -335,7 +336,6 @@
section_buffer_t sect;
line_buffer_t lb;
-
sect = get_section_buffer (sectname);
if (sect->last_line && !sect->last_line->verbatim == !verbatim)
{
@@ -447,6 +447,7 @@
{ "end", 4 },
{ "quotation",1, ".RS\n\\fB" },
{ "ifset", 1 },
+ { "ifclear", 1 },
{ NULL }
};
size_t n;
@@ -501,6 +502,11 @@
{
fputs ("\\fR\n.RE\n", fp);
}
+ else if (n >= 5 && !memcmp (s, "ifset", 5)
+ && (!n || s[5] == ' ' || s[5] == '\t' || s[5] == '\n'))
+ {
+ fputs ("\\fR\n.RE\n", fp);
+ }
/* Now throw away the entire line. */
s = memchr (rest, '\n', len);
return s? (s-rest)+1 : len;
@@ -815,8 +821,8 @@
while (*p == ' ' || *p == '\t')
p++;
- if (skip_to_end
- &&n == 4 && !memcmp (line, "@end", 4)
+ if (skip_to_end
+ && n == 4 && !memcmp (line, "@end", 4)
&& (line[4]==' '||line[4]=='\t'||!line[4]))
{
skip_to_end = 0;
@@ -881,12 +887,29 @@
{
skip_to_end = 1;
}
+ else if (n == 8 && !memcmp (line, "@ifclear", 8)
+ && !strncmp (p, "isman", 5) && (p[5]==' '||p[5]=='\t'||!p[5]))
+ {
+ skip_to_end = 1;
+ }
else if (n == 8 && !memcmp (line, "@include", 8)
&& (line[8]==' '||line[8]=='\t'||!line[8]))
{
char *incname = xstrdup (p);
FILE *incfp = fopen (incname, "r");
+ if (!incfp && opt_include && *opt_include && *p != '/')
+ {
+ free (incname);
+ incname = xmalloc (strlen (opt_include) + 1
+ + strlen (p) + 1);
+ strcpy (incname, opt_include);
+ if ( incname[strlen (incname)-1] != '/' )
+ strcat (incname, "/");
+ strcat (incname, p);
+ incfp = fopen (incname, "r");
+ }
+
if (!incfp)
err ("can't open include file `%s':%s",
incname, strerror (errno));
@@ -895,8 +918,9 @@
parse_file (incname, incfp, section_name);
fclose (incfp);
}
+ free (incname);
}
- else
+ else if (!skip_to_end)
got_line = 1;
}
else if (!skip_to_end)
@@ -956,7 +980,8 @@
" --select NAME only output pages with @manpage NAME\n"
" --verbose enable extra informational output\n"
" --debug enable additional debug output\n"
- " --help display this help and exit\n\n"
+ " --help display this help and exit\n"
+ " -I DIR also search in include DIR\n\n"
"With no FILE, or when FILE is -, read standard input.\n\n"
"Report bugs to <bugs at g10code.com>.");
exit (0);
@@ -1021,6 +1046,15 @@
argc--; argv++;
}
}
+ else if (!strcmp (*argv, "-I"))
+ {
+ argc--; argv++;
+ if (argc)
+ {
+ opt_include = *argv;
+ argc--; argv++;
+ }
+ }
}
if (argc > 1)
More information about the Gnupg-commits
mailing list