doc/manpages/man1/afppasswd.1.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="afppasswd.1">
   3   <refmeta>
   4     <refentrytitle>afppasswd</refentrytitle>
   5
   6     <manvolnum>1</manvolnum>
   7
   8     <refmiscinfo class="date">22 Mar 2012</refmiscinfo>
   9
  10     <refmiscinfo class="source">:NETATALK_VERSION:</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv>
  14     <refname>afppasswd</refname>
  15
  16     <refpurpose>netatalk password maintenance utility</refpurpose>
  17   </refnamediv>
  18
  19   <refsynopsisdiv>
  20     <cmdsynopsis>
  21       <command>afppasswd<indexterm>
  22           <primary>afppasswd</primary>
  23         </indexterm><indexterm>
  24           <primary>UAM</primary>
  25
  26           <secondary>User Authentication Module</secondary>
  27         </indexterm></command>
  28
  29       <arg choice="opt">-acfn</arg>
  30
  31       <arg choice="opt"><arg choice="plain">-p
  32       <replaceable>passwd</replaceable></arg><arg
  33       choice="plain"><replaceable>file</replaceable></arg></arg>
  34
  35       <arg choice="opt"><arg choice="plain">-u
  36       <replaceable>minimum</replaceable></arg><arg
  37       choice="plain"><replaceable>uid</replaceable></arg></arg>
  38     </cmdsynopsis>
  39   </refsynopsisdiv>
  40
  41   <refsect1>
  42     <title>DESCRIPTION</title>
  43
  44     <para><command>afppasswd</command> allows the maintenance of afppasswd
  45     files created by netatalk for use by the uams_randnum.so UAM (providing
  46     the "Randnum exchange" and "2-Way Randnum exchange" User Authentication
  47     Modules).</para>
  48
  49     <para><command>afppasswd</command> can either be called by root with
  50     parameters, or can be called by local system users with no parameters to
  51     change their AFP passwords.</para>
  52
  53     <note>
  54       <para>With this utility you can only change the passwords used by two
  55       specific UAMs. As they provide only weak password encryption, the use of
  56       the "Randnum exchange" and "2-Way Randnum exchange" UAMs is deprecated
  57       unless one has to support very old AFP clients, that can not deal with
  58       the more secure "DHCAST128" and "DHX2" UAM instead. Please compare with
  59       the <link linkend="authentication">Authentication chapter</link> inside
  60       Netatalk's documentation.</para>
  61     </note>
  62   </refsect1>
  63
  64   <refsect1>
  65     <title>EXAMPLE</title>
  66
  67     <para>Local user changing their own password:</para>
  68
  69     <screen><prompt>example%</prompt> <userinput>afppasswd</userinput>
  70 <computeroutput>Enter NEW AFP password:</computeroutput> <userinput>(hidden)</userinput>
  71 <computeroutput>Enter NEW AFP password again:</computeroutput> <userinput>(hidden)</userinput>
  72 <computeroutput>afppasswd: updated password.</computeroutput>
  73 </screen>
  74   </refsect1>
  75
  76   <refsect1>
  77     <title>OPTIONS</title>
  78
  79     <variablelist remap="TP">
  80       <varlistentry>
  81         <term><option>-a</option></term>
  82
  83         <listitem>
  84           <para>Add a new user to the <command>afppasswd</command>
  85           file.</para>
  86         </listitem>
  87       </varlistentry>
  88
  89       <varlistentry>
  90         <term><option>-c</option></term>
  91
  92         <listitem>
  93           <para>Create and/or initialize <command>afppasswd</command> file or
  94           specific user.</para>
  95         </listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term><option>-f</option></term>
 100
 101         <listitem>
 102           <para>Force the current action.</para>
 103         </listitem>
 104       </varlistentry>
 105
 106       <varlistentry>
 107         <term><option>-p</option><replaceable> path</replaceable></term>
 108
 109         <listitem>
 110           <para>Path to <command>afppasswd</command> file.</para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term><option>-n</option></term>
 116
 117         <listitem>
 118           <para>If cracklib support is built into <emphasis
 119           remap="B">netatalk</emphasis> this option will cause cracklib
 120           checking to be disabled, if the superuser does not want to have the
 121           password run against the cracklib dictionary.</para>
 122         </listitem>
 123       </varlistentry>
 124
 125       <varlistentry>
 126         <term><option>-u</option><replaceable> minimum
 127         uid</replaceable></term>
 128
 129         <listitem>
 130           <para>This is the minimum <emphasis remap="I">user id</emphasis>
 131           (uid) that <command>afppasswd</command> will use when creating
 132           users.</para>
 133         </listitem>
 134       </varlistentry>
 135     </variablelist>
 136   </refsect1>
 137
 138   <refsect1>
 139     <title>SEE ALSO</title>
 140
 141     <para><citerefentry>
 142         <refentrytitle>afpd</refentrytitle>
 143
 144         <manvolnum>8</manvolnum>
 145       </citerefentry>, <citerefentry>
 146         <refentrytitle>afp.conf</refentrytitle>
 147
 148         <manvolnum>5</manvolnum>
 149       </citerefentry>.</para>
 150   </refsect1>
 151 </refentry>