6a2daddf5b
Commit bdb777b2a2 updated the man pages
to contents produced using:
- Sphinx 4.0.2
- sphinx-rtd-theme 0.5.2
- docutils 0.17.1
However, sphinx-rtd-theme 0.5.2 is incompatible with versions 0.17+ of
the docutils package. This problem was addressed in the Docker image
used for building man pages by downgrading the docutils package to
version 0.16.
Regenerate the man pages again, this time using:
- Sphinx 4.0.2
- sphinx-rtd-theme 0.5.2
- docutils 0.16
This is necessary to prevent the "docs" GitLab CI job from failing.
109 lines
3.6 KiB
Plaintext
109 lines
3.6 KiB
Plaintext
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "NAMED-CHECKCONF" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
|
|
.SH NAME
|
|
named-checkconf \- named configuration file syntax checking tool
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.SH SYNOPSIS
|
|
.sp
|
|
\fBnamed\-checkconf\fP [\fB\-chjlvz\fP] [\fB\-p\fP [\fB\-x\fP ]] [\fB\-t\fP directory] {filename}
|
|
.SH DESCRIPTION
|
|
.sp
|
|
\fBnamed\-checkconf\fP checks the syntax, but not the semantics, of a
|
|
\fBnamed\fP configuration file. The file, along with all files included by it, is parsed and checked for syntax
|
|
errors. If no file is specified,
|
|
\fB/etc/named.conf\fP is read by default.
|
|
.sp
|
|
Note: files that \fBnamed\fP reads in separate parser contexts, such as
|
|
\fBrndc.key\fP and \fBbind.keys\fP, are not automatically read by
|
|
\fBnamed\-checkconf\fP\&. Configuration errors in these files may cause
|
|
\fBnamed\fP to fail to run, even if \fBnamed\-checkconf\fP was successful.
|
|
However, \fBnamed\-checkconf\fP can be run on these files explicitly.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \fB\-h\fP
|
|
This option prints the usage summary and exits.
|
|
.TP
|
|
.B \fB\-j\fP
|
|
When loading a zonefile, this option instructs \fBnamed\fP to read the journal if it exists.
|
|
.TP
|
|
.B \fB\-l\fP
|
|
This option lists all the configured zones. Each line of output contains the zone
|
|
name, class (e.g. IN), view, and type (e.g. primary or secondary).
|
|
.TP
|
|
.B \fB\-c\fP
|
|
This option specifies that only the "core" configuration should be checked. This suppresses the loading of
|
|
plugin modules, and causes all parameters to \fBplugin\fP statements to
|
|
be ignored.
|
|
.TP
|
|
.B \fB\-i\fP
|
|
This option ignores warnings on deprecated options.
|
|
.TP
|
|
.B \fB\-p\fP
|
|
This option prints out the \fBnamed.conf\fP and included files in canonical form if
|
|
no errors were detected. See also the \fB\-x\fP option.
|
|
.TP
|
|
.B \fB\-t directory\fP
|
|
This option instructs \fBnamed\fP to chroot to \fBdirectory\fP, so that \fBinclude\fP directives in the
|
|
configuration file are processed as if run by a similarly chrooted
|
|
\fBnamed\fP\&.
|
|
.TP
|
|
.B \fB\-v\fP
|
|
This option prints the version of the \fBnamed\-checkconf\fP program and exits.
|
|
.TP
|
|
.B \fB\-x\fP
|
|
When printing the configuration files in canonical form, this option obscures
|
|
shared secrets by replacing them with strings of question marks
|
|
(\fB?\fP). This allows the contents of \fBnamed.conf\fP and related files
|
|
to be shared \- for example, when submitting bug reports \-
|
|
without compromising private data. This option cannot be used without
|
|
\fB\-p\fP\&.
|
|
.TP
|
|
.B \fB\-z\fP
|
|
This option performs a test load of all zones of type \fBprimary\fP found in \fBnamed.conf\fP\&.
|
|
.TP
|
|
.B \fBfilename\fP
|
|
This indicates the name of the configuration file to be checked. If not specified,
|
|
it defaults to \fB/etc/named.conf\fP\&.
|
|
.UNINDENT
|
|
.SH RETURN VALUES
|
|
.sp
|
|
\fBnamed\-checkconf\fP returns an exit status of 1 if errors were detected
|
|
and 0 otherwise.
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fBnamed(8)\fP, \fBnamed\-checkzone(8)\fP, BIND 9 Administrator Reference Manual.
|
|
.SH AUTHOR
|
|
Internet Systems Consortium
|
|
.SH COPYRIGHT
|
|
2021, Internet Systems Consortium
|
|
.\" Generated by docutils manpage writer.
|
|
.
|