shadow/man/mkpasswd.8.xml

115 lines
4.0 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<refentry id='mkpasswd8'>
<!-- $Id: mkpasswd.8.xml,v 1.5 2005/04/27 16:44:12 kloczek Exp $ -->
<refmeta>
<refentrytitle>mkpasswd</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv id='name'>
<refname>mkpasswd</refname>
<refpurpose>Update passwd and group database files</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>mkpasswd</command>
<arg choice='opt'>-fvgps </arg>
<arg choice='plain'><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
<command>mkpasswd</command> reads the file in the format given by the
flags and converts it to the corresponding database file format. These
database files are used to improve access performance on systems with
large numbers of users. The output files will be named <emphasis
remap='I'>file</emphasis>.dir and <emphasis
remap='I'>file</emphasis>.pag.
</para>
<para>The <option>-f</option> option causes <command>mkpasswd</command>
to ignore any existing output files and overwrite them. Normally
<command>mkpasswd</command> complains about existing output files and
quits.
</para>
<para>The <option>-v</option> option causes <command>mkpasswd</command>
to output information about each record as it is converted, with a
final message at the very end.
</para>
<para>The <option>-g</option> option treats the input file as though it
were in <filename>/etc/group</filename> file format. When combined
with the <option>-s</option> option, the
<filename>/etc/gshadow</filename> file format is used instead.
</para>
<para>The <option>-p</option> option treats the input file as though it
were in <filename>/etc/passwd</filename> file format. This is the
default. When combined with the <option>-s</option> option, the
<filename>/etc/shadow</filename> file format is used instead.
</para>
</refsect1>
<refsect1 id='caveats'>
<title>CAVEATS</title>
<para>The use of more than one database file is limited to systems which
include the NDBM database library and therefore may not be available
on every system.
</para>
</refsect1>
<refsect1 id='note'>
<title>NOTE</title>
<para>Since most commands are capable of updating the database files as
changes are made, this command need only be used when re-creating a
deleted or corrupted database file.
</para>
</refsect1>
<refsect1 id='files'>
<title>FILES</title>
<varlistentry>
<term><filename>/etc/passwd</filename></term>
<listitem>user account information</listitem>
</varlistentry>
<varlistentry>
<term><filename>/etc/shadow</filename></term>
<listitem>secure user account information</listitem>
</varlistentry>
<varlistentry>
<term><filename>/etc/group</filename></term>
<listitem>group account information</listitem>
</varlistentry>
<varlistentry>
<term><filename>/etc/gshadow</filename></term>
<listitem>group account information</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>group</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>
</para>
</refsect1>
<refsect1 id='author'>
<title>AUTHOR</title>
<para>Julianne Frances Haugh (jockgrrl@ix.netcom.com)</para>
</refsect1>
</refentry>