named-checkconf.8 3.95 KB
Newer Older
Tinderbox User's avatar
Tinderbox User committed
1
.\" Copyright (C) 2000-2002, 2004, 2005, 2007, 2009, 2014-2016, 2018 Internet Systems Consortium, Inc. ("ISC")
Rob Austein's avatar
regen  
Rob Austein committed
2
.\" 
Tinderbox User's avatar
Tinderbox User committed
3 4 5
.\" This Source Code Form is subject to the terms of the Mozilla Public
.\" License, v. 2.0. If a copy of the MPL was not distributed with this
.\" file, You can obtain one at http://mozilla.org/MPL/2.0/.
Rob Austein's avatar
regen  
Rob Austein committed
6
.\"
Rob Austein's avatar
regen  
Rob Austein committed
7 8
.hy 0
.ad l
Tinderbox User's avatar
Tinderbox User committed
9 10
'\" t
.\"     Title: named-checkconf
Mark Andrews's avatar
regen  
Mark Andrews committed
11
.\"    Author: 
12
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
Tinderbox User's avatar
Tinderbox User committed
13
.\"      Date: 2014-01-10
Mark Andrews's avatar
regen  
Mark Andrews committed
14
.\"    Manual: BIND9
Tinderbox User's avatar
Tinderbox User committed
15 16
.\"    Source: ISC
.\"  Language: English
Mark Andrews's avatar
regen  
Mark Andrews committed
17
.\"
Tinderbox User's avatar
Tinderbox User committed
18 19 20 21 22 23 24 25 26 27 28 29 30
.TH "NAMED\-CHECKCONF" "8" "2014\-01\-10" "ISC" "BIND9"
.\" -----------------------------------------------------------------
.\" * 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
.\" -----------------------------------------------------------------
Mark Andrews's avatar
regen  
Mark Andrews committed
31 32 33 34
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
Tinderbox User's avatar
Tinderbox User committed
35 36 37
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
Mark Andrews's avatar
regen  
Mark Andrews committed
38
.SH "NAME"
Tinderbox User's avatar
Tinderbox User committed
39
named-checkconf \- named configuration file syntax checking tool
Rob Austein's avatar
regen  
Rob Austein committed
40
.SH "SYNOPSIS"
41
.HP 16
Tinderbox User's avatar
Tinderbox User committed
42
\fBnamed\-checkconf\fR [\fB\-hjlvz\fR] [\fB\-p\fR\ [\fB\-x\fR\ ]] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] {filename}
43 44
.SH "DESCRIPTION"
.PP
Mark Andrews's avatar
regen  
Mark Andrews committed
45
\fBnamed\-checkconf\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
46 47
checks the syntax, but not the semantics, of a
\fBnamed\fR
Tinderbox User's avatar
Tinderbox User committed
48 49 50
configuration file\&. The file is parsed and checked for syntax errors, along with all files included by it\&. If no file is specified,
/etc/named\&.conf
is read by default\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
51 52 53 54
.PP
Note: files that
\fBnamed\fR
reads in separate parser contexts, such as
Tinderbox User's avatar
Tinderbox User committed
55
rndc\&.key
Automatic Updater's avatar
regen  
Automatic Updater committed
56
and
Tinderbox User's avatar
Tinderbox User committed
57 58
bind\&.keys, are not automatically read by
\fBnamed\-checkconf\fR\&. Configuration errors in these files may cause
Automatic Updater's avatar
regen  
Automatic Updater committed
59 60 61
\fBnamed\fR
to fail to run, even if
\fBnamed\-checkconf\fR
Tinderbox User's avatar
Tinderbox User committed
62
was successful\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
63
\fBnamed\-checkconf\fR
Tinderbox User's avatar
Tinderbox User committed
64
can be run on these files explicitly, however\&.
65
.SH "OPTIONS"
Mark Andrews's avatar
regen  
Mark Andrews committed
66
.PP
Mark Andrews's avatar
regen  
Mark Andrews committed
67 68
\-h
.RS 4
Tinderbox User's avatar
Tinderbox User committed
69
Print the usage summary and exit\&.
Mark Andrews's avatar
regen  
Mark Andrews committed
70 71
.RE
.PP
Tinderbox User's avatar
Tinderbox User committed
72 73 74 75 76
\-j
.RS 4
When loading a zonefile read the journal if it exists\&.
.RE
.PP
Tinderbox User's avatar
Tinderbox User committed
77 78 79 80 81
\-l
.RS 4
List all the configured zones\&. Each line of output contains the zone name, class (e\&.g\&. IN), view, and type (e\&.g\&. master or slave)\&.
.RE
.PP
Tinderbox User's avatar
Tinderbox User committed
82 83 84 85 86 87 88 89 90
\-p
.RS 4
Print out the
named\&.conf
and included files in canonical form if no errors were detected\&. See also the
\fB\-x\fR
option\&.
.RE
.PP
Rob Austein's avatar
regen  
Rob Austein committed
91
\-t \fIdirectory\fR
Mark Andrews's avatar
regen  
Mark Andrews committed
92
.RS 4
Mark Andrews's avatar
regen  
Mark Andrews committed
93
Chroot to
Tinderbox User's avatar
Tinderbox User committed
94
directory
Tinderbox User's avatar
Tinderbox User committed
95
so that include directives in the configuration file are processed as if run by a similarly chrooted
Tinderbox User's avatar
Tinderbox User committed
96
\fBnamed\fR\&.
Mark Andrews's avatar
regen  
Mark Andrews committed
97 98
.RE
.PP
Rob Austein's avatar
regen  
Rob Austein committed
99
\-v
Mark Andrews's avatar
regen  
Mark Andrews committed
100
.RS 4
Mark Andrews's avatar
regen  
Mark Andrews committed
101 102
Print the version of the
\fBnamed\-checkconf\fR
Tinderbox User's avatar
Tinderbox User committed
103
program and exit\&.
Mark Andrews's avatar
regen  
Mark Andrews committed
104 105
.RE
.PP
Tinderbox User's avatar
Tinderbox User committed
106 107
\-x
.RS 4
Tinderbox User's avatar
Tinderbox User committed
108 109 110 111
When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks (\*(Aq?\*(Aq)\&. This allows the contents of
named\&.conf
and related files to be shared \(em for example, when submitting bug reports \(em without compromising private data\&. This option cannot be used without
\fB\-p\fR\&.
Tinderbox User's avatar
Tinderbox User committed
112 113
.RE
.PP
Rob Austein's avatar
regen  
Rob Austein committed
114
\-z
Mark Andrews's avatar
regen  
Mark Andrews committed
115
.RS 4
Mark Andrews's avatar
regen  
Mark Andrews committed
116
Perform a test load of all master zones found in
Tinderbox User's avatar
Tinderbox User committed
117
named\&.conf\&.
Mark Andrews's avatar
regen  
Mark Andrews committed
118 119
.RE
.PP
Rob Austein's avatar
regen  
Rob Austein committed
120
filename
Mark Andrews's avatar
regen  
Mark Andrews committed
121
.RS 4
Tinderbox User's avatar
Tinderbox User committed
122 123
The name of the configuration file to be checked\&. If not specified, it defaults to
/etc/named\&.conf\&.
Mark Andrews's avatar
regen  
Mark Andrews committed
124
.RE
125 126
.SH "RETURN VALUES"
.PP
Mark Andrews's avatar
regen  
Mark Andrews committed
127
\fBnamed\-checkconf\fR
Tinderbox User's avatar
Tinderbox User committed
128
returns an exit status of 1 if errors were detected and 0 otherwise\&.
129 130
.SH "SEE ALSO"
.PP
Mark Andrews's avatar
regen  
Mark Andrews committed
131
\fBnamed\fR(8),
Tinderbox User's avatar
Tinderbox User committed
132 133
\fBnamed-checkzone\fR(8),
BIND 9 Administrator Reference Manual\&.
134 135
.SH "AUTHOR"
.PP
Tinderbox User's avatar
Tinderbox User committed
136
\fBInternet Systems Consortium, Inc\&.\fR
Mark Andrews's avatar
regen  
Mark Andrews committed
137
.SH "COPYRIGHT"
Tinderbox User's avatar
Tinderbox User committed
138
.br
Tinderbox User's avatar
Tinderbox User committed
139
Copyright \(co 2000-2002, 2004, 2005, 2007, 2009, 2014-2016, 2018 Internet Systems Consortium, Inc. ("ISC")
Mark Andrews's avatar
regen  
Mark Andrews committed
140
.br