~ubuntu-branches/debian/squeeze/smokeping/squeeze

« back to all changes in this revision

Viewing changes to doc/Smokeping/probes/Smokeping::probes::TCPPing.3

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2008-08-29 18:29:34 UTC
  • mfrom: (2.1.14 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080829182934-ad5b9csusoqn1155
Tags: 2.3.6-3
* Unset LC_ALL in the init script because the daemon needs to 
  reset LC_NUMERIC. (Closes: #489766)
* Fix a bashism in the postinst script. Thanks, lintian.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
 
2
.\"
 
3
.\" Standard preamble:
 
4
.\" ========================================================================
 
5
.de Sh \" Subsection heading
 
6
.br
 
7
.if t .Sp
 
8
.ne 5
 
9
.PP
 
10
\fB\\$1\fR
 
11
.PP
 
12
..
 
13
.de Sp \" Vertical space (when we can't use .PP)
 
14
.if t .sp .5v
 
15
.if n .sp
 
16
..
 
17
.de Vb \" Begin verbatim text
 
18
.ft CW
 
19
.nf
 
20
.ne \\$1
 
21
..
 
22
.de Ve \" End verbatim text
 
23
.ft R
 
24
.fi
 
25
..
 
26
.\" Set up some character translations and predefined strings.  \*(-- will
 
27
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 
28
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
 
29
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
 
30
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
 
31
.\" nothing in troff, for use with C<>.
 
32
.tr \(*W-
 
33
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 
34
.ie n \{\
 
35
.    ds -- \(*W-
 
36
.    ds PI pi
 
37
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
 
38
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
 
39
.    ds L" ""
 
40
.    ds R" ""
 
41
.    ds C` ""
 
42
.    ds C' ""
 
43
'br\}
 
44
.el\{\
 
45
.    ds -- \|\(em\|
 
46
.    ds PI \(*p
 
47
.    ds L" ``
 
48
.    ds R" ''
 
49
'br\}
 
50
.\"
 
51
.\" If the F register is turned on, we'll generate index entries on stderr for
 
52
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 
53
.\" entries marked with X<> in POD.  Of course, you'll have to process the
 
54
.\" output yourself in some meaningful fashion.
 
55
.if \nF \{\
 
56
.    de IX
 
57
.    tm Index:\\$1\t\\n%\t"\\$2"
 
58
..
 
59
.    nr % 0
 
60
.    rr F
 
61
.\}
 
62
.\"
 
63
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 
64
.\" way too many mistakes in technical documents.
 
65
.hy 0
 
66
.if n .na
 
67
.\"
 
68
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 
69
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 
70
.    \" fudge factors for nroff and troff
 
71
.if n \{\
 
72
.    ds #H 0
 
73
.    ds #V .8m
 
74
.    ds #F .3m
 
75
.    ds #[ \f1
 
76
.    ds #] \fP
 
77
.\}
 
78
.if t \{\
 
79
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 
80
.    ds #V .6m
 
81
.    ds #F 0
 
82
.    ds #[ \&
 
83
.    ds #] \&
 
84
.\}
 
85
.    \" simple accents for nroff and troff
 
86
.if n \{\
 
87
.    ds ' \&
 
88
.    ds ` \&
 
89
.    ds ^ \&
 
90
.    ds , \&
 
91
.    ds ~ ~
 
92
.    ds /
 
93
.\}
 
94
.if t \{\
 
95
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 
96
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 
97
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 
98
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 
99
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 
100
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 
101
.\}
 
102
.    \" troff and (daisy-wheel) nroff accents
 
103
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 
104
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 
105
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 
106
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 
107
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 
108
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 
109
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 
110
.ds ae a\h'-(\w'a'u*4/10)'e
 
111
.ds Ae A\h'-(\w'A'u*4/10)'E
 
112
.    \" corrections for vroff
 
113
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 
114
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 
115
.    \" for low resolution devices (crt and lpr)
 
116
.if \n(.H>23 .if \n(.V>19 \
 
117
\{\
 
118
.    ds : e
 
119
.    ds 8 ss
 
120
.    ds o a
 
121
.    ds d- d\h'-1'\(ga
 
122
.    ds D- D\h'-1'\(hy
 
123
.    ds th \o'bp'
 
124
.    ds Th \o'LP'
 
125
.    ds ae ae
 
126
.    ds Ae AE
 
127
.\}
 
128
.rm #[ #] #H #V #F C
 
129
.\" ========================================================================
 
130
.\"
 
131
.IX Title "doc::Smokeping::probes::TCPPing 3"
 
132
.TH doc::Smokeping::probes::TCPPing 3 "2008-04-26" "2.3.6" "SmokePing"
 
133
.SH "NAME"
 
134
Smokeping::probes::TCPPing \- TCPPing Probe for SmokePing
 
135
.SH "SYNOPSIS"
 
136
.IX Header "SYNOPSIS"
 
137
.Vb 1
 
138
\& *** Probes ***
 
139
.Ve
 
140
.PP
 
141
.Vb 1
 
142
\& +TCPPing
 
143
.Ve
 
144
.PP
 
145
.Vb 5
 
146
\& binary = /usr/bin/tcpping # mandatory
 
147
\& forks = 5
 
148
\& offset = 50%
 
149
\& step = 300
 
150
\& timeout = 15
 
151
.Ve
 
152
.PP
 
153
.Vb 3
 
154
\& # The following variables can be overridden in each target section
 
155
\& pings = 5
 
156
\& port = 80
 
157
.Ve
 
158
.PP
 
159
.Vb 1
 
160
\& # [...]
 
161
.Ve
 
162
.PP
 
163
.Vb 1
 
164
\& *** Targets ***
 
165
.Ve
 
166
.PP
 
167
.Vb 1
 
168
\& probe = TCPPing # if this should be the default probe
 
169
.Ve
 
170
.PP
 
171
.Vb 1
 
172
\& # [...]
 
173
.Ve
 
174
.PP
 
175
.Vb 5
 
176
\& + mytarget
 
177
\& # probe = TCPPing # if the default probe is something else
 
178
\& host = my.host
 
179
\& pings = 5
 
180
\& port = 80
 
181
.Ve
 
182
.SH "DESCRIPTION"
 
183
.IX Header "DESCRIPTION"
 
184
Integrates TCPPing as a probe into smokeping. The variable \fBbinary\fR must
 
185
point to your copy of the TCPPing program. If it is not installed on
 
186
your system yet, you can get it from http://www.vdberg.org/~richard/tcpping.
 
187
You can also get it from http://www.darkskies.za.net/~norman/scripts/tcpping.
 
188
.PP
 
189
The (optional) port option lets you configure the port for the pings sent.
 
190
The TCPPing manpage has the following to say on this topic:
 
191
.PP
 
192
The problem is that with the widespread use of firewalls on the modern Internet,
 
193
many of the packets that \fItraceroute\fR\|(8) sends out end up being filtered, 
 
194
making it impossible to completely trace the path to the destination. 
 
195
However, in many cases, these firewalls will permit inbound \s-1TCP\s0 packets to specific 
 
196
ports that hosts sitting behind the firewall are listening for connections on. 
 
197
By sending out \s-1TCP\s0 \s-1SYN\s0 packets instead of \s-1UDP\s0 or \s-1ICMP\s0 \s-1ECHO\s0 packets, 
 
198
tcptraceroute is able to bypass the most common firewall filters.
 
199
.PP
 
200
It is worth noting that tcptraceroute never completely establishes a \s-1TCP\s0 connection 
 
201
with the destination host. If the host is not listening for incoming connections, 
 
202
it will respond with an \s-1RST\s0 indicating that the port is closed. If the host instead 
 
203
responds with a SYN|ACK, the port is known to be open, and an \s-1RST\s0 is sent by 
 
204
the kernel tcptraceroute is running on to tear down the connection without completing 
 
205
three-way handshake. This is the same half-open scanning technique that \fInmap\fR\|(1) uses 
 
206
when passed the \-sS flag.
 
207
.SH "VARIABLES"
 
208
.IX Header "VARIABLES"
 
209
Supported probe-specific variables:
 
210
.IP "binary" 4
 
211
.IX Item "binary"
 
212
The location of your TCPPing script.
 
213
.Sp
 
214
Example value: /usr/bin/tcpping
 
215
.Sp
 
216
This setting is mandatory.
 
217
.IP "forks" 4
 
218
.IX Item "forks"
 
219
Run this many concurrent processes at maximum
 
220
.Sp
 
221
Example value: 5
 
222
.Sp
 
223
Default value: 5
 
224
.IP "offset" 4
 
225
.IX Item "offset"
 
226
If you run many probes concurrently you may want to prevent them from
 
227
hitting your network all at the same time. Using the probe-specific
 
228
offset parameter you can change the point in time when each probe will
 
229
be run. Offset is specified in % of total interval, or alternatively as
 
230
\&'random', and the offset from the 'General' section is used if nothing
 
231
is specified here. Note that this does \s-1NOT\s0 influence the rrds itself,
 
232
it is just a matter of when data acqusition is initiated.
 
233
(This variable is only applicable if the variable 'concurrentprobes' is set
 
234
in the 'General' section.)
 
235
.Sp
 
236
Example value: 50%
 
237
.IP "step" 4
 
238
.IX Item "step"
 
239
Duration of the base interval that this probe should use, if different
 
240
from the one specified in the 'Database' section. Note that the step in
 
241
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
 
242
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
 
243
files or somehow convert them. (This variable is only applicable if
 
244
the variable 'concurrentprobes' is set in the 'General' section.)
 
245
.Sp
 
246
Example value: 300
 
247
.IP "timeout" 4
 
248
.IX Item "timeout"
 
249
How long a single 'ping' takes at maximum
 
250
.Sp
 
251
Example value: 15
 
252
.Sp
 
253
Default value: 5
 
254
.PP
 
255
Supported target-specific variables:
 
256
.IP "pings" 4
 
257
.IX Item "pings"
 
258
How many pings should be sent to each target, if different from the global
 
259
value specified in the Database section. Note that the number of pings in
 
260
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
 
261
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
 
262
files or somehow convert them.
 
263
.Sp
 
264
Example value: 5
 
265
.IP "port" 4
 
266
.IX Item "port"
 
267
The \s-1TCP\s0 port the probe should measure.
 
268
.Sp
 
269
Example value: 80
 
270
.SH "AUTHORS"
 
271
.IX Header "AUTHORS"
 
272
Norman Rasmussen <norman@rasmussen.org>
 
273
Patched for Smokeping 2.x compatibility by Anton Chernev <maznio@doom.bg>