[bug #21270] Improved manpage formatting

[Andreas Metzler]

URL:
  <http://savannah.gnu.org/bugs/?21270>

                 Summary: Improved manpage formatting
                 Project: findutils
            Submitted by: ametzler
            Submitted on: Samstag 06.10.2007 um 14:33
                Category: documentation
                Severity: 3 - Normal
              Item Group: None
                  Status: None
                 Privacy: Public
             Assigned to: None
         Originator Name: Andre Majorel
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: 4.2.31
           Fixed Release: None

    _______________________________________________________

Details:

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




    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?21270>

_______________________________________________
  Nachricht geschickt von/durch Savannah
  http://savannah.gnu.org/