← Back to branch summary

~ubuntu-branches/ubuntu/edgy/smokeping/edgy-proposed

« back to all changes in this revision

Viewing changes to doc/EchoPing.pm.1

  • Committer: Bazaar Package Importer
  • Author(s): Jose Carlos Garcia Sogo
  • Date: 2002-04-02 15:02:08 UTC
  • Revision ID: james.westby@ubuntu.com-20020402150208-8eycqntc07q6gig5
Tags: upstream-1.6
Import upstream version 1.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/EchoPing.pm.1
 
1
.\" Automatically generated by Pod::Man version 1.15
 
2
.\" Wed Mar 27 19:27:08 2002
 
3
.\"
 
4
.\" Standard preamble:
 
5
.\" ======================================================================
 
6
.de Sh \" Subsection heading
 
7
.br
 
8
.if t .Sp
 
9
.ne 5
 
10
.PP
 
11
\fB\\$1\fR
 
12
.PP
 
13
..
 
14
.de Sp \" Vertical space (when we can't use .PP)
 
15
.if t .sp .5v
 
16
.if n .sp
 
17
..
 
18
.de Ip \" List item
 
19
.br
 
20
.ie \\n(.$>=3 .ne \\$3
 
21
.el .ne 3
 
22
.IP "\\$1" \\$2
 
23
..
 
24
.de Vb \" Begin verbatim text
 
25
.ft CW
 
26
.nf
 
27
.ne \\$1
 
28
..
 
29
.de Ve \" End verbatim text
 
30
.ft R
 
31
 
 
32
.fi
 
33
..
 
34
.\" Set up some character translations and predefined strings.  \*(-- will
 
35
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 
36
.\" double quote, and \*(R" will give a right double quote.  | will give a
 
37
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
 
38
.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
 
39
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
 
40
.tr \(*W-|\(bv\*(Tr
 
41
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 
42
.ie n \{\
 
43
.    ds -- \(*W-
 
44
.    ds PI pi
 
45
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
 
46
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
 
47
.    ds L" ""
 
48
.    ds R" ""
 
49
.    ds C` ""
 
50
.    ds C' ""
 
51
'br\}
 
52
.el\{\
 
53
.    ds -- \|\(em\|
 
54
.    ds PI \(*p
 
55
.    ds L" ``
 
56
.    ds R" ''
 
57
'br\}
 
58
.\"
 
59
.\" If the F register is turned on, we'll generate index entries on stderr
 
60
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
 
61
.\" index entries marked with X<> in POD.  Of course, you'll have to process
 
62
.\" the output yourself in some meaningful fashion.
 
63
.if \nF \{\
 
64
.    de IX
 
65
.    tm Index:\\$1\t\\n%\t"\\$2"
 
66
..
 
67
.    nr % 0
 
68
.    rr F
 
69
.\}
 
70
.\"
 
71
.\" For nroff, turn off justification.  Always turn off hyphenation; it
 
72
.\" makes way too many mistakes in technical documents.
 
73
.hy 0
 
74
.if n .na
 
75
.\"
 
76
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 
77
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 
78
.bd B 3
 
79
.    \" fudge factors for nroff and troff
 
80
.if n \{\
 
81
.    ds #H 0
 
82
.    ds #V .8m
 
83
.    ds #F .3m
 
84
.    ds #[ \f1
 
85
.    ds #] \fP
 
86
.\}
 
87
.if t \{\
 
88
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 
89
.    ds #V .6m
 
90
.    ds #F 0
 
91
.    ds #[ \&
 
92
.    ds #] \&
 
93
.\}
 
94
.    \" simple accents for nroff and troff
 
95
.if n \{\
 
96
.    ds ' \&
 
97
.    ds ` \&
 
98
.    ds ^ \&
 
99
.    ds , \&
 
100
.    ds ~ ~
 
101
.    ds /
 
102
.\}
 
103
.if t \{\
 
104
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 
105
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 
106
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 
107
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 
108
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 
109
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 
110
.\}
 
111
.    \" troff and (daisy-wheel) nroff accents
 
112
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 
113
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 
114
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 
115
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 
116
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 
117
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 
118
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 
119
.ds ae a\h'-(\w'a'u*4/10)'e
 
120
.ds Ae A\h'-(\w'A'u*4/10)'E
 
121
.    \" corrections for vroff
 
122
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 
123
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 
124
.    \" for low resolution devices (crt and lpr)
 
125
.if \n(.H>23 .if \n(.V>19 \
 
126
\{\
 
127
.    ds : e
 
128
.    ds 8 ss
 
129
.    ds o a
 
130
.    ds d- d\h'-1'\(ga
 
131
.    ds D- D\h'-1'\(hy
 
132
.    ds th \o'bp'
 
133
.    ds Th \o'LP'
 
134
.    ds ae ae
 
135
.    ds Ae AE
 
136
.\}
 
137
.rm #[ #] #H #V #F C
 
138
.\" ======================================================================
 
139
.\"
 
140
.IX Title "probes::EchoPing 3"
 
141
.TH probes::EchoPing 3 "1.6" "2002-03-10" "SmokePing"
 
142
.UC
 
143
.SH "NAME"
 
144
probes::EchoPing \- an \fIechoping\fR\|(1) probe for SmokePing
 
145
.SH "OVERVIEW"
 
146
.IX Header "OVERVIEW"
 
147
Measures \s-1TCP\s0 or \s-1UDP\s0 echo (port 7) roundtrip times for SmokePing. Can also be 
 
148
used as a base class for other \fIechoping\fR\|(1) probes.
 
149
.SH "SYNOPSYS"
 
150
.IX Header "SYNOPSYS"
 
151
.Vb 2
 
152
\& *** Probes ***
 
153
\& + EchoPing
 
154
.Ve
 
155
.Vb 1
 
156
\& binary = /usr/bin/echoping # default value
 
157
.Ve
 
158
.Vb 1
 
159
\& *** Targets ***
 
160
.Ve
 
161
.Vb 2
 
162
\& probe = EchoPing
 
163
\& forks = 10
 
164
.Ve
 
165
.Vb 3
 
166
\& menu = Top
 
167
\& title = Top Menu
 
168
\& remark = Top Menu Remark
 
169
.Ve
 
170
.Vb 1
 
171
\& + PROBE_CONF
 
172
.Ve
 
173
.Vb 7
 
174
\& # none of these are mandatory
 
175
\& timeout = 1
 
176
\& waittime = 1
 
177
\& udp = no
 
178
\& size = 510
 
179
\& tos = 0xa0
 
180
\& priority = 6
 
181
.Ve
 
182
.Vb 4
 
183
\& + First
 
184
\& menu = First
 
185
\& title = First Target
 
186
\& host = router.example.com
 
187
.Ve
 
188
.Vb 3
 
189
\& # PROBE_CONF can be overridden here
 
190
\& ++ PROBE_CONF
 
191
\& size = 300
 
192
.Ve
 
193
.SH "DESCRIPTION"
 
194
.IX Header "DESCRIPTION"
 
195
Supported probe-specific variables:
 
196
.Ip "binary" 4
 
197
.IX Item "binary"
 
198
The location of your echoping binary.
 
199
.Ip "forks" 4
 
200
.IX Item "forks"
 
201
The number of concurrent processes to be run. See probes::basefork(3pm) 
 
202
for details.
 
203
.PP
 
204
Supported target-level probe variables 
 
205
(see \fIechoping\fR\|(1) for details of the options):
 
206
.Ip "timeout" 4
 
207
.IX Item "timeout"
 
208
The \*(L"\-t\*(R" \fIechoping\fR\|(1) option. 
 
209
.Ip "waittime" 4
 
210
.IX Item "waittime"
 
211
The \*(L"\-w\*(R" \fIechoping\fR\|(1) option. 
 
212
.Ip "size" 4
 
213
.IX Item "size"
 
214
The \*(L"\-s\*(R" \fIechoping\fR\|(1) option. 
 
215
.Ip "udp" 4
 
216
.IX Item "udp"
 
217
The \*(L"\-u\*(R" \fIechoping\fR\|(1) option. Values other than '0' and 'no' enable \s-1UDP\s0.
 
218
.Ip "fill" 4
 
219
.IX Item "fill"
 
220
The \*(L"\-f\*(R" \fIechoping\fR\|(1) option. 
 
221
.Ip "priority" 4
 
222
.IX Item "priority"
 
223
The \*(L"\-p\*(R" \fIechoping\fR\|(1) option.
 
224
.Ip "tos" 4
 
225
.IX Item "tos"
 
226
The \*(L"\-P\*(R" echoping option.
 
227
.SH "BUGS"
 
228
.IX Header "BUGS"
 
229
Should we test the availability of the service at startup? After that it's
 
230
too late to complain.
 
231
.PP
 
232
The location of the echoping binary should probably be a global variable
 
233
instead of a probe-specific one. As things are, every EchoPing \-derived probe 
 
234
has to declare it if the default (/usr/bin/echoping) isn't correct.
 
235
.SH "AUTHOR"
 
236
.IX Header "AUTHOR"
 
237
Niko Tyni <ntyni@iki.fi>
 
238
.SH "SEE ALSO"
 
239
.IX Header "SEE ALSO"
 
240
\&\fIechoping\fR\|(1), probes::EchoPingHttp(3pm) etc., http://echoping.sourceforge.net/