<!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>
    <date>March 17, 2010</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>b10-cmdctl-usermgr</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND10</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>b10-cmdctl-usermgr</refname>
    <refpurpose>cmdctl user maintenance tool</refpurpose>
  </refnamediv>

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

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>b10-cmdctl-usermgr</command>

      <arg><option>-f <replaceable>filename</replaceable></option></arg>
      <arg><option>-h</option></arg>
      <arg><option>-v</option></arg>
      <arg><option>--file <replaceable>filename</replaceable></option></arg>
      <arg><option>--help</option></arg>
      <arg><option>--version</option></arg>

    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>The <command>b10-cmdctl-usermgr</command> tool may be used
      to add accounts with passwords for the
      <citerefentry><refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
      daemon.
    </para>

    <para>
      By default, the accounts are saved in the
      <filename>cmdctl-accounts.csv</filename> file in the current directory,
      unless the <option>--filename</option> switch is used.
      The entry is appended to the file.
<!-- TODO: default should have full path? -->
    </para>

    <para>
      The tool can't remove or replace existing entries.
    </para>
<!-- TODO: the tool can't remove or replace existing entries -->

  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <para>The arguments are as follows:</para>

    <variablelist>

      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem><para>
          Report the usage statement and exit.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-f <replaceable>filename</replaceable></option></term>
        <term><option>--file <replaceable>filename</replaceable></option></term>
        <listitem><para>
          Define the filename to append the account to. The default
          is <filename>cmdctl-accounts.csv</filename> in the current directory.
<!-- TODO: default should have full path? -->
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-v</option></term>
        <term><option>--version</option></term>
        <listitem><para>
          Report the version and exit.
        </para></listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

<!--
  <refsect1>
    <title>FILES</title>
    <para>
    </para>
  </refsect1>
-->

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citetitle>BIND 10 Guide</citetitle>.
    </para>
  </refsect1>

  <refsect1>
    <title>HISTORY</title>
    <para>
      The <command>b10-cmdctl-usermgr</command> tool
      was implemented in January 2010
      by Zhang Likun of CNNIC for the ISC BIND 10 project.
    </para>
  </refsect1>
</refentry><!--
 - Local variables:
 - mode: sgml
 - End:
-->
