Skip to content

GitLab

Commit ed016f88 authored by Jeremy C. Reed's avatar Jeremy C. Reed
Browse files

Add or change some options in manual pages. 

Features were changed in previous commits, but docs not done at same time.

Also update old ChangeLog entry to mention the removed or changed
options specifically. This was for a previous release and nobody
noticed, but I am doing this for an example for future release
notes.


git-svn-id: svn://bind10.isc.org/svn/bind10/trunk@2693 e5f2f494-b856-4b98-b285-d166d9295462
parent 03e6e0a3
Hide whitespace changes
Inline Side-by-side
Showing with 100 additions and 21 deletions
ChangeLog
View file @ ed016f88
......@@ -218,7 +218,11 @@ bind10-devel-20100602 released on June 2, 2010
a remote server. (Trac #218, svn r2038)
49. [func]* jelte
Use unix domain sockets for msgq. (Trac #183, svn r2009)
Use unix domain sockets for msgq. For b10-msgq, the command
line options --msgq-port and -m were removed. For bind10,
the -msgq-port option was removed, and the -m command line
option was changed to be a filename (instead of port number).
(Trac #183, svn r2009)
48. [func] jelte
bin/auth: Use asio's io_service for the msgq handling.
......
src/bin/auth/b10-auth.xml
View file @ ed016f88
......@@ -21,7 +21,7 @@
<refentry>
<refentryinfo>
<date>March 16, 2010</date>
<date>July 29, 2010</date>
</refentryinfo>
<refmeta>
......@@ -47,6 +47,8 @@
<command>b10-auth</command>
<arg><option>-4</option></arg>
<arg><option>-6</option></arg>
<arg><option>-a <replaceable>address</replaceable></option></arg>
<arg><option>-n</option></arg>
<arg><option>-p <replaceable>number</replaceable></option></arg>
<arg><option>-u <replaceable>username</replaceable></option></arg>
<arg><option>-v</option></arg>
......@@ -96,7 +98,8 @@
<term><option>-4</option></term>
<listitem><para>
Enables IPv4 only mode.
This switch may not be used with <option>-6</option>.
This switch may not be used with <option>-6</option> nor
<option>-a</option>.
By default, it listens on both IPv4 and IPv6 (if capable).
</para></listitem>
</varlistentry>
......@@ -105,11 +108,36 @@
<term><option>-6</option></term>
<listitem><para>
Enables IPv6 only mode.
This switch may not be used with <option>-4</option>.
This switch may not be used with <option>-4</option> nor
<option>-a</option>.
By default, it listens on both IPv4 and IPv6 (if capable).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-a <replaceable>address</replaceable></option></term>
<listitem>
<para>The IPv4 or IPv6 address to listen on.
This switch may not be used with <option>-4</option> nor
<option>-6</option>.
The default is to listen on all addresses.
(This is a short term workaround. This argument may change.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option></term>
<listitem><para>
Do not cache answers in memory.
The default is to use the cache for faster responses.
The cache keeps the most recent 30,000 answers (positive
and negative) in memory for 30 seconds (instead of querying
the data source, such as SQLite3 database, each time).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p <replaceable>number</replaceable></option></term>
<listitem><para>
......
src/bin/bind10/bind10.xml
View file @ ed016f88
......@@ -21,7 +21,7 @@
<refentry>
<refentryinfo>
<date>April 19, 2010</date>
<date>July 29, 2010</date>
</refentryinfo>
<refmeta>
......@@ -45,12 +45,18 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>bind10</command>
<arg><option>-m <replaceable>number</replaceable></option></arg>
<arg><option>-a <replaceable>address</replaceable></option></arg>
<arg><option>-m <replaceable>file</replaceable></option></arg>
<arg><option>-n</option></arg>
<arg><option>-p <replaceable>number</replaceable></option></arg>
<arg><option>-u <replaceable>user</replaceable></option></arg>
<arg><option>-v</option></arg>
<arg><option>-msgq-port <replaceable>number</replaceable></option></arg>
<arg><option>-port <replaceable>number</replaceable></option></arg>
<arg><option>-verbose</option></arg>
<arg><option>--address <replaceable>address</replaceable></option></arg>
<arg><option>--msgq-socket-file <replaceable>file</replaceable></option></arg>
<arg><option>--no-cache</option></arg>
<arg><option>--port <replaceable>number</replaceable></option></arg>
<arg><option>--user <replaceable>user</replaceable></option></arg>
<arg><option>--verbose</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
......@@ -80,16 +86,42 @@
<variablelist>
<varlistentry>
<term><option>-m</option> <replaceable>number</replaceable>, <option>--msgq-port</option> <replaceable>number</replaceable></term>
<term><option>-a</option> <replaceable>address</replaceable>, <option>--address</option> <replaceable>address</replaceable></term>
<listitem>
<para>The port number for the
<citerefentry><refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum></citerefentry>
<para>The IPv4 or IPv6 address for the
<citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
daemon to listen on.
The default is 9912.</para>
The default is to listen on all addresses.
(This is a short term workaround. This argument may change.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option> <replaceable>file</replaceable>,
<option>--msgq-socket-file</option> <replaceable>file</replaceable></term>
<listitem>
<para>The UNIX domain socket file for the
<citerefentry><refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum></citerefentry>
daemon to use.
The default is
<filename>/usr/local/var/bind10-devel/msg_socket</filename>.
<!-- @localstatedir@/@PACKAGE_NAME@/msg_socket -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option>, <option>--no-cache</option></term>
<listitem>
<para>Disables the hot-spot caching used by the
<citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
daemon.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option> <replaceable>number</replaceable>, <option>--port</option> <replaceable>number</replaceable></term>
......@@ -104,6 +136,18 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>-u</option> <replaceable>user</replaceable>, <option>--user</option> <replaceable>name</replaceable></term>
<listitem>
<para>The username for <command>bind10</command> to run as.
<!-- TODO: example more detail. -->
<command>bind10</command> must be initially ran as the
root user to use this option.
The default is to run as the current user.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option>, <option>--verbose</option></term>
<listitem>
......@@ -112,6 +156,7 @@
<!-- TODO: not true about all children yet -->
</listitem>
</varlistentry>
</variablelist>
</refsect1>
......
src/bin/msgq/msgq.xml
View file @ ed016f88
......@@ -21,7 +21,7 @@
<refentry>
<refentryinfo>
<date>April 19, 2010</date>
<date>August 4, 2010</date>
</refentryinfo>
<refmeta>
......@@ -45,9 +45,9 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>b10-msgq</command>
<arg><option>-m <replaceable>number</replaceable></option></arg>
<arg><option>-s <replaceable>file</replaceable></option></arg>
<arg><option>-v</option></arg>
<arg><option>--msgq-port <replaceable>number</replaceable></option></arg>
<arg><option>--socket-file <replaceable>file</replaceable></option></arg>
<arg><option>--verbose</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
......@@ -111,12 +111,14 @@
<variablelist>
<varlistentry>
<term><option>-m <replaceable>number</replaceable></option>,
<option>--msgq-port <replaceable>number</replaceable></option></term>
<term><option>-s <replaceable>file</replaceable></option>,
<option>--socket-file <replaceable>file</replaceable></option></term>
<listitem><para>
The port number that <command>b10-msgq</command> will listen on.
The default is 9912.</para>
</listitem>
The UNIX domain socket file this daemon will use.
The default is
<filename>/usr/local/var/bind10-devel/msg_socket</filename>.
<!-- @localstatedir@/@PACKAGE_NAME@/msg_socket -->
</para></listitem>
</varlistentry>
<varlistentry>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment