bugfindutils - Bugs: bug #21270, Improved manpage formatting

 
 

bug #21270: Improved manpage formatting

Submitter:  Andreas Metzler <ametzler>
Submitted:  Sat 06 Oct 2007 12:33:01 PM UTC
 
Category:  documentation Severity:  3 - Normal
Item Group:  None Status:  Fixed
Privacy:  Public Assigned to:  jay
Originator Name:  Andre Majorel Open/Closed:  Closed
Release:  4.2.31 Fixed Release:  4.3.11
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       

 

Sat 06 Oct 2007 12:33:01 PM UTC, original submission:  

This http://bugs.debian.orgs/445200 submiited by Andre Majorel:
-------------------------
Dear findutils maintainer,

1)  In the xargs(1) man page, in the OPTIONS subsection, the names of the options are in italic. They should be in bold.

In addition, the long name is listed first. Short name first would be more readable.

Recommendation : replace
      .I "\-\-arg\-file=3Dfile, \-a file"
by
      \fB\-a\fP \fIfile\fP, \fB\-\-arg\-file=3D\fP\fIfile\fP
and so on.

2)  The OPTIONS section is erroneously a subsection.

Recommendation : replace

 .SS OPTIONS
by
 .SH OPTIONS
---------------------------------------------

I think it is clear that item 2 is a bug. I do not know about item 1, though. Is there a (semi-)official policy on manpage formatting which requires options to be bold? man(1) seems to suggest that this is the case but I do not know whether this source is authoritative.
cu andreas

Andreas Metzler <ametzler>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by jay (Updated the item)
  • -email is unavailable- added by ametzler
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

     

     

     

    Follow 7 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2007-12-02 jay Open/ClosedOpen Closed
        Fixed ReleaseNone 4.3.11
    2007-11-22 jay StatusIn Progress Fixed
    2007-11-17 jay StatusNone In Progress
        Assigned toNone jay
    2007-10-06 ametzler Carbon-CopyRemoved 20807 -
    2007-10-06 ametzler Carbon-Copy- Added -email is unavailable-

    Back to the top


    Powered by Savane 3.9