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

Add command-line arguments.

Point to another manual.
Fix some paths.


git-svn-id: svn://bind10.isc.org/svn/bind10/trunk@1492 e5f2f494-b856-4b98-b285-d166d9295462
parent 2603bb09
......@@ -43,17 +43,21 @@
</copyright>
</docinfo>
<!--
NO command line arguments
<refsynopsisdiv>
<cmdsynopsis>
<command></command>
<arg><option></option></arg>
<arg choice="opt"></arg>
<arg choice="opt"></arg>
<command>b10-cmdctl</command>
<arg><option>-a <replaceable>string</replaceable></option></arg>
<arg><option>-h</option></arg>
<arg><option>-i <replaceable>number</replaceable></option></arg>
<arg><option>-p <replaceable>number</replaceable></option></arg>
<arg><option>--address <replaceable>string</replaceable></option></arg>
<arg><option>--help</option></arg>
<arg><option>--idle-timeout <replaceable>number</replaceable></option></arg>
<arg><option>--port <replaceable>number</replaceable></option></arg>
<arg><option>--version</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
-->
<refsect1>
<title>DESCRIPTION</title>
......@@ -68,29 +72,61 @@ NO command line arguments
(username and password validation).
It offers a RESTful style interface.
<!-- TODO: document the RESTful APIs -->
It currently runs on port 8080 on localhost (127.0.0.1).
<!-- TODO: this will be customizable -->
</para>
</refsect1>
<!--
<refsect1>
<title>ARGUMENTS</title>
<para>
<orderedlist numeration="loweralpha">
<listitem>
<para>
</para>
<title>OPTIONS</title>
<para>The arguments are as follows:</para>
<variablelist>
<varlistentry>
<term><option>-a <replaceable>string</replaceable></option>,
<option>--address <replaceable>string</replaceable></option></term>
<listitem><para>
The IP address that <command>b10-cmdctl</command> will listen on.
The default is 127.0.0.1.</para>
</listitem>
<listitem>
<para>
</para>
</varlistentry>
<varlistentry>
<term><option>-h</option>,
<option>--help</option></term>
<listitem><para>
Display command usage.</para>
</listitem>
</orderedlist>
</para>
</varlistentry>
<varlistentry>
<term><option>-i <replaceable>number</replaceable></option>,
<option>--idle-timeout <replaceable>number</replaceable></option></term>
<listitem><para>
The socket idle timeout for the HTTPS connection in seconds.
The default is 1200 seconds.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p <replaceable>number</replaceable></option>,
<option>--port <replaceable>number</replaceable></option></term>
<listitem><para>
The port number <command>b10-cmdctl</command> will listen on.
The default is 8080.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--version</option></term>
<listitem><para>
Display the version number and exit.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
-->
<refsect1>
<title>FILES</title>
......@@ -98,17 +134,17 @@ NO command line arguments
<!-- TODO: permissions -->
<!-- TODO: what about multiple accounts? -->
<!-- TODO: shouldn't the password file name say cmdctl in it? -->
<para><filename>/usr/local/share/bind10/cmdctl-accounts.csv</filename>
<para><filename>/usr/local/etc/bind10/cmdctl-accounts.csv</filename>
&mdash; account database containing the name, hashed password,
and the salt.
</para>
<!-- TODO: replace /usr/local -->
<!-- TODO: permissions -->
<!-- TODO: shouldn't have both in same file, will be configurable -->
<para><filename>/usr/local/share/bind10/cmdctl-keyfile.pem</filename>
<para><filename>/usr/local/etc/bind10/cmdctl-keyfile.pem</filename>
&mdash; contains the Private key.
</para>
<para><filename>/usr/local/share/bind10/cmdctl-certfile.pem</filename>
<para><filename>/usr/local/etc/bind10/cmdctl-certfile.pem</filename>
&mdash; contains the Certificate.
</para>
</refsect1>
......@@ -116,6 +152,9 @@ NO command line arguments
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
......
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