File: dctrl.man

package info (click to toggle)
diald 0.99.4-7.1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 1,100 kB
  • ctags: 935
  • sloc: ansic: 7,109; tcl: 977; sh: 880; perl: 306; makefile: 109
file content (136 lines) | stat: -rw-r--r-- 2,868 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
.\" manual page [] for diald 0.99
.\" SH section heading
.\" SS subsection heading
.\" LP paragraph
.\" IP indented paragraph
.\" TP hanging label
.TH DCTRL 1 "DIALD 0.99 - 1999.04.06"
.SH NAME
dctrl \- graphical diald control utility
.SH SYNOPSIS
.B /usr/bin/dctrl
[-title \fI<title>\fR]
[-fifo \fI<fifo-path>\fR]
[-host \fI<host>\fR -port \fI<port>\fR]
[-i] [-animated-icon]
[-cw] [-control-window] [-iconic] [standard X options]
.SH DESCRIPTION
.LP
.B Dctrl
is used to issue control commands to a running
.B diald
process,
and to monitor the current status of the link. The
.B diald
process
must have been configured with the "fifo" option in order for
dctrl to work. See the "diald" and "diald-control" manual pages for
further information on the "fifo" option of
.B diald.
The interface presented by
.B dctrl
is very simple, and should be easy to understand.

.SH OPTIONS
.TP
.B -title \fI<title>\fR
Sets the title used for the
.B dctrl
window.

.TP
.B -fifo \fI<fifo-path>\fR
Tell
.B dctrl
where to find the control fifo for the diald process that
you wish to control. By default
.B dctrl
will use whatever you have configured in /etc/diald/diald.options.

.TP
.B -host \fI<host>\fR -port \fI<port>\fR
Tell
.B dctrl
to connect to the given port on the given host using TCP rather than
using a fifo. It is expected that a diald is listening for connections
on the port.

.TP
.B -i
.TP
.B -animated-icon
These options both tell
.B dctrl
to make the icon an animated picture displaying a short synopsis
of the current state of diald.
.TP
.B -cw
.TP
.B -control-window
These options both tell
.B dctrl
to construct a window named "dctrlIcon" that appears similar to an icon.
This window can be swallowed by an AfterStep, Bowman or FVWM module.
For example, an AfterStep configuration line to have Wharf swallow dctrl
might look like:

.IP
*Wharf dctrl   nil   Swallow "dctrlIcon" dctrl -iconic -geometry +520+23 -cw &

.LP
Note that when this option is selected, iconifying the main
.B dctrl
window simply
unmaps that window, leaving the miniature control icon present.
Pressing button <1> over the control icon will deiconify the main
.B dctrl
window.

.TP
.B -iconic
Tell
.B dctrl
to start up in the iconified state.

.TP
.B -dtstatus
The
.I detailed status 
window is posted at startup.

.TP
.B -tload
The
.I numeric load monitor
window is posted at startup.

.TP
.B -gload
The
.I graphical load monitor
window is posted at startup.

.TP
.B -pqueue
The
.I paquet queue
window is posted at startup.

.TP
.B -dlog
The
.I dialing log
window is posted at startup.

.SH SEE ALSO
.LP
fvwm(1), afterstep(1), bowman(1), diald(1),
diald-examples(5), diald-control(5), diald-monitor(5)

.SH AUTHOR
.LP
Eric Schenk (Eric.Schenk@dna.lth.se)

.SH BUGS
This manual page is really much too abreviated. There should be
more discussion about what dctrl will do and how to use it.