Debian Codegraph @

rxqueue.1

raw
1 .TH RXQUEUE "1" "June 2013" "Regina Rexx Interpreter" "User Commands"
2
3 .SH NAME
4 rxqueue \- The Regina Rexx Interpreter external queue filter
5
6 .SH SYNOPSIS
7 .B rxqueue
8 [\fB\-h\fR, \fB\-\-help\fR] [\fB\-D\fR, \fB\-\-debug\fR]
9 [\fB\-t\fR string, \fB\-\-text\fR string] [queue] [/fifo | /lifo | /clear | /pull | /queued]
10
11 .SH DESCRIPTION
12 .B rxqueue
13 is a utility that provides access to the Regian Rexx external queue daemon (rxstack).
14 It acts as a filter by placing lines onto a queue
15 via
16 .I stdin
17 or a single line with the \fB\-t\fR or \fB\-\-text\fR switches. Lines can be pulled off the queue to
18 .I stdout
19 .
20
21 .SH OPTIONS
22 .
23 .TP
24 \fB\-h\fR, \fB\-\-help\fR
25 Displays short help.
26 .TP
27 \fB\-D\fR, \fB\-\-debug\fR
28 Turns debugging on
29 \fB\-t\fR string, \fB\-\-text\fR string
30 Places the single line specified in
31 .I string
32 onto an optional queue in the order specified by
33 .I /fifo
34 or
35 .I /lifo
36 .TP
37 \fBqueue\fR
38 The name of the queue to use. Format is queuename[@machine][:port]. If not specified the queue name
39 used is SESSION on localhost using the default port.
40
41 .SH ACTIONS
42 .
43 .TP
44 \fB/fifo\fR
45 Stacks the contents of
46 .I stdin
47 onto the queue in first in, first out order.
48 .TP
49 \fB/lifo\fR
50 Stacks the contents of
51 .I stdin
52 onto the queue in last in, first out order.
53 .TP
54 \fB/clear\fR
55 Removes all lines currently stacked in the queue.
56 .TP
57 \fB/pull\fR
58 Extracts the next line from the queue to
59 .I stdout
60 and removes it from the queue.
61 .TP
62 \fB/queued\fR
63 Returns the number of lines stacked on the queue to
64 .I stdout
65 .
66 .SH ENVIRONMENT
67 \fBrxqueue\fR uses the following environment variables if set.
68
69 .IP RXDEBUG
70 Enables debugging. Same as specifying \-D or \-\-debug option.
71
72 .IP RXSTACK
73 The port number on which \fBrxstack\fR listens. By default this is \fI5757\fR.
74
75 .IP RXQUEUE
76 The name of the queue to be used if not specified by the client using rxqueue.
77 By default this is \fISESSION\fR.
78
79 .SH COPYRIGHT
80 The Regina Rexx interpreter is distributed under the GNU Library
81 General Public License, see the file `COPYING-LIB' in the source code
82 distribution.
83
84 .SH AUTHOR
85 Anders Christensen, University of Trondheim, Norway
86 <anders (at) pvv.unit.no>.
87
88 .SH MAINTAINER
89 Changes to Regina since 0.07a, Mark Hessling
90 <mark (at) rexx.org>
91 with significant assistance from Florian Grosse-Coosmann.
92
93 .SH SEE ALSO
94 .BR rxstack (1)
95
96 There are several good reference books on Rexx. The most famous is
97 "The Rexx Language" by Mike Cowlishaw.
98 Visit http://www.rexxla.org (The Rexx Language Association) for any Rexx
99 related information.
100