Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

trigger-wait manpage, referencing other manpages appropriately, with …

…the addition of an informative SEE ALSO section

Signed-off-by: Matthew Story <matt.story@axialmarket.com>
  • Loading branch information...
commit 726cf25a2e7118c7c0f7672f9d0e18ebccc68123 1 parent 5659ead
@matthewstory authored
Showing with 18 additions and 15 deletions.
  1. +18 −15 doc/trigger-wait.txt
View
33 doc/trigger-wait.txt
@@ -2,50 +2,53 @@
:doctype: manpage
== NAME
-trigger-wait - listen to a trigger and optionally execute a command
+trigger-wait - listen to a fifo(7) and optionally execute a command
== SYNOPSIS
!!!!
-trigger-wait [ -wWdD -t _timeout_ ] _path_ [ _prog_ ]
++trigger-wait+ [ +-wWdD+ +-t+ _timeout_ ] _path_ [ _prog_ ]
!!!!
== DESCRIPTION
-The +trigger-wait+ program listens for input on the fifo +_path_+. If +_prog_+ is
-present, +trigger-wait+ executes it and optionally waits for it to complete. It
-then exits 0 if it received a trigger pull and 99 otherwise.
+The +trigger-wait+ program listens for input on the +fifo(7)+ +_path_+ using
++read(2)+. If +_prog_+ is present, +trigger-wait+ executes +_prog_+ and
+optionally waits for it to complete.
=== OPTIONS
+-t _timeout_+::
Wait at most +_timeout_+ seconds for a trigger pull. If +_timeout_+
seconds elapse without a trigger pull, then +trigger-wait+ pulls
-its own trigger. The default value of +_timeout_+
-is +(unsigned int)~0+.
+its own trigger. (Default: +(unsigned int)~0+)
+-w+::
-Wait for +_prog_+ to complete. (Default)
+Wait for +_prog_+ to complete before exit. (Default)
+-W+::
-Do not wait for +_prog_+ to complete.
+Do not wait for +_prog_+ to complete before exit.
+-d+::
-Delete. Remove and recreate the fifo +_path_+ upon startup. (Default)
+Delete. Remove and recreate the +fifo(7)+ +_path_+ upon startup. (Default)
+-D+::
No delete. Do not remove and recreate +_path_+ upon startup.
== EXIT STATUS
-The +trigger-wait+ program exits 100 for permanent
-errors and 111 for temporary errors. It exits 0 if it received a trigger pull,
-and 99 otherwise.
+The +trigger-wait+ program exits 100 for permanent errors and 111 for
+temporary errors. It exits 0 if it received a trigger pull, and 99 otherwise.
== EXAMPLES
-Assume that the processor for +/service/foo/log+ pulls the trigger as its dying
-act:
+Assume that the processor for +_/service/foo/log_+ pulls the trigger as its
+dying act:
!!!!
cd /service/foo && trigger-wait -t 5 ./trigger-rotate svc -a log
!!!!
+
+== SEE ALSO
++mkfifo(1)+, link:trigger-pull.html[+trigger-pull(1)+],
+link:trigger-listen.html[+trigger-listen(1)+], +fifo(7)+, +multilog(8)+,
++svc(8)+
Please sign in to comment.
Something went wrong with that request. Please try again.