From eaf3b89d11156cc055644fc50761e1692e791e84 Mon Sep 17 00:00:00 2001 From: NIIBE Yutaka Date: Mon, 3 Jun 2019 11:57:08 +0900 Subject: [PATCH] doc: Add a section for gpg-check-pattern. * doc/Makefile.am: Add gpg-check-pattern.1. * doc/tools.texi (GPG-CHECK-PATTERN): New. -- GnuPG-bug-id: 4031 Signed-off-by: NIIBE Yutaka --- doc/Makefile.am | 2 +- doc/tools.texi | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 1 deletion(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index 0720dd366..cef9ff29f 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -95,7 +95,7 @@ myman_pages = gpgsm.1 gpg-agent.1 dirmngr.8 scdaemon.1 \ watchgnupg.1 gpgconf.1 addgnupghome.8 gpg-preset-passphrase.1 \ gpg-connect-agent.1 gpgparsemail.1 symcryptrun.1 gpgtar.1 \ applygnupgdefaults.8 gpg-wks-client.1 gpg-wks-server.1 \ - dirmngr-client.1 gpg-card.1 + dirmngr-client.1 gpg-card.1 gpg-check-pattern.1 if USE_GPG2_HACK myman_pages += gpg2.1 gpgv2.1 else diff --git a/doc/tools.texi b/doc/tools.texi index 7dcd84e2f..460030038 100644 --- a/doc/tools.texi +++ b/doc/tools.texi @@ -21,6 +21,7 @@ GnuPG comes with a couple of smaller tools: * gpgparsemail:: Parse a mail message into an annotated format * symcryptrun:: Call a simple symmetric encryption tool. * gpgtar:: Encrypt or sign files into an archive. +* gpg-check-pattern:: Check a passphrase on stdin against the patternfile. @end menu @c @@ -2110,3 +2111,50 @@ gpgtar --list-archive test1 @command{tar}(1), @end ifset @include see-also-note.texi + +@c +@c GPG-CHECK-PATTERN +@c +@manpage gpg-check-pattern.1 +@node gpg-check-pattern +@section Check a passphrase on stdin against the patternfile +@ifset manverb +.B gpg-check-pattern +\- Check a passphrase on stdin against the patternfile +@end ifset + +@mansect synopsis +@ifset manverb +.B gpg\-check\-pattern +.RI [ options ] +.I patternfile +@end ifset + +@mansect description +@command{gpg-check-pattern} checks a passphrase given on stdin against +a specified pattern file. + +@mansect options +@noindent + +@table @gnupgtabopt + +@item --verbose +@opindex verbose +Enable extra informational output. + +@item --check +@opindex check +Run only a syntax check on the patternfile. + +@item --null +@opindex null +Input is expected to be null delimited. + +@end table + +@mansect see also +@ifset isman +@command{gpg}(1), +@end ifset +@include see-also-note.texi