~ubuntu-branches/debian/lenny/smokeping/lenny

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2006-10-26 21:45:56 UTC
  • mfrom: (1.2.2 upstream) (2.1.5 edgy)
  • Revision ID: james.westby@ubuntu.com-20061026214556-5jnpiesx4vdijmu6
* debian/patches/15_clean_makefile.dpatch:
  + remove unneeded and potentially unsecure include paths.
* debian/patches: selected patches from the upstream SVN repository
  + 40_password.dpatch: skip reading the password file when running as a CGI.
  + 50_ldap.dpatch: Make the 'scope' option in the LDAP probe actually work.
  + 60_fping.dpatch:
    * Support the '-S' (set source address, see #198486) fping option.
    * Don't try to execute fping when running as a CGI.
  + 70_syslog.dpatch: Don't die silently if syslogd is unavailable.
    (Closes: #395056)
* Remove all the autogenerated documentation at clean time, to properly
  undo the effects of the 'build' target.
* Install example configuration files for documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
 
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.  | will give a
 
29
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
 
30
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
 
31
.\" expand to `' in nroff, nothing in troff, for use with C<>.
 
32
.tr \(*W-|\(bv\*(Tr
 
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::DNS 3"
 
132
.TH doc::Smokeping::probes::DNS 3 "2006-07-14" "2.0.9" "SmokePing"
 
133
.SH "NAME"
 
134
Smokeping::probes::DNS \- Name Service Probe for SmokePing
 
135
.SH "SYNOPSIS"
 
136
.IX Header "SYNOPSIS"
 
137
.Vb 1
 
138
\& *** Probes ***
 
139
.Ve
 
140
.PP
 
141
.Vb 1
 
142
\& +DNS
 
143
.Ve
 
144
.PP
 
145
.Vb 5
 
146
\& binary = /usr/bin/dig # mandatory
 
147
\& forks = 5
 
148
\& offset = 50%
 
149
\& step = 300
 
150
\& timeout = 15
 
151
.Ve
 
152
.PP
 
153
.Vb 4
 
154
\& # The following variables can be overridden in each target section
 
155
\& lookup = www.example.org
 
156
\& pings = 5
 
157
\& server = ns1.someisp.net
 
158
.Ve
 
159
.PP
 
160
.Vb 1
 
161
\& # [...]
 
162
.Ve
 
163
.PP
 
164
.Vb 1
 
165
\& *** Targets ***
 
166
.Ve
 
167
.PP
 
168
.Vb 1
 
169
\& probe = DNS # if this should be the default probe
 
170
.Ve
 
171
.PP
 
172
.Vb 1
 
173
\& # [...]
 
174
.Ve
 
175
.PP
 
176
.Vb 6
 
177
\& + mytarget
 
178
\& # probe = DNS # if the default probe is something else
 
179
\& host = my.host
 
180
\& lookup = www.example.org
 
181
\& pings = 5
 
182
\& server = ns1.someisp.net
 
183
.Ve
 
184
.SH "DESCRIPTION"
 
185
.IX Header "DESCRIPTION"
 
186
Integrates dig as a probe into smokeping. The variable \fBbinary\fR must
 
187
point to your copy of the dig program. If it is not installed on
 
188
your system yet, you should install bind-utils >= 9.0.0.
 
189
.PP
 
190
The Probe asks the given host n\-times for it's name. Where n is
 
191
the amount specified in the config File.
 
192
.SH "VARIABLES"
 
193
.IX Header "VARIABLES"
 
194
Supported probe-specific variables:
 
195
.IP "binary" 4
 
196
.IX Item "binary"
 
197
The location of your dig binary.
 
198
.Sp
 
199
Example value: /usr/bin/dig
 
200
.Sp
 
201
This setting is mandatory.
 
202
.IP "forks" 4
 
203
.IX Item "forks"
 
204
Run this many concurrent processes at maximum
 
205
.Sp
 
206
Example value: 5
 
207
.Sp
 
208
Default value: 5
 
209
.IP "offset" 4
 
210
.IX Item "offset"
 
211
If you run many probes concurrently you may want to prevent them from
 
212
hitting your network all at the same time. Using the probe-specific
 
213
offset parameter you can change the point in time when each probe will
 
214
be run. Offset is specified in % of total interval, or alternatively as
 
215
\&'random', and the offset from the 'General' section is used if nothing
 
216
is specified here. Note that this does \s-1NOT\s0 influence the rrds itself,
 
217
it is just a matter of when data acqusition is initiated.
 
218
(This variable is only applicable if the variable 'concurrentprobes' is set
 
219
in the 'General' section.)
 
220
.Sp
 
221
Example value: 50%
 
222
.IP "step" 4
 
223
.IX Item "step"
 
224
Duration of the base interval that this probe should use, if different
 
225
from the one specified in the 'Database' section. Note that the step in
 
226
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
 
227
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
 
228
files or somehow convert them. (This variable is only applicable if
 
229
the variable 'concurrentprobes' is set in the 'General' section.)
 
230
.Sp
 
231
Example value: 300
 
232
.IP "timeout" 4
 
233
.IX Item "timeout"
 
234
How long a single 'ping' takes at maximum
 
235
.Sp
 
236
Example value: 15
 
237
.Sp
 
238
Default value: 5
 
239
.PP
 
240
Supported target-specific variables:
 
241
.IP "lookup" 4
 
242
.IX Item "lookup"
 
243
Name of the host to look up in the dns.
 
244
.Sp
 
245
Example value: www.example.org
 
246
.IP "pings" 4
 
247
.IX Item "pings"
 
248
How many pings should be sent to each target, if different from the global
 
249
value specified in the Database section. Note that the number of pings in
 
250
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
 
251
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
 
252
files or somehow convert them.
 
253
.Sp
 
254
Example value: 5
 
255
.IP "server" 4
 
256
.IX Item "server"
 
257
Name of the dns server to use.
 
258
.Sp
 
259
Example value: ns1.someisp.net
 
260
.SH "AUTHORS"
 
261
.IX Header "AUTHORS"
 
262
.Vb 5
 
263
\& Igor Petrovski <pigor@myrealbox.com>,
 
264
\& Carl Elkins <carl@celkins.org.uk>,
 
265
\& Andre Stolze <stolze@uni-muenster.de>,
 
266
\& Niko Tyni <ntyni@iki.fi>,
 
267
\& Chris Poetzel<cpoetzel@anl.gov>
 
268
.Ve