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

   1 .\" Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015 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 .hy 0
  17 .ad l
  18 '\" t
  19 .\"     Title: named-checkconf
  20 .\"    Author:
  21 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
  22 .\"      Date: 2014-01-10
  23 .\"    Manual: BIND9
  24 .\"    Source: ISC
  25 .\"  Language: English
  26 .\"
  27 .TH "NAMED\-CHECKCONF" "8" "2014\-01\-10" "ISC" "BIND9"
  28 .\" -----------------------------------------------------------------
  29 .\" * Define some portability stuff
  30 .\" -----------------------------------------------------------------
  31 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32 .\" http://bugs.debian.org/507673
  33 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .ie \n(.g .ds Aq \(aq
  36 .el       .ds Aq '
  37 .\" -----------------------------------------------------------------
  38 .\" * set default formatting
  39 .\" -----------------------------------------------------------------
  40 .\" disable hyphenation
  41 .nh
  42 .\" disable justification (adjust text to left margin only)
  43 .ad l
  44 .\" -----------------------------------------------------------------
  45 .\" * MAIN CONTENT STARTS HERE *
  46 .\" -----------------------------------------------------------------
  47 .SH "NAME"
  48 named-checkconf \- named configuration file syntax checking tool
  49 .SH "SYNOPSIS"
  50 .HP \w'\fBnamed\-checkconf\fR\ 'u
  51 \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]
  52 .SH "DESCRIPTION"
  53 .PP
  54 \fBnamed\-checkconf\fR
  55 checks the syntax, but not the semantics, of a
  56 \fBnamed\fR
  57 configuration file\&. The file is parsed and checked for syntax errors, along with all files included by it\&. If no file is specified,
  58 /etc/named\&.conf
  59 is read by default\&.
  60 .PP
  61 Note: files that
  62 \fBnamed\fR
  63 reads in separate parser contexts, such as
  64 rndc\&.key
  65 and
  66 bind\&.keys, are not automatically read by
  67 \fBnamed\-checkconf\fR\&. Configuration errors in these files may cause
  68 \fBnamed\fR
  69 to fail to run, even if
  70 \fBnamed\-checkconf\fR
  71 was successful\&.
  72 \fBnamed\-checkconf\fR
  73 can be run on these files explicitly, however\&.
  74 .SH "OPTIONS"
  75 .PP
  76 \-h
  77 .RS 4
  78 Print the usage summary and exit\&.
  79 .RE
  80 .PP
  81 \-t \fIdirectory\fR
  82 .RS 4
  83 Chroot to
  84 directory
  85 so that include directives in the configuration file are processed as if run by a similarly chrooted named\&.
  86 .RE
  87 .PP
  88 \-v
  89 .RS 4
  90 Print the version of the
  91 \fBnamed\-checkconf\fR
  92 program and exit\&.
  93 .RE
  94 .PP
  95 \-p
  96 .RS 4
  97 Print out the
  98 named\&.conf
  99 and included files in canonical form if no errors were detected\&.
 100 .RE
 101 .PP
 102 \-x
 103 .RS 4
 104 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
 105 named\&.conf
 106 and related files to be shared \(em for example, when submitting bug reports \(em without compromising private data\&. This option cannot be used without
 107 \fB\-p\fR\&.
 108 .RE
 109 .PP
 110 \-z
 111 .RS 4
 112 Perform a test load of all master zones found in
 113 named\&.conf\&.
 114 .RE
 115 .PP
 116 \-j
 117 .RS 4
 118 When loading a zonefile read the journal if it exists\&.
 119 .RE
 120 .PP
 121 filename
 122 .RS 4
 123 The name of the configuration file to be checked\&. If not specified, it defaults to
 124 /etc/named\&.conf\&.
 125 .RE
 126 .SH "RETURN VALUES"
 127 .PP
 128 \fBnamed\-checkconf\fR
 129 returns an exit status of 1 if errors were detected and 0 otherwise\&.
 130 .SH "SEE ALSO"
 131 .PP
 132 \fBnamed\fR(8),
 133 \fBnamed-checkzone\fR(8),
 134 BIND 9 Administrator Reference Manual\&.
 135 .SH "AUTHOR"
 136 .PP
 137 \fBInternet Systems Consortium, Inc\&.\fR
 138 .SH "COPYRIGHT"
 139 .br
 140 Copyright \(co 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
 141 .br
 142 Copyright \(co 2000-2002 Internet Software Consortium.
 143 .br