|
@@ -43,17 +43,21 @@
|
|
</copyright>
|
|
</copyright>
|
|
</docinfo>
|
|
</docinfo>
|
|
|
|
|
|
-<!--
|
|
|
|
-NO command line arguments
|
|
|
|
<refsynopsisdiv>
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<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>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
</refsynopsisdiv>
|
|
--->
|
|
|
|
|
|
|
|
<refsect1>
|
|
<refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<title>DESCRIPTION</title>
|
|
@@ -68,29 +72,61 @@ NO command line arguments
|
|
(username and password validation).
|
|
(username and password validation).
|
|
It offers a RESTful style interface.
|
|
It offers a RESTful style interface.
|
|
<!-- TODO: document the RESTful APIs -->
|
|
<!-- TODO: document the RESTful APIs -->
|
|
- It currently runs on port 8080 on localhost (127.0.0.1).
|
|
|
|
-<!-- TODO: this will be customizable -->
|
|
|
|
</para>
|
|
</para>
|
|
</refsect1>
|
|
</refsect1>
|
|
|
|
|
|
-<!--
|
|
|
|
<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>
|
|
- <listitem>
|
|
|
|
- <para>
|
|
|
|
- </para>
|
|
|
|
|
|
+ </varlistentry>
|
|
|
|
+
|
|
|
|
+ <varlistentry>
|
|
|
|
+ <term><option>-h</option>,
|
|
|
|
+ <option>--help</option></term>
|
|
|
|
+ <listitem><para>
|
|
|
|
+ Display command usage.</para>
|
|
</listitem>
|
|
</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>
|
|
--->
|
|
|
|
|
|
|
|
<refsect1>
|
|
<refsect1>
|
|
<title>FILES</title>
|
|
<title>FILES</title>
|
|
@@ -98,17 +134,17 @@ NO command line arguments
|
|
<!-- TODO: permissions -->
|
|
<!-- TODO: permissions -->
|
|
<!-- TODO: what about multiple accounts? -->
|
|
<!-- TODO: what about multiple accounts? -->
|
|
<!-- TODO: shouldn't the password file name say cmdctl in it? -->
|
|
<!-- 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>
|
|
— account database containing the name, hashed password,
|
|
— account database containing the name, hashed password,
|
|
and the salt.
|
|
and the salt.
|
|
</para>
|
|
</para>
|
|
<!-- TODO: replace /usr/local -->
|
|
<!-- TODO: replace /usr/local -->
|
|
<!-- TODO: permissions -->
|
|
<!-- TODO: permissions -->
|
|
<!-- TODO: shouldn't have both in same file, will be configurable -->
|
|
<!-- 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>
|
|
— contains the Private key.
|
|
— contains the Private key.
|
|
</para>
|
|
</para>
|
|
- <para><filename>/usr/local/share/bind10/cmdctl-certfile.pem</filename>
|
|
|
|
|
|
+ <para><filename>/usr/local/etc/bind10/cmdctl-certfile.pem</filename>
|
|
— contains the Certificate.
|
|
— contains the Certificate.
|
|
</para>
|
|
</para>
|
|
</refsect1>
|
|
</refsect1>
|
|
@@ -117,6 +153,9 @@ NO command line arguments
|
|
<title>SEE ALSO</title>
|
|
<title>SEE ALSO</title>
|
|
<para>
|
|
<para>
|
|
<citerefentry>
|
|
<citerefentry>
|
|
|
|
+ <refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum>
|
|
|
|
+ </citerefentry>,
|
|
|
|
+ <citerefentry>
|
|
<refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
|
|
<refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
|
|
</citerefentry>,
|
|
</citerefentry>,
|
|
<citerefentry>
|
|
<citerefentry>
|