Limnoria/debian/manpage_supybot-adduser.sgml
2004-08-28 20:23:19 +00:00

184 lines
5.1 KiB
Plaintext

<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Jonathan</firstname>">
<!ENTITY dhsurname "<surname>Hseu</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>August 27, 2004</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>vomjom@debian.org</email>">
<!ENTITY dhusername "Jonathan Hseu">
<!ENTITY dhucpackage "<refentrytitle>SUPYBOT-ADDUSER</refentrytitle>">
<!ENTITY dhpackage "supybot-adduser">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2003</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Adds a user to a Supybot configuration file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>options</option></arg>
<arg choice="req"><replaceable>users.conf</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> adds a user to a Supybot
configuration file.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>These programs follow the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.</para>
<variablelist>
<varlistentry>
<term><option>--version</option>
</term>
<listitem>
<para>Show version of program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>
<option>--help</option>
</term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-uNAME</option>
<option>--username=NAME</option>
</term>
<listitem>
<para>Username for the user.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-pPASSWORD</option>
<option>--password=PASSWORD</option>
</term>
<listitem>
<para>Password for the user.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-x</option>
<option>--hashed</option>
</term>
<listitem>
<para>Hash encrypt the password.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option>
<option>--plain</option>
</term>
<listitem>
<para>Store the password in plain text.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-cCAPABILITY</option>
<option>--capability=CAPABILITY</option>
</term>
<listitem>
<para>Capability the user should have; this option may be
given multiple times</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>python (1), supybot-wizard (1), supybot (1),
supybot-newplugin (1).</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was originally written by &dhusername; &dhemail; for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the Supybot license, a BSD-style license.
</para>
<para>
On Debian systems with Supybot installed, the complete text
of the supybot license can be found in /usr/share/doc/supybot/LICENSE
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->