bindctl.xml 10.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
	       [<!ENTITY mdash "&#8212;">]>
<!--
 - Copyright (C) 2010  Internet Systems Consortium, Inc. ("ISC")
 -
 - Permission to use, copy, modify, and/or distribute this software for any
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
-->

<refentry>

  <refentryinfo>
23
    <date>December 23, 2010</date>
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
  </refentryinfo>

  <refmeta>
    <refentrytitle>bindctl</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo>BIND10</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>bindctl</refname>
    <refpurpose>control and configure BIND 10</refpurpose>
  </refnamediv>

  <docinfo>
    <copyright>
      <year>2010</year>
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>bindctl</command>
47 48 49 50 51 52 53
      <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>
54
      <arg><option>--csv-file-dir<replaceable>file</replaceable></option></arg>
55 56
      <arg><option>--port <replaceable>number</replaceable></option></arg>
      <arg><option>--version</option></arg>
57 58 59 60 61 62 63 64 65 66 67 68 69 70
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      The <command>bindctl</command> tool is a user interface to
      the BIND 10 services.  The program can be used to control
      the components and configure the BIND 10 options.  The options
      may be specified
<!-- TODO: as command-line arguments, or --> via its
      interactive command interpreter.
    </para>

Jeremy C. Reed's avatar
Jeremy C. Reed committed
71
    <para>
72
      <command>bindctl</command> communicates over a HTTPS REST-ful
Jeremy C. Reed's avatar
Jeremy C. Reed committed
73 74 75 76 77 78 79
      interface provided by
      <citerefentry><refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
      The
<citerefentry><refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>
      daemon stores the configurations and defines the commands.
    </para>

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
  </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>

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
      <varlistentry>
        <term>
	  <option>--csv-file-dir</option><replaceable>file</replaceable>
	</term>

        <listitem>
          <para>
	    The directory name in which the user/password CSV file
            is stored (see AUTHENTICATION).
	    By default this option doesn't have any value,
	    in which case the ".bind10" directory under the user's
            home directory will be used.
          </para>
         </listitem>
      </varlistentry>

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
      <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>

165 166 167
    <para>
      The tool will authenticate using a username and password.
      On the first successful login, it will save the details to
168
      a comma-separated-value (CSV) file
169
      which will be used for later uses of <command>bindctl</command>.
170 171
      The file name is <filename>default_user.csv</filename>
      located under the directory specified by the --csv-file-dir option.
172 173
    </para>

174 175 176 177 178 179 180
<!-- TODO: mention HTTPS? -->

  </refsect1>

  <refsect1>
    <title>USAGE</title>

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
    <para>
      The <command>bindctl</command> prompt shows
      <quote>&gt; </quote>.
       The prompt will also display the location if changed.
       The options are based on the module in use.
       The usage is:
       <command>module</command> <command>command</command> <replaceable>param1 = value1 , <replaceable>param2 = value2</replaceable></replaceable>
     </para>

     <para>
       <command>bindctl</command>'s
       interactive interface provides command-line completion and
       hints.  Press the Tab key to get a hint for the module,
       command, and/or parameters.
<!-- TODO: no hints at a blank line though ? -->

      The arrow keys and Emacs-style editing keys may be used to edit
      and recall previous lines.
<!-- TODO:  all Emacs-style editing keys? -->
     </para>

     <para>
       You can use the <command>help</command>
       keyword to receive usage assistance for a module or a module's
       command.
     </para>

     <para>
       The <command>quit</command>
       command is used to exit
       <command>bindctl</command>
       (and doesn't stop the BIND 10 services).
     </para>

     <para>
       The following module is available by default:
       <command>config</command> for Configuration commands.
<!-- TODO: or is config from the cfgmgr module? -->
       Additional modules may be available, such as
       <command>Boss</command>, <command>Xfrin</command>, and
       <command>Auth</command>.
     </para>

<!--
.Sh CONFIGURATION COMMANDS
The following configuration commands are recognized by
.Nm :
.Bl -tag -width Ic
.It Ic add Ar identifier Ar value
Add a value to a list.
.\" TODO: explain better
.\" TODO: define list, map, others ...
.\" TODO: why the value?
.It Ic commit
Commit all local changes.
.\" TODO: what does this do?
.It Ic go Ar identifier
Go to the specified location within the configuration.
.\" TODO: explain this
.It Ic help
Get help for the
.Em config
module.
.It Ic remove Ar identifier Ar value
Remove a value from a list.
.\" TODO: why the value?
.It Ic revert
Revert all local changes (that have not been committed).
.\" TODO: what does this do?
.It Ic set Ar identifier Ar value
Set a configuration value.
.\" TODO
.It Ic show Op Ar identifier.
.\" TODO
Show the currently set configuration values.
If no
.Ar identifier
is given, the current location is used (as set by the
.Ic go
command).
If a config option is a list or a map, the value is not
shown directly, but must be requested separately.
.\" TODO: example of this list or map
.It Ic unset Ar identifier
Remove a configuration value.
If the option is mandatory, it will reset to the default value.
.\" TODO: how to know default values before?
.El
.\" This manual page only covers builtin commands.
.\" .Sh PARKINGLOT COMMANDS
.\" .Bl -tag -width Ic
.\" .It Ic help
.\" Get help for the
.\" .Em ParkingLot
.\" module.
.\"
.\" TODO: Command arguments which have embedded spaces may be quoted with
.\" quote
.\" .Sq \&"
.\" marks.
.Pp
.Pp command-line editing?
.Pp
.Sh EXAMPLES
The following are some
.Nm
examples:
.Bl -tag -width abcde
.It Ic "config help"
Show the commands for the
.Em config
module.
.It Ic "config go ParkingLot/"
Go to the
.Dq ParkingLot/
configuration location.
-->

  </refsect1>

<!-- TODO: any options? -->

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-xfrin</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
Jeremy C. Reed's avatar
Jeremy C. Reed committed
321
      <citetitle>BIND 10 Guide</citetitle>.
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
    </para>
<!-- TODO: point to developer docs -->
  </refsect1>

  <refsect1>
    <title>AUTHORS</title>
    <para>
      The <command>bindctl</command>
      tool and library were initially coded by Zhang Likun of CNNIC
      for the BIND 10 project.
      The initial manual page was written by Jeremy C. Reed of ISC.
    </para>
  </refsect1>

  <refsect1>
    <title>HISTORY</title>
    <para>
       The initial version (with internal name of
       <command>BigTool</command>)
       was started in October 2009.
    </para>
  </refsect1>

</refentry><!--
 - Local variables:
 - mode: sgml
 - End:
-->