[pkg-gnupg-maint] gpg-agent.1: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Sat Aug 29 01:25:52 BST 2026
Package: gpg-agent
Version: 2.4.9-7+b1
Severity: minor
Tags: patch
Additional remarks.
Mails from me to "submit at bugs.debian.org" are no longer acknowledged. A
Debian maintainer told me, that he would contact the mail administrator
about me not wanting to send bugs upstream.
-.-
Dear Maintainer,
>From "/usr/share/doc/debian/bug-reporting.txt.gz":
Don't file bugs upstream
If you file a bug in Debian, don't send a copy to the upstream software
maintainers yourself, as it is possible that the bug exists only in
Debian. If necessary, the maintainer of the package will forward the
bug upstream.
-.-
For forwarding bug reports to upstream see:
https://www.debian.org/Bugs/Developer#forward
-.-
"Handling bug reports" in
http://people.debian.org/~enrico/dcg/ch03s02.html
-.-
I do not send reports upstream if I have to get an account there.
The Debian maintainers have one already.
-.-
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z < "man page"
[Use
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' -e ' "$' <file>
to find (most) trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
Output from "test-groff -mandoc -K utf8 -rF0 -rHY=0 -ww -z ":
troff:<stdin>:33: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:39: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:72: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:91: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:103: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:108: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:117: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:125: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:148: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:150: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:157: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:158: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:164: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:200: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:204: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:208: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:212: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:217: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:227: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:240: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:247: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:248: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:253: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:254: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:260: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:265: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:274: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:286: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:295: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:303: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:305: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:315: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:323: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:329: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:345: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:365: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:371: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:376: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:377: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:378: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:379: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:381: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:387: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:387: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:388: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:393: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:395: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:401: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:403: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:413: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:414: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:419: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:420: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:427: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:429: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:431: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:432: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:438: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:439: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:446: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:456: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:456: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:462: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:464: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:472: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:474: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:481: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:482: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:501: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:502: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:503: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:510: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:516: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:517: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:523: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:525: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:534: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:535: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:558: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:563: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:569: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:572: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:576: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:584: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:585: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:600: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:605: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:612: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:616: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:628: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:631: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:643: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:656: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:666: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:679: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:686: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:701: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:707: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:709: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:717: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:719: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:724: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:727: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:786: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:789: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:795: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:798: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:799: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:801: warning: end of sentence detected before end of text line [-w style]
an.tmac:<stdin>:819: style: unbalanced .RE
troff:<stdin>:822: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:824: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:827: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:845: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:858: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:865: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:865: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:875: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:881: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:882: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:885: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:888: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:890: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:896: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:911: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:913: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:921: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:937: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:948: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:957: warning: end of sentence detected before end of text line [-w style]
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: forky/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 7.1.8+deb14.1-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages gpg-agent depends on:
ii gpgconf 2.4.9-7+b1
ii libassuan9 3.0.2-2+b2
ii libc6 2.43-3
ii libgcrypt20 1.12.2-1
ii libgpg-error0 1.61-3
ii libnpth0t64 1.8-3+b2
ii pinentry-gtk2 [pinentry] 1.3.2-3
Versions of packages gpg-agent recommends:
ii gnupg 2.4.9-7
Versions of packages gpg-agent suggests:
pn dbus-user-session <none>
pn libpam-systemd <none>
pn pinentry-gnome3 <none>
pn scdaemon <none>
pn tpm2daemon <none>
-- no debconf information
-------------- next part --------------
Input file is gpg-agent.1
Output from "mandoc -T lint gpg-agent.1": (shortened list)
1 ERROR: skipping end of block that is not open: RE
1 STYLE: fill mode already disabled, skipping: nf
1 WARNING: skipping paragraph macro: PP empty
1 WARNING: skipping paragraph macro: br before text line with leading blank
4 WARNING: skipping paragraph macro: sp after PP
-.-.
Output from
test-groff mandoc -Kutf8 -ww -z gpg-agent.1: (shortened list)
21 2 leading space(s) on input line
1 4 leading space(s) on input line
14 6 leading space(s) on input line
129 end of sentence detected before end of text line [-w style]
1 unbalanced .RE
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
See more information in the attachment "trailing whitespace".
Number of lines affected is
1
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
131:In --supervised mode, different file descriptors can be provided for
324:implies the [option --no-allow-mark-trusted].
780:(see: [option --homedir]).
790: changed on the command line (see: [option --options]).
828:updates of this file by using the [option --no-allow-mark-trusted].
835:the [option --no-user-trustlist] enforces the use of only
874:been enabled (see: [option --enable-ssh-support]). Only keys present in
-.-.
Change - to \- if it shall be printed as a minus sign.
gpg-agent.1:667: values are capped at -999 with -999 being lower ranked than -1.
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
131:In --supervised mode, different file descriptors can be provided for
324:implies the [option --no-allow-mark-trusted].
667: values are capped at -999 with -999 being lower ranked than -1.
780:(see: [option --homedir]).
790: changed on the command line (see: [option --options]).
828:updates of this file by using the [option --no-allow-mark-trusted].
835:the [option --no-user-trustlist] enforces the use of only
874:been enabled (see: [option --enable-ssh-support]). Only keys present in
-.-.
Find a repeated word
! 605 --> the
-.-.
Add a "\&" (or a comma (Oxford comma)) after an abbreviation
or use English words
(man-pages(7)).
Abbreviation points should be marked as such and protected against being
interpreted as an end of sentence, if they are not, and that independent
of the current place on the line.
79:pinentry (e.g. \(oq\fI/usr/bin/pinentry\-gtk\fP\(cq) to the expected
80:one (e.g. \(oq\fI/usr/bin/pinentry\fP\(cq).
132:use as different socket types (e.g. ssh, extra) as long as they are
228:in C syntax (e.g. 0x0042) or as a comma separated list of flag names.
314:Do not allow clients to mark keys as trusted, i.e. put them into the
693:to the key; i.e. use "Use-for-ssh:").
701:communicated to the user, e.g. in pinentry dialogs. OpenSSH has
833:list of trusted certificates (e.g. \(oq\fI/etc/gnupg/trustlist.txt\fP\(cq).
898:implicitly added to this list; i.e. there is no need to list them.
927:A running \fBgpg\-agent\fP may be controlled by signals, i.e. using
-.-.
Wrong distance (not two spaces, not a new line character (\n)) between
sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
[List of affected lines removed.]
Split lines longer than 80 characters (fill completely
an A4 sized page line on a terminal)
into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 315, length 82
\(oq\fItrustlist.txt\fP\(cq file. This makes it harder for users to inadvertently
-.-.
The name of a man page is typeset in bold (or italic) and the section in
roman (see man-pages(7)).
134:sd_listen_fds(3) on some Linux distributions for more information on
-.-.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
gpg-agent.1:76:under the default filename (which is system dependent) or use the
gpg-agent.1:79:pinentry (e.g. \(oq\fI/usr/bin/pinentry\-gtk\fP\(cq) to the expected
gpg-agent.1:80:one (e.g. \(oq\fI/usr/bin/pinentry\fP\(cq).
gpg-agent.1:132:use as different socket types (e.g. ssh, extra) as long as they are
gpg-agent.1:228:in C syntax (e.g. 0x0042) or as a comma separated list of flag names.
gpg-agent.1:396:default is 2 hours (7200 seconds).
gpg-agent.1:501:exiting (it does this only in curses mode). This option changes the
gpg-agent.1:673: Active cards (inserted into a card reader or plugged in tokens)
gpg-agent.1:769: export SSH_AUTH_SOCK="$(gpgconf \-\-list\-dirs agent\-ssh\-socket)"
gpg-agent.1:790: changed on the command line (see: [option --options]).
gpg-agent.1:833:list of trusted certificates (e.g. \(oq\fI/etc/gnupg/trustlist.txt\fP\(cq).
gpg-agent.1:847:attribute (despite that it is a MUST for CA certificates) and disables
gpg-agent.1:874:been enabled (see: [option --enable-ssh-support]). Only keys present in
gpg-agent.1:922:a small helper script is provided to create these files (see: [addgnupghome]).
-.-.
Do not use ligature for command name "fi"
770:fi
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(\-, minus) if it matches "[[:alph:]]-[[:alpha:]]" in the name of an
option).
Facilitates the copy and paste of
a) an option in UTF-8 text
b) web addresses (URL).
Is not needed in ordinary words like "mother-in-law", that are not
copied and pasted to a command line (which needs ASCII code)
Use a no-break space ("\ " or "\~") between a number and a (SI) unit
726:The auto-calibration computes a count which requires by default 100ms
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
Start a new sentence on a new line.
gpg-agent.1:132:use as different socket types (e.g. ssh, extra) as long as they are
gpg-agent.1:156:Set the name of the home directory to \fIdir\fP. If this option is not
gpg-agent.1:194:Select the debug level for investigating problems. \fIlevel\fP may be
gpg-agent.1:216:All of the debug messages you can get. A value greater than 8 may be
gpg-agent.1:222:specified and may change with newer releases of this program. They are
gpg-agent.1:230:used. This option is only useful for debugging and the behavior may
gpg-agent.1:271:gpg-agent and does not allow one to start a new instance. This option can
gpg-agent.1:296:be used on X-Servers to avoid X-sniffing attacks. Any use of the
gpg-agent.1:304:seeing what the agent actually does. Use \(oq\fIsocket://\fP\(cq to log to
gpg-agent.1:779:agent. By default they may all be found in the current home directory
gpg-agent.1:833:list of trusted certificates (e.g. \(oq\fI/etc/gnupg/trustlist.txt\fP\(cq).
gpg-agent.1:874:been enabled (see: [option --enable-ssh-support]). Only keys present in
-.-
Additionally:
Line 808: ".RS 2" must start at the beginning of a line.
-.-
Size/bytes:
32801 gpg-agent.1
32774 gpg-agent.1.new
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Tables:
Use the preprocessor 'tbl' to make tables.
Put data, that are wider than the header in the (centered) last column,
in a "T{...\nT}" block.
Table headings, that are wider than any data in the corresponding
column, do not need to be centered, so left adjustment (l, L) is
sufficient. There is thereby no change in the standard output.
-------------- next part --------------
--- gpg-agent.1 2026-08-28 22:16:29.733342858 +0000
+++ gpg-agent.1.new 2026-08-28 23:14:05.826916483 +0000
@@ -76,10 +76,8 @@ Please make sure that a proper pinentry
under the default filename (which is system dependent) or use the
option \fBpinentry\-program\fP to specify the full name of that program.
It is often useful to install a symbolic link from the actual used
-pinentry (e.g. \(oq\fI/usr/bin/pinentry\-gtk\fP\(cq) to the expected
-one (e.g. \(oq\fI/usr/bin/pinentry\fP\(cq).
-
-
+pinentry (e.g.\& \(oq\fI/usr/bin/pinentry\-gtk\fP\(cq) to the expected
+one (e.g.\& \(oq\fI/usr/bin/pinentry\fP\(cq).
.SH COMMANDS
@@ -128,20 +126,15 @@ Windows.
If in \(oq\fIcommon.conf\fP\(cq the option \fBno\-autostart\fP is set, any
start attempts will be ignored.
-In --supervised mode, different file descriptors can be provided for
-use as different socket types (e.g. ssh, extra) as long as they are
+In \-\-supervised mode, different file descriptors can be provided for
+use as different socket types (e.g.\& ssh, extra) as long as they are
identified in the environment variable \fBLISTEN_FDNAMES\fP (see
-sd_listen_fds(3) on some Linux distributions for more information on
+.BR sd_listen_fds (3)
+on some Linux distributions for more information on
this convention).
-.P
-
.SH OPTIONS
-
Options may either be used on the command line or, after stripping off
the two leading dashes, in the configuration file.
-
-
-
.TP
.B \-\-options \fIfile\fP
Reads configuration from \fIfile\fP instead of from the default
@@ -150,7 +143,6 @@ per-user configuration file. The defaul
directly below the home directory of the user. This option is ignored
if used in an options file.
-
.TP
.B \-\-homedir \fIdir\fP
Set the name of the home directory to \fIdir\fP. If this option is not
@@ -164,7 +156,6 @@ On Windows systems it is possible to ins
application. In this case only this command line option is
considered, all other ways to set a home directory are ignored.
-
.TP
.B \-v
.TQ
@@ -225,7 +216,7 @@ however carefully selected to best aid i
.TP
.B \-\-debug \fIflags\fP
Set debug flags. All flags are or-ed and \fIflags\fP may be given
-in C syntax (e.g. 0x0042) or as a comma separated list of flag names.
+in C syntax (e.g.\& 0x0042) or as a comma separated list of flag names.
To get a list of all supported flags the single word "help" can be
used. This option is only useful for debugging and the behavior may
change at any time without notice.
@@ -273,7 +264,6 @@ be used to override this check: the new
take over the communication sockets from the already running process
and start anyway. This option should in general not be used.
-
.TP
.B \-s
.TQ
@@ -287,7 +277,6 @@ shell or the C-shell respectively. The
the environment variable \fBSHELL\fP which is correct in almost all
cases.
-
.TP
.B \-\-grab
.TQ
@@ -297,7 +286,6 @@ be used on X-Servers to avoid X-sniffing
option \fB\-\-grab\fP overrides an used option \fB\-\-no\-grab\fP.
The default is \fB\-\-no\-grab\fP.
-
.TP
.B \-\-log\-file \fIfile\fP
Append all logging output to \fIfile\fP. This is very helpful in
@@ -307,21 +295,17 @@ on a Windows platform, the Registry entr
\fBHKCU\[rs]Software\[rs]GNU\[rs]GnuPG:DefaultLogFile\fP, if set, is used to
specify the logging output.
-
-
.TP
.B \-\-no\-allow\-mark\-trusted
-Do not allow clients to mark keys as trusted, i.e. put them into the
+Do not allow clients to mark keys as trusted, i.e.\& put them into the
\(oq\fItrustlist.txt\fP\(cq file. This makes it harder for users to inadvertently
accept Root-CA keys.
-
-
.TP
.B \-\-no\-user\-trustlist
Entirely ignore the user trust list and consider only the global
trustlist (\(oq\fI/etc/gnupg/trustlist.txt\fP\(cq). This
-implies the [option --no-allow-mark-trusted].
+implies the [option \-\-no-allow-mark-trusted].
.TP
.B \-\-sys\-trustlist\-name \fIfile\fP
@@ -330,13 +314,11 @@ to \fIfile\fP. If \fIfile\fP does not c
not start with "~/" it is searched in the system configuration
directory (\(oq\fI/etc/gnupg\fP\(cq).
-
.TP
.B \-\-allow\-preset\-passphrase
This option allows the use of \fBgpg\-preset\-passphrase\fP to seed the
internal cache of \fBgpg\-agent\fP with passphrases.
-
.TP
.B \-\-no\-allow\-loopback\-pinentry
.TP
@@ -493,7 +475,6 @@ from this list:
\(oq\fIbin\[rs]pinentry\-basic.exe\fP\(cq
where the file names are relative to the GnuPG installation directory.
-
.TP
.B \-\-pinentry\-touch\-file \fIfilename\fP
By default the filename of the socket gpg-agent is listening for
@@ -504,7 +485,6 @@ file passed to Pinentry to \fIfilename\f
that Pinentry will not create that file, it will only change the
modification and access time.
-
.TP
.B \-\-scdaemon\-program \fIfilename\fP
Use program \fIfilename\fP as the Smartcard daemon. The default is
@@ -562,7 +542,6 @@ pinentry to pop up at the \fBtty\fP or d
.B \-\-listen\-backlog \fIn\fP
Set the size of the queue for pending connections. The default is 64.
-
.TP
.B \-\-extra\-socket \fIname\fP
The extra socket is created by default, you may use this option to
@@ -586,8 +565,6 @@ is used for years now and has been suppo
keys in the old format are migrated to the new format as soon as they
are touched.
-
-
.TP
.B \-\-enable\-ssh\-support
.TQ
@@ -602,7 +579,7 @@ distributions use the presence of this o
old ssh-agent shall be started.
On Windows support for the native ssh implementation must be enabled
-using the the option \fBenable\-win32\-openssh\-support\fP. For using
+using the option \fBenable\-win32\-openssh\-support\fP. For using
gpg-agent as a replacement for PuTTY's Pageant, the option
\fBenable\-putty\-support\fP must be enabled.
@@ -664,7 +641,7 @@ The order in which keys are presented to
.B Negative Use\-for\-ssh values
If a key file has the attribute "Use-for-ssh" and its value is
negative, these keys are presented first to ssh. The negative
- values are capped at -999 with -999 being lower ranked than -1.
+ values are capped at \-999 with \-999 being lower ranked than \-1.
These values can be used to prefer on-disk keys over keys taken
from active cards.
@@ -690,18 +667,15 @@ The order in which keys are presented to
Editing the "Use-for-ssh" values can be done with an editor or using
\fBgpg\-connect\-agent\fP and "KEYATTR" (Remember to append a colon
-to the key; i.e. use "Use-for-ssh:").
-
-
+to the key; i.e.\& use "Use-for-ssh:").
.TP
.B \-\-ssh\-fingerprint\-digest
Select the digest algorithm used to compute ssh fingerprints that are
-communicated to the user, e.g. in pinentry dialogs. OpenSSH has
+communicated to the user, e.g.\& in pinentry dialogs. OpenSSH has
transitioned from using MD5 to the more secure SHA256.
-
.TP
.B \-\-auto\-expand\-secmem \fIn\fP
Allow Libgcrypt to expand its secure memory area as required. The
@@ -723,7 +697,7 @@ default. This option is re-read on a SI
.B \-\-s2k\-count \fIn\fP
Specify the iteration count used to protect the passphrase. This
option can be used to override the auto-calibration done by default.
-The auto-calibration computes a count which requires by default 100ms
+The auto-calibration computes a count which requires by default 100\~ms
to mangle a given passphrase. See also \fB\-\-s2k\-calibration\fP.
To view the actually used iteration count and the milliseconds
@@ -743,13 +717,7 @@ To view the auto-calibrated count use:
gpg\-connect\-agent 'GETINFO s2k_count_cal' /bye
.fi
.RE
-
-
-.P
-
-
.SH EXAMPLES
-
It is important to set the environment variable \fBGPG_TTY\fP in
your login shell, for example in the \(oq\fI~/.bashrc\fP\(cq init script:
@@ -767,18 +735,15 @@ it by adding this to your init script:
unset SSH_AGENT_PID
if [ "${gnupg_SSH_AUTH_SOCK_by:\-0}" \-ne $$ ]; then
export SSH_AUTH_SOCK="$(gpgconf \-\-list\-dirs agent\-ssh\-socket)"
-fi
+f\&i
.fi
.RE
-
-
.SH FILES
There are a few configuration files needed for the operation of the
agent. By default they may all be found in the current home directory
-(see: [option --homedir]).
-
+(see: [option \-\-homedir]).
.TP
.B gpg\-agent.conf
@@ -787,7 +752,7 @@ agent. By default they may all be found
two dashes may not be entered and the option may not be abbreviated.
This file is also read after a \fBSIGHUP\fP however only a few
options will actually have an effect. This default name may be
- changed on the command line (see: [option --options]).
+ changed on the command line (see: [option \-\-options]).
You should backup this file.
.TP
@@ -805,7 +770,7 @@ agent. By default they may all be found
Here is an example where two keys are marked as ultimately trusted
and one as not trusted:
- .RS 2
+.RS 2
.nf
# CN=Wurzel ZS 3,O=Intevation GmbH,C=DE
A6935DD34EF3087973C706FC311AA2CCF733765B S
@@ -815,7 +780,7 @@ agent. By default they may all be found
# CN=Root\-CA/O=Schlapphuete/L=Pullach/C=DE
!14:56:98:D3:FE:9C:CA:5A:31:6E:BC:81:D3:11:4E:00:90:A3:44:C2 S
- .fi
+.fi
.RE
Before entering a key into this file, you need to ensure its
@@ -825,14 +790,14 @@ trustworthy enough into this file. Plac
fingerprint of a root certificate are letters received from the CA or
the website of the CA (after making 100% sure that this is indeed the
website of that CA). You may want to consider disallowing interactive
-updates of this file by using the [option --no-allow-mark-trusted].
+updates of this file by using the [option \-\-no-allow-mark-trusted].
It might even be advisable to change the permissions to read-only so
that this file can't be changed inadvertently.
As a special feature a line \fBinclude\-default\fP will include a global
-list of trusted certificates (e.g. \(oq\fI/etc/gnupg/trustlist.txt\fP\(cq).
+list of trusted certificates (e.g.\& \(oq\fI/etc/gnupg/trustlist.txt\fP\(cq).
This global list is also used if the local list is not available;
-the [option --no-user-trustlist] enforces the use of only
+the [option \-\-no-user-trustlist] enforces the use of only
this global list.
It is possible to add further flags after the \fBS\fP for use by the
@@ -867,11 +832,10 @@ used only for documentation purpose.
.RE
-
.TP
.B sshcontrol
This file is used when support for the secure shell agent protocol has
-been enabled (see: [option --enable-ssh-support]). Only keys present in
+been enabled (see: [option \-\-enable-ssh-support]). Only keys present in
this file are used in the SSH protocol. You should backup this file.
This file is deprecated in favor of the "Use-for-ssh" attribute in the
@@ -895,14 +859,12 @@ The keygrip may be prefixed with a \fB!\
The following example lists exactly one key. Note that keys available
through a OpenPGP smartcard in the active smartcard reader are
-implicitly added to this list; i.e. there is no need to list them.
+implicitly added to this list; i.e.\& there is no need to list them.
.RS 2
-.nf
# Key added on: 2011\-07\-20 20:38:46
# Fingerprint: 5e:8d:c4:ad:e7:af:6e:27:8a:d6:13:e4:79:ad:0b:81
34B62F25E277CF13D3C6BCEBFD3F85D08F0A864B 0 confirm
-.fi
.RE
.TP
@@ -912,24 +874,17 @@ implicitly added to this list; i.e. ther
key is stored in a file with the name made up of the keygrip and the
suffix \(oq\fIkey\fP\(cq. You should backup all files in this directory
and take great care to keep this backup closed away.
-
-
.P
-
Note that on larger installations, it is useful to put predefined
files into the directory \(oq\fI/etc/skel/.gnupg\fP\(cq so that newly created
users start up with a working configuration. For existing users the
a small helper script is provided to create these files (see: [addgnupghome]).
-
-
-
.SH SIGNALS
-A running \fBgpg\-agent\fP may be controlled by signals, i.e. using
+A running \fBgpg\-agent\fP may be controlled by signals, i.e.\& using
the \fBkill\fP command to send a signal to the process.
Here is a list of supported signals:
-
.TP
.B SIGHUP
This signal flushes all cached passphrases and if the program has been
@@ -950,7 +905,6 @@ supported but due to the current impleme
scdaemon only once, it is not of much use unless you manually kill the
scdaemon.
-
.TP
.B SIGTERM
Shuts down the process but waits until all current requests are
@@ -968,10 +922,6 @@ Dump internal information to the log fil
.TP
.B SIGUSR2
This signal is used for internal purposes.
-
-.P
-
-
.SH SEE ALSO
\fBgpg\fP(1),
\fBgpgsm\fP(1),
-------------- next part --------------
Check the output from "lintian" in the Debian distribution.
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
To find most trailing spaces use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' -e ' "$' <man page>
The same goes for man pages that are used as an input.
-.-
For a style guide use
mandoc -T lint
-.-
For general input conventions consult the man page "nroff(7)" (item
"Input conventions") or the Texinfo manual about the same item.
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
-.-
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
-.-
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced when that has been fixed.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
See man-pages(7), item "semantic newline".
-.-
The difference between the formatted output of the original and patched
file can be seen with a script "cmp.manuals" in the attachment.
Or
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -d -u <out1> <out2>
and for groff, using
printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z -
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output from 'diff -d -u ...' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-
-------------- next part --------------
A non-text attachment was scrubbed...
Name: cmp.manuals.gz
Type: application/gzip
Size: 1782 bytes
Desc: not available
URL: <http://alioth-lists.debian.net/pipermail/pkg-gnupg-maint/attachments/20260829/02912025/attachment-0001.gz>
More information about the pkg-gnupg-maint
mailing list