Skip to content

Commit cde7f43

Browse files
author
rexx
committed
New man pages for installed binaries
git-svn-id: https://svn.code.sf.net/p/regina-rexx/code/interpreter/trunk@86 528c8479-552a-0410-8426-e933f26d916d
1 parent c3ba3a9 commit cde7f43

File tree

3 files changed

+212
-0
lines changed

3 files changed

+212
-0
lines changed

‎regina-config.1

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.TH regina-config 1
2+
.SH Name
3+
regina-config \- Developer Configuration for The Regina Rexx interpreter
4+
.SH Syntax
5+
.B regina-config
6+
[
7+
.I options
8+
]
9+
10+
.SH Description
11+
regina-config supplies configuration information to a developer
12+
intending to use the Rexx SAA API for embedding Regina into
13+
their application or writing Rexx external function packages.
14+
15+
.SH Options
16+
.
17+
.IP \-\-help
18+
Displays usage.
19+
20+
.IP \-\-version
21+
Displays installed version of Regina.
22+
23+
.IP \-\-prefix
24+
Displays the installed prefix directory.
25+
26+
.IP \-\-multithreaded
27+
Displays
28+
.I yes
29+
if the installed version for Regina is thread-safe or
30+
.I no
31+
if not thread-safe.
32+
33+
.IP \-\-cflags
34+
Displays the pre-processor and compiler flags.
35+
36+
.IP \-\-libs
37+
Displays the linker flags.
38+
39+
.SH Copyright
40+
The Regina Rexx interpreter is distributed under the GNU Library
41+
General Public License, see the file `COPYING-LIB' in the source code
42+
distribution.
43+
44+
.SH Author
45+
Anders Christensen, University of Trondheim, Norway
46+
<anders@pvv.unit.no>.
47+
48+
Changes to Regina since 0.07a, Mark Hessling
49+
<mark (at) rexx.org>
50+
51+
.SH See Also
52+
There are several good reference books on Rexx. The most famous is
53+
"The Rexx Language" by Mike Cowlishaw.
54+
Visit http://www.rexxla.org (The Rexx Language Association) for any Rexx
55+
related information.
56+

‎rxqueue.1

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
.TH rxqueue 1
2+
.SH Name
3+
rxqueue \- The Regina Rexx Interpreter external queue utility
4+
5+
.SH Syntax
6+
.B rxqueue
7+
[
8+
.I queue
9+
] [
10+
.I /fifo | /lifo | /clear | /pull | /queued
11+
] [
12+
text
13+
]
14+
15+
.SH Description
16+
.B rxqueue
17+
is utility that provides access to the Regian Rexx external queue daemon
18+
(rxstack) via
19+
.I stdin
20+
and
21+
.I stdout
22+
.
23+
24+
.SH Options
25+
.
26+
.IP queue
27+
The name of the queue to use. By default this is SESSION.
28+
29+
.IP /fifo
30+
Stacks the
31+
.I text
32+
onto the queue in first in, first out order.
33+
34+
.IP /lifo
35+
Stacks the
36+
.I text
37+
onto the queue in last in, first out order.
38+
39+
.IP /clear
40+
Removes all lines currently stacked in the queue.
41+
42+
.IP /pull
43+
Extracts the next line from the queue to
44+
.I stdout
45+
and removes it from the queue.
46+
47+
.IP /queued
48+
Returns the number of lines stacked on the queue to
49+
.I stdout
50+
.
51+
52+
.SH Environment
53+
rxqueue uses the following environment variables if set.
54+
55+
.IP RXDEBUG
56+
Enables debugging. Same as specifying \-D option.
57+
58+
.IP RXSTACK
59+
The port number on which rxqueue listens. By default this is 5757.
60+
61+
.IP RXQUEUE
62+
The name of the queue to be used if not specified by the client using rxqueue.
63+
By default this is SESSION.
64+
65+
66+
67+
.SH Copyright
68+
The Regina Rexx interpreter is distributed under the GNU Library
69+
General Public License, see the file `COPYING-LIB' in the source code
70+
distribution.
71+
72+
.SH Author
73+
Anders Christensen, University of Trondheim, Norway
74+
<anders@pvv.unit.no>.
75+
76+
.SH Maintainer
77+
Changes to Regina since 0.07a, Mark Hessling
78+
<mark (at) rexx.org>
79+
with significant assistance from Florian Grosse-Coosmann.
80+
81+
.SH "See Also"
82+
.BR rxstack (1)
83+
84+
There are several good reference books on Rexx. The most famous is
85+
"The Rexx Language" by Mike Cowlishaw.
86+
Visit http://www.rexxla.org (The Rexx Language Association) for any Rexx
87+
related information.
88+

‎rxstack.1

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
.TH rxstack 1
2+
.SH Name
3+
rxstack \- The Regina Rexx Interpreter stack daemon
4+
5+
.SH Syntax
6+
.B rxstack
7+
[
8+
.I \-D
9+
]
10+
.I \-d | \-k
11+
12+
.SH Description
13+
.B rxstack
14+
is a daemon that provides access to Regian Rexx external queues directly to
15+
Regina Rexx programs or indirectly (via rxqueue) to any other program via
16+
.I stdin
17+
and
18+
.I stdout
19+
Without any options, rxstack runs in the foreground.
20+
21+
.SH Options
22+
.
23+
.IP \-D
24+
Sets debugging on
25+
26+
.IP \-d
27+
Starts rxstack as a daemon
28+
29+
.IP \-k
30+
Kills the running rxstack process.
31+
32+
.SH Environment
33+
rxstack uses the following environment variables if set.
34+
35+
.IP RXDEBUG
36+
Enables debugging. Same as specifying \-D option.
37+
38+
.IP RXSTACK
39+
The port number on which rxstack listens. By default this is 5757.
40+
41+
.IP RXQUEUE
42+
The name of the queue to be used if not specified by the client using rxstack.
43+
By default this is SESSION.
44+
45+
46+
47+
.SH Copyright
48+
The Regina Rexx interpreter is distributed under the GNU Library
49+
General Public License, see the file `COPYING-LIB' in the source code
50+
distribution.
51+
52+
.SH Author
53+
Anders Christensen, University of Trondheim, Norway
54+
<anders@pvv.unit.no>.
55+
56+
.SH Maintainer
57+
Changes to Regina since 0.07a, Mark Hessling
58+
<mark (at) rexx.org>
59+
with significant assistance from Florian Grosse-Coosmann.
60+
61+
.SH "See Also"
62+
.BR rxqueue (1)
63+
64+
There are several good reference books on Rexx. The most famous is
65+
"The Rexx Language" by Mike Cowlishaw.
66+
Visit http://www.rexxla.org (The Rexx Language Association) for any Rexx
67+
related information.
68+

0 commit comments

Comments
 (0)