1 files changed, 46 insertions, 1 deletions
diff --git a/doc/tools.texi b/doc/tools.texi
index c48ba4b4a..8041f4859 100644
--- a/doc/tools.texi
+++ b/doc/tools.texi
@@ -2081,6 +2081,51 @@ gpgtar --list-archive test1
 @command{gpg-check-pattern} checks a passphrase given on stdin against
 a specified pattern file.
 
+The pattern file is line based with comment lines beginning on the
+@emph{first} position with a @code{#}.  Empty lines and lines with
+only white spaces are ignored.  The actual pattern lines may either be
+verbatim string pattern and match as they are (trailing spaces are
+ignored) or extended regular expressions indicated by a @code{/} or
+@code{!/} in the first column and terminated by another @code{/} or
+end of line.  If a regular expression starts with @code{!/} the match
+result is reversed. By default all comparisons are case insensitive.
+
+Tag lines may be used to further control the operation of this tool.
+The currently defined tags are:
+
+@table @code
+@item [icase]
+Switch to case insensitive comparison for all further patterns.  This
+is the default.
+
+@item [case]
+Switch to case sensitive comparison for all further patterns.
+
+@item [reject]
+Switch to reject mode.  This is the default mode.
+
+@item [accept]
+Switch to accept mode.
+@end table
+
+In the future more tags may be introduced and thus it is advisable not to
+start a plain pattern string with an open bracket.  The tags must be
+given verbatim on the line with no spaces to the left or any non white
+space characters to the right.
+
+In reject mode the program exits on the first match with an exit code
+of 1 (failure).  If at the end of the pattern list the reject mode is
+still active the program exits with code 0 (success).
+
+In accept mode blocks of patterns are used.  A block starts at the
+next pattern after an "accept" tag and ends with the last pattern
+before the next "accept" or "reject" tag or at the end of the pattern
+list.  If all patterns in a block match the program exits with an exit
+code of 0 (success).  If any pattern in a block do not match the next
+pattern block is evaluated.  If at the end of the pattern list the
+accept mode is still active the program exits with code 1 (failure).
+
+
 @mansect options
 @noindent
 
@@ -2102,6 +2147,6 @@ Input is expected to be null delimited.
 
 @mansect see also
 @ifset isman
-@command{gpg}(1),
+@command{gpg-agent}(1),
 @end ifset
 @include see-also-note.texi