Files
bind9/doc/misc/rst-options.pl
Ondřej Surý 58e20fa746 Convert the documentation to Sphinx documentation format
The ARM and the manpages have been converted into Sphinx documentation
format.

Sphinx uses reStructuredText as its markup language, and many of its
strengths come from the power and straightforwardness of
reStructuredText and its parsing and translating suite, the Docutils.

(cherry picked from commit 9fb6d11abb)
2020-06-01 09:54:45 +02:00

120 lines
2.2 KiB
Perl

#!/usr/bin/perl
#
# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
#
# 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 http://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;
.. higlight: 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
~~~~~
``/etc/named.conf``
See Also
~~~~~~~~
:manpage:`ddns-confgen(8)`, :manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`rndc(8)`, :manpage:`rndc-confgen(8)`, BIND 9 Administrator Reference Manual.
END