update readme's man
authorgirst <girst@users.noreply.github.com>
Thu, 27 Jul 2017 23:52:55 +0000 (01:52 +0200)
committergirst <girst@users.noreply.github.com>
Thu, 27 Jul 2017 23:52:55 +0000 (01:52 +0200)
README.md

index c5ba44b6385e8d94cf014acdcbcacf2a6bbbe563..39e41f52dd644081fde7534de508a1aa034a41c6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,11 +10,9 @@ SYNOPSIS
        fag [OPTIONS] PATTERN PROGRAM [ARGUMENTS...]
 
 DESCRIPTION
        fag [OPTIONS] PATTERN PROGRAM [ARGUMENTS...]
 
 DESCRIPTION
-       fag  searches  the PROGRAM for the string PATTERN.  This is useful if a
-       program takes a while to initialize and prints a message to  stdout  or
-       stderr  when ready. When placed in a script, fag blocks execution until
-       the pattern was found, then daemonizes the child process,  returns  the
-       PID on stdout and exits.
+       fag  uses  grep  to  search  the  output  of  PROGRAM  for  the regular
+       expression PATTERN and daemonizes it when a match is found. The PID  is
+       then returned on stdout.
 
 OPTIONS
    Behaviour Changing Options
 
 OPTIONS
    Behaviour Changing Options
@@ -27,6 +25,9 @@ OPTIONS
 
        -e     Search PATTERN on stderr instead of stdout.
 
 
        -e     Search PATTERN on stderr instead of stdout.
 
+       -V     Be verbose; print program's stdout (or stderr if -e is  set)  to
+              stderr.
+
    Generic Program Information
        -h     Output a short usage message and exit.
 
    Generic Program Information
        -h     Output a short usage message and exit.
 
@@ -34,18 +35,13 @@ OPTIONS
 
 EXIT STATUS
        If PATTERN was found, 0 is returned. Otherwise, the exit status follows
 
 EXIT STATUS
        If PATTERN was found, 0 is returned. Otherwise, the exit status follows
-       the  BSD  guideline  outlined  in  #include  <sysexits.h>  if the error
-       occured from within fag or in case the chid process exits  prematurely,
+       the BSD guideline  outlined  in  #include  <sysexits.h>  if  the  error
+       occured  from within fag or in case the chid process exits prematurely,
        its exit code is inherited. Notably, 69 is returned when the timeout is
        reached.
 
 BUGS
    Known Bugs
        its exit code is inherited. Notably, 69 is returned when the timeout is
        reached.
 
 BUGS
    Known Bugs
-       Only a simple string search is performed on PATTERN in this version.
-
-       If a PROGRAM like cat opens stdout/stderr, but never writes to it,  the
-       timeout isn't triggered.
-
        SIGNAL needs to be given as an integer; mnemonic should be supported in
        the future.
 
        SIGNAL needs to be given as an integer; mnemonic should be supported in
        the future.
 
@@ -60,13 +56,13 @@ NOTES
        a symlink or alias on your system.
 
 COPYRIGHT
        a symlink or alias on your system.
 
 COPYRIGHT
-       Copyright   2017   Tobias   Girstmair.   This  is  free  software;  see
+       Copyright  2017  Tobias  Girstmair.  This   is   free   software;   see
        https://www.gnu.org/licenses/gpl-3.0.html for conditions.
 
 AUTHOR
        Tobias Girstmair (http://isticktoit.net)
 
        https://www.gnu.org/licenses/gpl-3.0.html for conditions.
 
 AUTHOR
        Tobias Girstmair (http://isticktoit.net)
 
-1.0                            07 February 2017                         fag(1)
+1.0                              28 July 2017                           fag(1)
 ```
 
 ## Notes
 ```
 
 ## Notes
Imprint / Impressum