external/bsd/bind/dist/bin/check/named-checkconf.8

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