finish -l and -L, update man page
[forkaftergrep.git] / fag.1
CommitLineData
649053e3 1.TH fag 1 "16 February 2018" "1.2" "User Commands"
4f83e12d 2.hy 0
3.SH NAME
7966a08a 4fag \- daemonize program after a regular expression pattern was matched (ForkAfterGrep)
4f83e12d 5.
6.SH SYNOPSIS
7.B fag
8.RI [ OPTIONS ]
9.I PATTERN
10.I PROGRAM
11.RI [ ARGUMENTS .\|.\|.]
12.br
13.SH DESCRIPTION
14.B fag
629b060c 15uses
16.B grep
17to search the output of
4f83e12d 18.IR PROGRAM
629b060c 19for the regular expression
20.IR PATTERN
21and daemonizes it when a match is found. The PID is then returned on stdout.
4f83e12d 22.SH OPTIONS
23.SS "Behaviour Changing Options"
24.TP
25.BI \-t " SECONDS" "\fR
26Set a timeout of
27.I SECONDS
28seconds.
29.TP
30.BR \-k " [" \fISIGNAL\fP "]
31If given, send a signal to
32.IR PROGRAM .
33.I SIGNAL
34defaults to
35.BR SIGTERM " (15)."
36Right now, only decimal notation is implemented.
37.TP
649053e3 38.BR \-r
4f83e12d 39Search
40.IR PATTERN
41on
42.BR stderr
43instead of
44.BR stdout .
9949154c 45.TP
c7c46781 46.BI \-l " FILE "
47Log
48.IR PROGRAM\fR's
49.BR stdout
50to
51.IR FILE .
52The file will be opened in append mode and created with permissions 0600 if it doesn't exist.
53.TP
54.BI \-L " FILE "
55Same as
56.BR \-l
57but logs
58.IR PROGRAM\fR's
59.BR stderr .
60.TP
9949154c 61.BR \-V
62Be verbose; print program's
63.BR stdout
64(or stderr if
c7c46781 65.BR \-r
9949154c 66is set) to stderr.
4f83e12d 67.SS "Generic Program Information"
68.TP
69.B \-h
70Output a short usage message and exit.
71.TP
72.BR \-v
73Display version and copyright information and exit.
c7c46781 74.SS "Supported grep Options"
75.TP
76.BR \-E ", " \-F ", " \-G ", " \-P
77Matcher selection switches for extended regular expressions, fixed strings, basic regular expressions (default) or Perl-compatible regular expressions. You may only supply one of them.
78.TP
79.BR \-i ", " \-w ", " \-x ", " \-U
80Matching control switches for ignore case distinctions, whole words only, whole lines only and treat as binary.
81.TP
82.BR \-Z ", " \-J
83Decompression switches for
84.IR gzip (1)
85and
86.IR bzip2 (1).
87Not widely supported; check your \fBgrep\fR's capabilities.
4f83e12d 88.SH EXIT STATUS
89If
90.IR PATTERN
91was found, 0 is returned. Otherwise, the exit status follows the BSD guideline outlined in
92.B #include <sysexits.h>
93if the error occured from within
94.B fag
95or in case the chid process exits prematurely, its exit code is inherited. Notably, \fI69\fP is returned when the timeout is reached.
4f83e12d 96.SH BUGS
97.SS Known Bugs
b98f2a91 98if grep gets killed (e.g. `killall grep'), fag should terminate.
4f83e12d 99.SS Reporting Bugs
100Please report bugs and patches to the issue tracker at https://github.com/girst/forkaftergrep/.
101.SH NOTES
de1e8d30 102.IR SIGNAL
103needs to be given as an integer. implementing mnemonics is dirty and not very portable; maybe support in the future.
7966a08a 104.PP
105Since 1.1, if
106.B fag
107gets interrupted or terminated,
108.BR SIGTERM
109is sent to
110.IR PROGRAM.
649053e3 111.PP
112In 1.2 the command line switch
113.B \-e was renamed to
114.B \-r
115to avoid overloading
116.B grep\fR's own switches.
4f83e12d 117.SH COPYRIGHT
118Copyright 2017 Tobias Girstmair. This is free software; see https://www.gnu.org/licenses/gpl-3.0.html for conditions.
119.SH AUTHOR
7966a08a 120Tobias Girstmair (https://gir.st)
Imprint / Impressum