contrib/bind9/bin/check/named-checkconf.8

   1 .\" Copyright (C) 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000-2002 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and/or distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14 .\" PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $Id$
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\"     Title: named\-checkconf
  21 .\"    Author:
  22 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  23 .\"      Date: June 14, 2000
  24 .\"    Manual: BIND9
  25 .\"    Source: BIND9
  26 .\"
  27 .TH "NAMED\-CHECKCONF" "8" "June 14, 2000" "BIND9" "BIND9"
  28 .\" disable hyphenation
  29 .nh
  30 .\" disable justification (adjust text to left margin only)
  31 .ad l
  32 .SH "NAME"
  33 named\-checkconf \- named configuration file syntax checking tool
  34 .SH "SYNOPSIS"
  35 .HP 16
  36 \fBnamed\-checkconf\fR [\fB\-h\fR] [\fB\-v\fR] [\fB\-j\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] {filename} [\fB\-p\fR] [\fB\-x\fR] [\fB\-z\fR]
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBnamed\-checkconf\fR
  40 checks the syntax, but not the semantics, of a
  41 \fBnamed\fR
  42 configuration file. The file is parsed and checked for syntax errors, along with all files included by it. If no file is specified,
  43 \fI/etc/named.conf\fR
  44 is read by default.
  45 .PP
  46 Note: files that
  47 \fBnamed\fR
  48 reads in separate parser contexts, such as
  49 \fIrndc.key\fR
  50 and
  51 \fIbind.keys\fR, are not automatically read by
  52 \fBnamed\-checkconf\fR. Configuration errors in these files may cause
  53 \fBnamed\fR
  54 to fail to run, even if
  55 \fBnamed\-checkconf\fR
  56 was successful.
  57 \fBnamed\-checkconf\fR
  58 can be run on these files explicitly, however.
  59 .SH "OPTIONS"
  60 .PP
  61 \-h
  62 .RS 4
  63 Print the usage summary and exit.
  64 .RE
  65 .PP
  66 \-t \fIdirectory\fR
  67 .RS 4
  68 Chroot to
  69 \fIdirectory\fR
  70 so that include directives in the configuration file are processed as if run by a similarly chrooted named.
  71 .RE
  72 .PP
  73 \-v
  74 .RS 4
  75 Print the version of the
  76 \fBnamed\-checkconf\fR
  77 program and exit.
  78 .RE
  79 .PP
  80 \-p
  81 .RS 4
  82 Print out the
  83 \fInamed.conf\fR
  84 and included files in canonical form if no errors were detected.
  85 .RE
  86 .PP
  87 \-x
  88 .RS 4
  89 When printing the configuration files in canonical form, obscure shared secrets by replacing them with strings of question marks ('?'). This allows the contents of
  90 \fInamed.conf\fR
  91 and related files to be shared \(em for example, when submitting bug reports \(em without compromising private data. This option cannot be used without
  92 \fB\-p\fR.
  93 .RE
  94 .PP
  95 \-z
  96 .RS 4
  97 Perform a test load of all master zones found in
  98 \fInamed.conf\fR.
  99 .RE
 100 .PP
 101 \-j
 102 .RS 4
 103 When loading a zonefile read the journal if it exists.
 104 .RE
 105 .PP
 106 filename
 107 .RS 4
 108 The name of the configuration file to be checked. If not specified, it defaults to
 109 \fI/etc/named.conf\fR.
 110 .RE
 111 .SH "RETURN VALUES"
 112 .PP
 113 \fBnamed\-checkconf\fR
 114 returns an exit status of 1 if errors were detected and 0 otherwise.
 115 .SH "SEE ALSO"
 116 .PP
 117 \fBnamed\fR(8),
 118 \fBnamed\-checkzone\fR(8),
 119 BIND 9 Administrator Reference Manual.
 120 .SH "AUTHOR"
 121 .PP
 122 Internet Systems Consortium
 123 .SH "COPYRIGHT"
 124 Copyright \(co 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
 125 .br
 126 Copyright \(co 2000\-2002 Internet Software Consortium.
 127 .br