mirror of
https://gitlab.isc.org/isc-projects/bind9
synced 2025-08-29 05:28:00 +00:00
b42681c4e9
Replace the hard-coded paths for various BIND 9 files (configuration, pid, etc.) in the man pages and ARM with compile-time values using the sphinx-build replace system. This is more complicated, because the restructured text specification doesn't allow |substitions| inside ``code-blocks``, so for each specific file we had to create own substition which is sub-optimal, but it is only way how to do this without adding Sphinx extension.
136 lines
2.7 KiB
Perl
136 lines
2.7 KiB
Perl
#!/usr/bin/perl
|
|
|
|
# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
#
|
|
# SPDX-License-Identifier: MPL-2.0
|
|
#
|
|
# 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 https://mozilla.org/MPL/2.0/.
|
|
#
|
|
# See the COPYRIGHT file distributed with this work for additional
|
|
# information regarding copyright ownership.
|
|
|
|
use warnings;
|
|
use strict;
|
|
|
|
if (@ARGV < 1) {
|
|
print STDERR <<'END';
|
|
usage:
|
|
perl rst-options.pl options_file >named.conf.rst
|
|
END
|
|
exit 1;
|
|
}
|
|
|
|
my $FILE = shift;
|
|
|
|
open (FH, "<", $FILE) or die "Can't open $FILE";
|
|
|
|
print <<END;
|
|
.. Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
..
|
|
.. SPDX-License-Identifier: MPL-2.0
|
|
..
|
|
.. 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 https://mozilla.org/MPL/2.0/.
|
|
..
|
|
.. See the COPYRIGHT file distributed with this work for additional
|
|
.. information regarding copyright ownership.
|
|
|
|
END
|
|
|
|
print <<END;
|
|
.. highlight: console
|
|
|
|
named.conf - configuration file for **named**
|
|
---------------------------------------------
|
|
|
|
Synopsis
|
|
~~~~~~~~
|
|
|
|
:program:`named.conf`
|
|
|
|
Description
|
|
~~~~~~~~~~~
|
|
|
|
``named.conf`` is the configuration file for ``named``. Statements are
|
|
enclosed in braces and terminated with a semi-colon. Clauses in the
|
|
statements are also semi-colon terminated. The usual comment styles are
|
|
supported:
|
|
|
|
C style: /\\* \\*/
|
|
|
|
C++ style: // to end of line
|
|
|
|
Unix style: # to end of line
|
|
|
|
END
|
|
|
|
# skip preamble
|
|
my $preamble = 0;
|
|
while (<FH>) {
|
|
if (m{^\s*$}) {
|
|
last if $preamble > 0;
|
|
} else {
|
|
$preamble++;
|
|
}
|
|
}
|
|
|
|
my $blank = 0;
|
|
while (<FH>) {
|
|
if (m{// not.*implemented} || m{// obsolete} ||
|
|
m{// ancient} || m{// test.*only})
|
|
{
|
|
next;
|
|
}
|
|
|
|
s{ // not configured}{};
|
|
s{ // non-operational}{};
|
|
s{ (// )*may occur multiple times}{};
|
|
s{<([a-z0-9_-]+)>}{$1}g;
|
|
s{ // deprecated,*}{// deprecated};
|
|
s{[[]}{[}g;
|
|
s{[]]}{]}g;
|
|
s{ }{\t}g;
|
|
if (m{^([a-z0-9-]+) }) {
|
|
my $HEADING = uc $1;
|
|
my $UNDERLINE = $HEADING;
|
|
$UNDERLINE =~ s/./^/g;
|
|
print $HEADING . "\n";
|
|
print $UNDERLINE . "\n\n";
|
|
if ($HEADING eq "TRUSTED-KEYS") {
|
|
print "Deprecated - see DNSSEC-KEYS.\n\n";
|
|
}
|
|
if ($HEADING eq "MANAGED-KEYS") {
|
|
print "See DNSSEC-KEYS.\n\n" ;
|
|
}
|
|
print "::\n\n";
|
|
}
|
|
|
|
if (m{^\s*$}) {
|
|
if (!$blank) {
|
|
print "\n";
|
|
$blank = 1;
|
|
}
|
|
next;
|
|
} else {
|
|
$blank = 0;
|
|
}
|
|
print " " . $_;
|
|
|
|
}
|
|
|
|
print <<END;
|
|
Files
|
|
~~~~~
|
|
|
|
|named_conf|
|
|
|
|
See Also
|
|
~~~~~~~~
|
|
|
|
:manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`rndc(8)`, :manpage:`rndc-confgen(8)`, :manpage:`tsig-keygen(8)`, BIND 9 Administrator Reference Manual.
|
|
|
|
END
|