[Pkg-shadow-devel] Bug#369238: shadow: Small man pages improvements

Yuri Kozlov kozlov.y at gmail.com
Sun May 28 14:49:18 UTC 2006


Package: shadow
Severity: wishlist
Tags: patch

 - the tags <filename>, <command> and white spaces is added when was missed

-- System Information:
Debian Release: 3.1
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: i386 (i686)
Kernel: Linux 2.6.15-1-k7
Locale: LANG=ru_RU.UTF-8, LC_CTYPE=ru_RU.UTF-8 (charmap=UTF-8) (ignored: LC_ALL set to ru_RU.UTF-8)
-------------- next part --------------
--- /host/p3/shad/man/chfn.1.xml	2006-05-27 13:26:28.000000000 +0400
+++ chfn.1.xml	2006-05-28 18:09:08.000000000 +0400
@@ -50,8 +50,8 @@
       current values for all of the fields. Enter the new value to change
       the field, or leave the line blank to use the current value. The
       current value is displayed between a pair of <emphasis remap='B'>[
-	]</emphasis> marks. Without options, chfn prompts for the current
-      user account.
+	]</emphasis> marks. Without options, <command>chfn</command>
+	prompts for the current user account.
     </para>
   </refsect1>
 
-------------- next part --------------
--- /host/p3/shad/man/faillog.8.xml	2006-05-27 13:26:28.000000000 +0400
+++ faillog.8.xml	2006-05-28 17:38:24.000000000 +0400
@@ -83,7 +83,8 @@
 	<listitem>
 	  <para>
 	    Reset the counters of login failures or one record if used with
-	    the -u <replaceable>LOGIN</replaceable> option. Write access to
+	    the <option>-u</option> <replaceable>LOGIN</replaceable>
+	    option. Write access to
 	    <filename>/var/log/faillog</filename> is required for this
 	    option.
 	  </para>
-------------- next part --------------
--- /host/p3/shad/man/groupadd.8.xml	2006-05-27 13:26:28.000000000 +0400
+++ groupadd.8.xml	2006-05-28 17:19:38.000000000 +0400
@@ -80,7 +80,8 @@
 	</term>
 	<listitem>
 	  <para>
-	    Overrides /etc/login.defs defaults (GID_MIN, GID_MAX and others). Multiple
+	    Overrides <filename>/etc/login.defs</filename> defaults 
+	    (GID_MIN, GID_MAX and others). Multiple
 	    <option>-K</option> options can be specified.
 	  </para>
 	  <para>
-------------- next part --------------
--- /host/p3/shad/man/groupmems.8.xml	2006-05-27 13:26:28.000000000 +0400
+++ groupmems.8.xml	2006-05-28 12:18:37.000000000 +0400
@@ -86,7 +86,7 @@
       The <command>groupmems</command> executable should be in mode
       <literal>2770</literal> as user <emphasis>root</emphasis> and in group
       <emphasis>groups</emphasis>. The system administrator can add users to
-      group groups to allow or disallow them using the
+      group <emphasis>groups</emphasis> to allow or disallow them using the
       <command>groupmems</command> utility to manage their own group
       membership list.
     </para>
-------------- next part --------------
--- /host/p3/shad/man/limits.5.xml	2006-05-27 13:26:28.000000000 +0400
+++ limits.5.xml	2006-05-28 11:38:36.000000000 +0400
@@ -15,10 +15,11 @@
   <refsect1 id='description'>
     <title>DESCRIPTION</title>
     <para>
-      The <emphasis remap='I'>limits</emphasis> file (/etc/limits by default
-      or LIMITS_FILE defined config.h) describes the resource limits you
-      wish to impose. It should be owned by root and readable by root
-      account only.
+      The <emphasis remap='I'>limits</emphasis> file 
+      (<filename>/etc/limits</filename> by default
+      or LIMITS_FILE defined <filename>config.h</filename>) describes 
+      the resource limits you wish to impose. It should be owned by 
+      root and readable by root account only.
     </para>
 
     <para>
@@ -81,7 +82,7 @@
       Be aware that after <emphasis remap='I'>username</emphasis> the rest
       of the line is considered a limit string, thus comments are not
       allowed. A invalid limits string will be rejected (not considered) by
-      the login program.
+      the <command>login</command> program.
     </para>
 
     <para>
@@ -93,7 +94,7 @@
 
     <para>
       To completely disable limits for a user, a single dash
-      "<emphasis>-</emphasis> "will do.  </para>
+      "<emphasis>-</emphasis>" will do.  </para>
     <para>
       Also, please note that all limit settings are set PER LOGIN. They are
       not global, nor are they permanent. Perhaps global limits will come,
-------------- next part --------------
--- /host/p3/shad/man/login.1.xml	2006-05-27 13:26:28.000000000 +0400
+++ login.1.xml	2006-05-28 10:15:11.000000000 +0400
@@ -69,7 +69,7 @@
       zero-length file <filename>.hushlogin</filename> in your login directory. 
       The mail message will be one of "<emphasis>You have new
       mail.</emphasis>", "<emphasis>You have mail.</emphasis>", or
-      "<emphasis>No Mail.</emphasis> "according to the condition of your
+      "<emphasis>No Mail.</emphasis>" according to the condition of your
       mailbox.
     </para>
 
-------------- next part --------------
--- /host/p3/shad/man/login.defs.5.xml	2006-05-27 13:26:28.000000000 +0400
+++ login.defs.5.xml	2006-05-28 09:39:51.000000000 +0400
@@ -68,7 +68,7 @@
 	    compatibility, "yes" is equivalent to "rwh" and "no" is
 	    equivalent to "frwh". If not specified, only the superuser can
 	    make any changes. The most restrictive setting is better
-	    achieved by not installing chfn SUID.
+	    achieved by not installing <filename>chfn</filename> SUID.
 	  </para>
 	</listitem>
       </varlistentry>
-------------- next part --------------
--- /host/p3/shad/man/newgrp.1.xml	2006-05-27 13:26:29.000000000 +0400
+++ newgrp.1.xml	2006-05-28 09:38:16.000000000 +0400
@@ -36,7 +36,8 @@
       groupset. If not root, the user will be prompted for a password if she
       does not have a password (in <filename>/etc/shadow</filename> if this
       user has an entry in the shadowed password file, or in
-      /etc/passwd otherwise) and the group does, or if the user is not
+      <filename>/etc/passwd</filename> otherwise) and the group does,
+      or if the user is not
       listed as a member and the group has a password. The user will
       be denied access if the group password is empty and the user is
       not listed as a member. 
-------------- next part --------------
--- /host/p3/shad/man/passwd.1.xml	2006-05-27 13:26:28.000000000 +0400
+++ passwd.1.xml	2006-05-27 22:05:14.000000000 +0400
@@ -366,13 +366,13 @@
 	<varlistentry>
 	  <term><replaceable>4</replaceable></term>
 	  <listitem>
-	    <para>unexpected failure, passwd file missing</para>
+	    <para>unexpected failure, <filename>passwd</filename> file missing</para>
 	  </listitem>
 	</varlistentry>
 	<varlistentry>
 	  <term><replaceable>5</replaceable></term>
 	  <listitem>
-	    <para>passwd file busy, try again</para>
+	    <para><filename>passwd</filename> file busy, try again</para>
 	  </listitem>
 	</varlistentry>
 	<varlistentry>
-------------- next part --------------
--- /host/p3/shad/man/su.1.xml	2006-05-27 13:26:28.000000000 +0400
+++ su.1.xml	2006-05-27 18:22:08.000000000 +0400
@@ -32,7 +32,8 @@
     <title>DESCRIPTION</title>
     <para>
       <command>su</command> is used to become another user during a login
-      session. Invoked without a username, <command>su</command> defaults to
+      session. Invoked without a <option>username</option>, 
+      <command>su</command> defaults to
       becoming the super user. The optional argument <option>-</option> may
       be used to provide an environment similar to what the user would
       expect had the user logged in directly.
@@ -129,13 +130,14 @@
 	      </listitem>
 	      <listitem>
 		<para>
-		  The shell indicated in the /etc/passwd entry for the target
-		  user.
+		  The shell indicated in the <filename>/etc/passwd</filename>
+		  entry for the target user.
 		</para>
 	      </listitem>
 	      <listitem>
 		<para>
-		  /bin/sh if a shell could not be found by any above method.
+		  <filename>/bin/sh</filename> if a shell could not be
+		  found by any above method.
 		</para>
 	      </listitem>
 	    </itemizedlist>
-------------- next part --------------
--- /host/p3/shad/man/useradd.8.xml	2006-05-27 13:26:28.000000000 +0400
+++ useradd.8.xml	2006-05-27 17:15:02.000000000 +0400
@@ -37,8 +37,9 @@
 	When invoked without the <option>-D</option> option, the
 	<command>useradd</command> command creates a new user account using
 	the values specified on the command line and the default values from
-	the system. Depending on command line options, the useradd command
-	will update system files and may also create the new user's home
+	the system. Depending on command line options, the 
+	<command>useradd</command> command will update system files
+	and may also create the new user's home
 	directory and copy initial files.
       </para>
   </refsect1>
@@ -182,7 +183,7 @@
 	</term>
 	<listitem>
 	  <para>
-	    Overrides /etc/login.defs defaults (UID_MIN, UID_MAX, UMASK,
+	    Overrides <filename>/etc/login.defs</filename> defaults (UID_MIN, UID_MAX, UMASK,
 	    PASS_MAX_DAYS and others).
 	  <para>
 	  </para>
-------------- next part --------------
--- /host/p3/shad/man/gpasswd.1.xml	2006-05-27 13:26:28.000000000 +0400
+++ gpasswd.1.xml	2006-05-28 17:25:12.000000000 +0400
@@ -8,7 +8,7 @@
   </refmeta>
   <refnamediv id='name'>
     <refname>gpasswd</refname>
-    <refpurpose>administer the /etc/group file</refpurpose>
+    <refpurpose>administer the <filename>/etc/group</filename> file</refpurpose>
   </refnamediv>
   <!-- body begins here -->
   <refsynopsisdiv id='synopsis'>


More information about the Pkg-shadow-devel mailing list