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

For bindctl manual: cleanup, add options.

parent 5dd96968
......@@ -2,12 +2,12 @@
.\" Title: bindctl
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: March 18, 2010
.\" Date: December 23, 2010
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "BINDCTL" "1" "March 18, 2010" "BIND10" "BIND10"
.TH "BINDCTL" "1" "December 23, 2010" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -22,7 +22,7 @@
bindctl \- control and configure BIND 10
.SH "SYNOPSIS"
.HP \w'\fBbindctl\fR\ 'u
\fBbindctl\fR
\fBbindctl\fR [\fB\-a\ \fR\fB\fIaddress\fR\fR] [\fB\-h\fR] [\fB\-c\ \fR\fB\fIfile\fR\fR] [\fB\-p\ \fR\fB\fInumber\fR\fR] [\fB\-\-address\ \fR\fB\fIaddress\fR\fR] [\fB\-\-help\fR] [\fB\-\-certificate\-chain\ \fR\fB\fIfile\fR\fR] [\fB\-\-port\ \fR\fB\fInumber\fR\fR] [\fB\-\-version\fR]
.SH "DESCRIPTION"
.PP
The
......@@ -32,15 +32,64 @@ via its interactive command interpreter\&.
.PP
\fBbindctl\fR
communicates over the REST\-ful interface provided by
communicates over a HTTPS REST\-ful interface provided by
\fBb10-cmdctl\fR(8)\&. The
\fBb10-cfgmgr\fR(8)
daemon stores the configurations and defines the commands\&.
.SH "ARGUMENTS"
.PP
The arguments are as follows:
.PP
\fB\-a\fR \fIaddress\fR, \fB\-\-address\fR \fIaddress\fR
.RS 4
The IPv4 or IPv6 address to use to connect to the running
\fBb10-cmdctl\fR(8)
daemon\&. The default is 127\&.0\&.0\&.1\&.
.RE
.PP
\fB\-c\fR \fIfile\fR, \fB\-\-certificate\-chain\fR \fIfile\fR
.RS 4
The PEM formatted server certificate validation chain file\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Display command usage\&.
.RE
.PP
\fB\-p\fR \fInumber\fR, \fB\-\-port\fR \fInumber\fR
.RS 4
The port number to use to connect to the running
\fBb10-cmdctl\fR(8)
daemon\&. The default is 8080\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
This default port number may change\&.
.sp .5v
.RE
.RE
.PP
\fB\-\-version\fR
.RS 4
Display the version number and exit\&.
.RE
.SH "AUTHENTICATION"
.PP
The tool will authenticate using a username and password\&. On the first successful login, it will save the details to
~/\&.bind10/default_user\&.csv
which will be used for later uses of
\fBbindctl\fR\&.
.SH "USAGE"
.PP
The
\fBbindctl\fR
......
......@@ -21,7 +21,7 @@
<refentry>
<refentryinfo>
<date>March 18, 2010</date>
<date>December 23, 2010</date>
</refentryinfo>
<refmeta>
......@@ -45,6 +45,15 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>bindctl</command>
<arg><option>-a <replaceable>address</replaceable></option></arg>
<arg><option>-h</option></arg>
<arg><option>-c <replaceable>file</replaceable></option></arg>
<arg><option>-p <replaceable>number</replaceable></option></arg>
<arg><option>--address <replaceable>address</replaceable></option></arg>
<arg><option>--help</option></arg>
<arg><option>--certificate-chain <replaceable>file</replaceable></option></arg>
<arg><option>--port <replaceable>number</replaceable></option></arg>
<arg><option>--version</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
......@@ -60,7 +69,7 @@
</para>
<para>
<command>bindctl</command> communicates over the REST-ful
<command>bindctl</command> communicates over a HTTPS REST-ful
interface provided by
<citerefentry><refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
The
......@@ -68,6 +77,75 @@
daemon stores the configurations and defines the commands.
</para>
</refsect1>
<refsect1>
<title>ARGUMENTS</title>
<para>The arguments are as follows:</para>
<variablelist>
<varlistentry>
<term><option>-a</option> <replaceable>address</replaceable>, <option>--address</option> <replaceable>address</replaceable></term>
<listitem>
<para>The IPv4 or IPv6 address to use to connect to the running
<citerefentry><refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
daemon.
The default is 127.0.0.1.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option> <replaceable>file</replaceable>,
<option>--certificate-chain</option> <replaceable>file</replaceable></term>
<listitem>
<para>The PEM formatted server certificate validation chain file.
</para>
<!-- TODO: any default? -->
<!-- TODO: any way to choose this for cmdctl? -->
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>,
<option>--help</option></term>
<listitem><para>
Display command usage.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option> <replaceable>number</replaceable>, <option>--port</option> <replaceable>number</replaceable></term>
<listitem>
<para>The port number to use to connect to the running
<citerefentry><refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
daemon.
The default is 8080.</para>
<!-- TODO: -->
<note><simpara>This default port number may change.</simpara></note>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--version</option></term>
<listitem><para>
Display the version number and exit.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>AUTHENTICATION</title>
<para>
The tool will authenticate using a username and password.
On the first successful login, it will save the details to
......@@ -75,6 +153,13 @@
which will be used for later uses of <command>bindctl</command>.
</para>
<!-- TODO: mention HTTPS? -->
</refsect1>
<refsect1>
<title>USAGE</title>
<para>
The <command>bindctl</command> prompt shows
<quote>&gt; </quote>.
......
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