bugfindutils - Bugs: bug #21270, Improved manpage formatting

 
 

bug #21270: Improved manpage formatting

Submitted by:  Andreas Metzler <ametzler>
Submitted on:  Sat 06 Oct 2007 12:33:01 PM UTC  
 
Category: documentationSeverity: 3 - Normal
Item Group: NoneStatus: Fixed
Privacy: PublicAssigned to: James Youngman <jay>
Originator Name: Andre MajorelOpen/Closed: Closed
Release: 4.2.31Fixed Release: 4.3.11

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

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 File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

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

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 7 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Sun 02 Dec 2007 01:48:38 PM UTCjayOpen/ClosedOpen=>Closed
      Fixed ReleaseNone=>4.3.11
    Thu 22 Nov 2007 09:17:26 AM UTCjayStatusIn Progress=>Fixed
    Sat 17 Nov 2007 12:35:05 PM UTCjayStatusNone=>In Progress
      Assigned toNone=>jay
    Sat 06 Oct 2007 12:33:13 PM UTCametzlerCarbon-CopyRemoved 20807=>-
    Sat 06 Oct 2007 12:33:01 PM UTCametzlerCarbon-Copy-=>Added -unavailable-

    Back to the top


    Powered by Savane 3.1-cleanup1