aboutsummaryrefslogtreecommitdiffstats
path: root/pw.1
diff options
context:
space:
mode:
Diffstat (limited to 'pw.1')
-rw-r--r--pw.147
1 files changed, 47 insertions, 0 deletions
diff --git a/pw.1 b/pw.1
index 2966e1f..a596249 100644
--- a/pw.1
+++ b/pw.1
@@ -621,6 +621,53 @@ of whether they were compiled as ERE or BRE.
Any other command string results in a brief error message.
+.IP "\fB:f\fP \fIinteger\fP"
+Capture a triggered snapshot only once every
+.I integer
+times the trigger event occurs If
+.I integer
+is 0 or 1, then trigger on every matching event.
+
+When
+.I integer
+is 1 or more,
+.I pw
+counts the number of trigger events which occur. Only when the counter reaches
+the specified value is a snapshot taken; and then the counter is reset to zero.
+
+There is an internal difference between the value 0 and 1 in that
+0 disables the feature: no counting takes place.
+
+.IP "\fB:c\fP [\fIinteger\fP]"
+Limit the number of trigger-driven captures to the count specified by
+.IR integer ,
+after which capture is automatically suspended, as if by the
+.B Space
+command.
+
+If
+.IR integer
+is omitted, then the count of snapshots is reset to zero, without
+affecting the configuration that was previously specified by a
+.B :c
+command with an argument.
+
+If
+.IR integer
+is zero, then the counting mode is disabled; capture does not suspend
+regardless of how many capture events occur.
+
+Note that capture events are counted, not trigger events.
+Thus, if the capture frequency is reduced using the
+.B :f
+command, then the ignored trigger events are not counted.
+
+When the required number of captures is taken, and capture is suspended,
+the trigger count is reset to zero. Thus when the
+.B Enter
+command is used to resume capture, the same number of capture events
+will have to occur again before the next automatic suspension.
+
.SH OPTIONS
.IP "\fB-i\fP \fIreal\fP"