-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc/flux-event(1): add missing manual page
- Loading branch information
Showing
2 changed files
with
62 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
// flux-help-include: true | ||
FLUX-EVENT(1) | ||
============= | ||
:doctype: manpage | ||
|
||
|
||
NAME | ||
---- | ||
flux-event - Send and receive Flux events | ||
|
||
|
||
SYNOPSIS | ||
-------- | ||
*flux* *event* 'COMMAND' ['OPTIONS'] | ||
|
||
|
||
DESCRIPTION | ||
----------- | ||
Flux events are messages that are broadcast throughout the Flux instance | ||
with publish/subscribe semantics. Each event message has a _topic string_ | ||
and an optional _payload_. | ||
|
||
Subscriptions are by topic string. A subscription topic of length _N_ | ||
matches an event if the first _N_ characters of the event topic | ||
are identical to that of the subscription. For example the event topic | ||
'a.b.c' is matched by the subscription topic 'a.b.c', 'a.b', or 'a'. | ||
A subscription to the empty string matches all events. | ||
|
||
COMMANDS | ||
-------- | ||
*pub* [-r] [-l] 'topic' ['payload']:: | ||
Publish an event with optional payload. If payload is specified, | ||
it is interpreted as raw if the '-r' option is used, otherwise it is | ||
interpreted as JSON. If the payload spans multiple arguments, | ||
the arguments are concatenated with one space between them. | ||
If '-l' is specified, subscribe to the published event and wait for | ||
it to be received before exiting. | ||
|
||
*sub* '[-c N]' ['topic'] ['topic'...]:: | ||
Subscribe to events matching the topic string(s) provided on the | ||
command line. If none are specified, subscribe to all events. | ||
If '-c N' is specified, print the first 'N' events on stdout and exit; | ||
otherwise continue printing events until a signal is received. | ||
Events are displayed one per line: the topic string, followed by a tab, | ||
followed by the payload, if any. | ||
|
||
|
||
AUTHOR | ||
------ | ||
This page is maintained by the Flux community. | ||
|
||
|
||
RESOURCES | ||
--------- | ||
Github: <http://github.com/flux-framework> | ||
|
||
|
||
COPYRIGHT | ||
--------- | ||
include::COPYRIGHT.adoc[] |