File: rec_control.1

package info (click to toggle)
pdns-recursor 3.6.2-2%2Bdeb8u2~bpo70%2B1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy-backports
  • size: 1,432 kB
  • sloc: cpp: 18,930; ansic: 1,653; sh: 539; makefile: 130
file content (160 lines) | stat: -rw-r--r-- 4,343 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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
'\" t
.\"     Title: rec_control
.\"    Author: bert hubert <bert.hubert@netherlabs.nl>
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 19 April 2006
.\"    Manual: \ \&
.\"    Source: \ \& 3.0
.\"  Language: English
.\"
.TH "REC_CONTROL" "1" "19 April 2006" "\ \& 3\&.0" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
rec_control \- control pdns_recursor
.SH "SYNOPSIS"
.sp
\fIrec_control\fR [\-\-help] [\-\-socket\-dir] [\-\-socket\-pid] command \&.\&.
.SH "DESCRIPTION"
.sp
rec_control(1) allows the operator to control a running instance of the pdns_recursor\&.
.sp
The commands that can be passed to the recursor are described on \m[blue]\fBhttp://doc\&.powerdns\&.com/rec\-control\&.html\fR\m[]
.SH "EXAMPLES"
.sp
To stop the recursor by hand, run:
.sp
.if n \{\
.RS 4
.\}
.nf
# rec_control quit
.fi
.if n \{\
.RE
.\}
.sp
To dump the cache to disk, execute:
.sp
.if n \{\
.RS 4
.\}
.nf
# rec_control dump\-cache /tmp/the\-cache
.fi
.if n \{\
.RE
.\}
.SH "OPTIONS"
.PP
\-\-help
.RS 4
provide this helpful message
.RE
.PP
\-\-socket\-dir
.RS 4
Where the controlsocket will live
.RE
.PP
\-\-socket\-pid
.RS 4
When running in SMP mode, pid of pdns_recursor to control
.RE
.PP
\-\-timeout
.RS 4
Number of seconds to wait for the remote PowerDNS Recursor to respond\&. Set to 0 for infinite\&.
.RE
.SH "COMMANDS"
.PP
dump\-cache filename
.RS 4
Dumps the entire cache to the filename mentioned\&. This file should not exist already, PowerDNS will refuse to overwrite it\&. While dumping, the recursor will not answer questions\&.
.RE
.PP
get statistic
.RS 4
Retrieve a statistic\&. For items that can be queried, see
\m[blue]\fBhttp://doc\&.powerdns\&.com/recursor\-stats\&.html\fR\m[]
.RE
.PP
get\-all
.RS 4
Retrieve all known statistics\&.
.RE
.PP
ping
.RS 4
Check if server is alive\&.
.RE
.PP
quit
.RS 4
Request shutdown of the recursor
.RE
.PP
reload\-zones
.RS 4
Reload authoritative and forward zones\&. Retains current configuration in case of errors\&.
.RE
.PP
top\-remotes
.RS 4
Shows the top\-20 most active remote hosts\&. Statistics are over the last
\fIremotes\-ringbuffer\-entries\fR
queries, which defaults to 0\&.
.RE
.PP
wipe\-cache domain0 [domain1]
.RS 4
Wipe entries from the cache\&. This is useful if, for example, an important server has a new IP address, but the TTL has not yet expired\&. Multiple domain names can be passed\&. Note that you must terminate a domain with a \&.! So to wipe powerdns\&.org, issue
\fIrec_control wipe\-cache powerdns\&.org\&.\fR\&. Versions beyond 3\&.1 don\(cqt need the trailing dot\&. Consider not only wiping
\fIwww\&.domain\&.com\&.\fR
but also
\fIdomain\&.com\&.\fR, as the cached nameservers or target of CNAME may continue to be undesired\&.
.RE
.SH "BUGS"
.sp
None known\&. File new ones at \m[blue]\fBhttp://wiki\&.powerdns\&.com\fR\m[]\&.
.SH "AUTHOR"
.sp
Written by PowerDNS\&.COM BV, bert hubert, <\m[blue]\fBbert\&.hubert@netherlabs\&.nl\fR\m[]\&\s-2\u[1]\d\s+2>
.SH "RESOURCES"
.sp
Website: \m[blue]\fBhttp://wiki\&.powerdns\&.com\fR\m[], \m[blue]\fBhttp://www\&.powerdns\&.com\fR\m[]
.SH "SEE ALSO"
.sp
pdns_recursor(1)
.SH "COPYING"
.sp
Copyright \(co 2006 PowerDNS\&.COM BV\&. Free use of this software is granted under the terms of the GNU General Public License (GPL) version 2\&.
.SH "AUTHOR"
.PP
\fBbert hubert\fR <\&bert\&.hubert@netherlabs\&.nl\&>
.RS 4
Author.
.RE
.SH "NOTES"
.IP " 1." 4
bert.hubert@netherlabs.nl
.RS 4
\%mailto:bert.hubert@netherlabs.nl
.RE