en/handbook/basics: proposed corrections #2

Warren Block wblock at wonkity.com
Thu Dec 12 15:32:01 UTC 2013


On Thu, 12 Dec 2013, Taras Korenko wrote:

>  Good day, doc@ folks.
>
>  The following notes were made while working on translation of "Users
> and Basic Account Management" of our handbook.  I'd like to put them
> into the source file (basics/chapter.xml).
>
>  Could anyone review that?
>
> P.S.: my (xml-style) comments are denoted with 'XXX skipme:'.
>

Index: en_US.ISO8859-1/books/handbook/basics/chapter.xml
===================================================================
--- en_US.ISO8859-1/books/handbook/basics/chapter.xml	(revision 43325)
+++ en_US.ISO8859-1/books/handbook/basics/chapter.xml	(working copy)

...

@@ -637,7 +639,7 @@

        <para>&os; provides a variety of different commands to manage
         user accounts.  The most common commands are summarized in
-       Table 4.1, followed by some examples of their usage.  Refer to
+       the subsequent table, followed by some examples of their usage.  Refer to
         the manual page for each utility for more details and usage
         examples.</para>

WB: "See" is simpler than "refer to".  An xml:id can be added to that 
table and linked here.  That is also useful when referring to the page 
in HTML, because it becomes an anchor.  For example, in the table 
declaration:

   <table xml:id="users-tbl-managing" frame="none" pgwide="1">

Then in the text:

        <para>&os; provides a variety of different commands to manage
         user accounts.  The most common commands are summarized in
         <xref linkend="users-tbl-managing"/>, followed by some examples of their usage.  See
         the manual page for each utility for more details and usage
         examples.</para>


@@ -725,8 +727,10 @@
  	  been invited into the
  	  <systemitem class="groupname">wheel</systemitem> group,
  	  which is required to provide the account with superuser
-	  access.  When finished, the utility will prompt to either
+	  access using &man.su.1;.  When finished, the utility will prompt to either

WB: That sentence can be interpreted several ways.  How about

  	  <systemitem class="groupname">wheel</systemitem> group,
           allowing them to become the superuser
           with &man.su.1;.

  	  create another user or to exit.</para>
+<!-- XXX skipme: on the contrary, "sudo" requires no special group
+		 membership -->

WB: A mention of sudo would have to be careful not to equate it with 'su 
-'.  The environment is different.  I think the intention here was just 
to demonstrate adduser.  The section just above, called "The Superuser 
Account", would be a better place for describing sudo and how it can 
allow unprivileged users to run programs without becoming superuser.


More information about the freebsd-doc mailing list