From 4a2a71d4d832cc80d0af93df817da038de55c72f Mon Sep 17 00:00:00 2001 From: Bruce Hill Date: Sat, 30 Apr 2022 15:26:58 -0400 Subject: Updated docs --- README.md | 3 ++- bp.1 | 7 ++++++- bp.1.md | 5 +++++ 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20ee2ad..0582186 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,8 @@ Pattern | Meaning `(pat1 @keep=pat2) => "@keep"` | Match `pat1` followed by `pat2` and replace it with the text of `pat2` `pat1~pat2` | `pat1` when `pat2` can be found within the result `pat1!~pat2` | `pat1` when `pat2` can not be found within the result -`name:pat2` | `name` is defined to mean `pat` +`name: pat2` | `name` is defined to mean `pat` +`name:: pat2` | `name` is defined to mean `pat` and matches have `name` attached to the result as metadata `# line comment` | A line comment See `man ./bp.1` for more details. diff --git a/bp.1 b/bp.1 index 3acd591..3d082f5 100644 --- a/bp.1 +++ b/bp.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.17.1.1 +.\" Automatically generated by Pandoc 2.18 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. @@ -342,6 +342,11 @@ not contain the word \f[B]\[lq]IGNORE\[rq]\f[R]) \f[I]name\f[R]\f[B]:\f[R] \f[I]pat\f[R] Define \f[I]name\f[R] to mean \f[I]pat\f[R] (pattern definition) .TP +\f[I]name\f[R]\f[B]::\f[R] \f[I]pat\f[R] +Define \f[I]name\f[R] to be a special tagged pattern \f[I]pat\f[R]. +This is the same as a regular definition, except that a piece of +metadata is attached to it associating it with the specified name. +.TP \f[B]#\f[R] \f[I]comment\f[R] A line comment .SH GRAMMAR FILES diff --git a/bp.1.md b/bp.1.md index 0170aaa..6995372 100644 --- a/bp.1.md +++ b/bp.1.md @@ -280,6 +280,11 @@ contain the word **"IGNORE"**) *name*`:` *pat* : Define *name* to mean *pat* (pattern definition) +*name*`::` *pat* +: Define *name* to be a special tagged pattern *pat*. This is the same as a +regular definition, except that a piece of metadata is attached to it +associating it with the specified name. + `#` *comment* : A line comment -- cgit v1.2.3