summaryrefslogtreecommitdiffstats
path: root/doc/tools.texi
diff options
context:
space:
mode:
authorNIIBE Yutaka <gniibe@fsij.org>2019-06-03 04:57:08 +0200
committerNIIBE Yutaka <gniibe@fsij.org>2019-06-04 01:49:05 +0200
commiteaf3b89d11156cc055644fc50761e1692e791e84 (patch)
tree0d4524ab6ede97049c1e9ec84fabe7d8ec4ac471 /doc/tools.texi
parentReturn better error code for some getinfo IPC commands. (diff)
downloadgnupg2-eaf3b89d11156cc055644fc50761e1692e791e84.tar.xz
gnupg2-eaf3b89d11156cc055644fc50761e1692e791e84.zip
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 <gniibe@fsij.org>
Diffstat (limited to 'doc/tools.texi')
-rw-r--r--doc/tools.texi48
1 files changed, 48 insertions, 0 deletions
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