Christian Perrier ([EMAIL PROTECTED]) wrote: > (reply set to the bug report) > > Here it is. Thanks for any comment you can make.
All right. It looks like it was translated directly from the existing man page, which makes applying the changes simple, except for trying to figure out what XML tags to use for various purposes. Is there a definitive list of the tags, all in one place, which matches the actual set used for the man page? For example, <http://www.lodestar2.com/people/dyork/talks/2002/ols/docbook-tutorial/frames/foil35.html> shows <emphasis role="bold">This is some bold text.</emphasis> and <http://supportweb.cs.bham.ac.uk/documentation/tutorials/docsystem/build/tutorials/docbooksys/segmentedhtml/ch09s01.html> uses <emphasis role="strong">A different type of emphasis</emphasis> but the man page you sent uses <emphasis remap='B'>Login</emphasis> Also, <http://supportweb.cs.bham.ac.uk/documentation/tutorials/docsystem/build/tutorials/docbooksys/segmentedhtml/ch09s01.html> says that apostrophes must be converted into ' but the man page has the word "user's" in it, with a raw apostrophe. I'm unclear how to put in a quoted literal character, as in: with seven fields delimited by colons (`:') Is <quote>:</quote> the proper markup for that? It seems right, based on <http://www.docbook.org/tdg/en/html/quote.html>, but I'm not sure how closely you're following that set of tags. Finally, what command should I use to render the XML into its "man page format", so that I can check that what I've done is correct? (In other words, the Docbook XML equivalent of "nroff -man passwd.5 | less", or a command to convert passwd.5.xml into passwd.5.) I'd be happy to help out with documentation for more than just this one man page, but I can't seem to find the right starting point. I'm attaching what I've got so far. -- Greg Wooledge | "Truth belongs to everybody." [EMAIL PROTECTED] | - The Red Hot Chili Peppers http://wooledge.org/~greg/ |
<?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='passwd.5'>
<!-- $Id: passwd.5.xml,v 1.9 2005/08/29 18:00:48 kloczek Exp $ -->
<refmeta>
<refentrytitle>passwd</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv id='name'>
<refname>passwd</refname>
<refpurpose>The password file</refpurpose>
</refnamediv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
<filename>/etc/passwd</filename> contains one line for each
user account, with seven fields delimited by colons
(<quote>:</quote>).
These fields are:
</para>
<itemizedlist mark='bullet'>
<listitem>
<para>login name</para>
</listitem>
<listitem>
<para>optional encrypted password</para>
</listitem>
<listitem>
<para>numerical user ID</para>
</listitem>
<listitem>
<para>numerical group ID</para>
</listitem>
<listitem>
<para>user name or comment field</para>
</listitem>
<listitem>
<para>user home directory</para>
</listitem>
<listitem>
<para>optional user command interpreter</para>
</listitem>
</itemizedlist>
<para>
The encrypted password field may be blank, in which case no
password is required to authenticate as the specified login name.
(However, some applications which read the
<filename>passwd</filename> file may decide not to permit
<emphasis>any</emphasis> access at all if the
<emphasis>password</emphasis> field is blank.)
If the <emphasis>password</emphasis> field is a lower-case
<quote>x</quote>, then the encrypted password is actually stored in
the <citerefentry><refentrytitle>shadow</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file instead;
there <emphasis remap='B'>must</emphasis> be a corresponding line
in the <filename>shadow</filename> file, or else the user account
is invalid.
If the <emphasis>password</emphasis> field is any other string,
then it will be treated as an encrypted password, as specified
by <citerefentry><refentrytitle>crypt</refentrytitle>
<manvolnum>3</manvolnum></citerefentry>.
<para>
<para>
The comment field is used by various system utilities, such as
<citerefentry><refentrytitle>finger</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>.
</para>
<para>
The home directory field provides the name of the initial working
directory.
The <emphasis remap='B'>login</emphasis> program uses this
information to set the value of the <envar>$HOME</envar>
environmental variable.
</para>
<para>
The command interpreter field provides the name of the user's
command language interpreter, or the name of the initial program
to execute.
The <emphasis remap='B'>login</emphasis> program uses this
information to set the value of the <envar>$SHELL</envar>
environmental variable.
If this field is empty, it defaults to the value
<filename>/bin/sh</filename>.
</para>
</refsect1>
<refsect1 id='files'>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/etc/passwd</filename></term>
<listitem>user account information</listitem>
</varlistentry>
<varlistentry>
<term><filename>/etc/shadow</filename></term>
<listitem>optional encrypted password file</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>getent</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>login</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>passwd</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>su</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>crypt</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>getpwnam</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pwconv</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pwunconv</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sulogin</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
<refsect1 id='author'>
<title>AUTHOR</title>
<para>Julianne Frances Haugh ([EMAIL PROTECTED])</para>
</refsect1>
</refentry>
signature.asc
Description: Digital signature
