From: Jelte Jansen Date: Fri, 23 Mar 2012 10:29:09 +0000 (+0100) Subject: [963] fix b10-dbutil.8 creation rule add it to git X-Git-Tag: trac2351_base~226^2~116^2~95^2~2^2~8 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0f487a998063a01ea16e8be048076f53b11afd02;p=thirdparty%2Fkea.git [963] fix b10-dbutil.8 creation rule add it to git --- diff --git a/src/bin/dbutil/Makefile.am b/src/bin/dbutil/Makefile.am index 1ede4d6447..5c05757487 100644 --- a/src/bin/dbutil/Makefile.am +++ b/src/bin/dbutil/Makefile.am @@ -12,7 +12,7 @@ CLEANFILES = b10-dbutil b10-dbutil.pyc if ENABLE_MAN b10-dbutil.8: b10-dbutil.xml - xsltproc --novalid --xinclude --nonet -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $(srcdir)/bindctl.xml + xsltproc --novalid --xinclude --nonet -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $(srcdir)/b10-dbutil.xml endif diff --git a/src/bin/dbutil/b10-dbutil.8 b/src/bin/dbutil/b10-dbutil.8 new file mode 100644 index 0000000000..3014610cc2 --- /dev/null +++ b/src/bin/dbutil/b10-dbutil.8 @@ -0,0 +1,87 @@ +'\" t +.\" Title: b10-dbutil +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" Date: March 20, 2012 +.\" Manual: BIND10 +.\" Source: BIND10 +.\" Language: English +.\" +.TH "B10\-DBUTIL" "8" "March 20, 2012" "BIND10" "BIND10" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +b10-dbutil \- Zone Database Maintenance Utility +.SH "SYNOPSIS" +.HP \w'\fBb10\-dbutil\ \-\-check\fR\ 'u +\fBb10\-dbutil \-\-check\fR [\-\-verbose] [\fIdbfile\fR] +.HP \w'\fBb10\-dbutil\ \-\-upgrade\fR\ 'u +\fBb10\-dbutil \-\-upgrade\fR [\-\-noconfirm] [\-\-verbose] [\fIdbfile\fR] +.SH "DESCRIPTION" +.PP +The +\fBb10\-dbutil\fR +utility is a general administration utility for SQL databases\&. (Currently only SQLite is supported by BIND 10\&.) It can report the current verion of the schema, and upgrade an existing database to the latest version of the schema\&. +.PP + +\fBb10\-dbutil\fR +operates in one of two modes, check mode or upgrade mode\&. +.PP +In check mode (\fBb10\-dbutil \-\-check\fR), the utility reads the version of the database schema from the database and prints it\&. It will tell you whether the schema is at the latest version supported by BIND 10\&. +.PP +When the upgrade function is selected (\fBb10\-dbutil \-\-upgrade\fR), the utility takes a copy of the database, then upgrades it to the latest version of the schema\&. The contents of the database remain intact\&. (The backup file is a file in the same directory as the database file\&. It has the same name, with "\&.backup" appended to it\&. If a file of that name already exists, the file will have the suffix "\&.backup\-1"\&. If that exists, the file will be suffixed "\&.backup\-2", and so on\&.) +.PP +When upgrading the database, it is +\fIstrongly\fR +recommended that BIND 10 not be running while the upgrade is in progress\&. +.SH "ARGUMENTS" +.PP +The arguments are as follows: +.PP +\fB\-\-check\fR +.RS 4 +Selects the version check function, which reports the current version of the database\&. This is incompatible with the \-\-upgrade option\&. +.RE +.PP +\fB\-\-noconfirm\fR +.RS 4 +Only valid with \-\-upgrade, this disables the prompt\&. Normally the utility will print a warning that an upgrade is about to take place and request that you type "Yes" to continue\&. If this switch is given on the command line, no prompt will be issued: the utility will just perform the upgrade\&. +.RE +.PP +\fB\-\-upgrade\fR +.RS 4 +Selects the upgrade function, which upgrades the database to the latest version of the schema\&. This is incompatible with the \-\-upgrade option\&. +.sp +The upgrade function will upgrade a BIND 10 database \- no matter how old the schema \- preserving all data\&. A backup file is created before the upgrade (with the same name as the database, but with "\&.backup" suffixed to it)\&. If the upgrade fails, this file can be copied back to restore the original database\&. +.RE +.PP +\fB\-\-verbose\fR +.RS 4 +Enable verbose mode\&. Each SQL command issued by the utility will be printed to before it is executed\&. +.RE +.PP +\fB\fIdbfile\fR\fR +.RS 4 +Name of the database file to check of upgrade\&. +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2012 Internet Systems Consortium, Inc. ("ISC") +.br diff --git a/src/bin/xfrout/b10-xfrout.8 b/src/bin/xfrout/b10-xfrout.8 index 3670ec5067..69682a3235 100644 --- a/src/bin/xfrout/b10-xfrout.8 +++ b/src/bin/xfrout/b10-xfrout.8 @@ -9,6 +9,15 @@ .\" .TH "B10\-XFROUT" "8" "February 28\&. 2012" "BIND10" "BIND10" .\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation @@ -82,26 +91,6 @@ A list of JSON objects (i\&.e\&. maps) that define per zone configuration concer \fBb10\-xfrout\fR\&. The supported names of each object are "origin" (the origin name of the zone), "class" (the RR class of the zone, optional, default to "IN"), and "transfer_acl" (ACL only applicable to transfer requests for that zone)\&. See the BIND 10 Guide for configuration examples\&. The default is an empty list, that is, no zone specific configuration\&. -.PP - -\fIlog_name\fR -.PP - -\fIlog_file\fR -The location of the log file if using a file channel\&. If undefined, then the file channel is closed\&. The default is -/usr/local/var/bind10\-devel/log/Xfrout\&.log\&. -.PP - -\fIlog_severity\fR -The default is "debug"\&. -.PP - -\fIlog_versions\fR -The default is 5\&. -.PP - -\fIlog_max_bytes\fR -The default is 1048576\&. .if n \{\ .sp .\}