[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Manual-page legends



Have the header and footer legends of Debian Project manual pages been
discussed on this list?  Is there convention or guidance?  If so, then
the search engine and I are unaware of it.

My drafts [1] look like these:

    +-------------------------------------------------------------+
    | FOO(1)    Debian, the Universal Operating System     FOO(1) |
    |                                                             |
    | NAME                                                        |
    | SYNOPSIS                                                    |
    | ...                                                         |
    |                                                             |
    ~                                                             ~
    |                                                             |
    | 0.1.0                   1970-01-01                   Page 1 |
    +-------------------------------------------------------------+

    +-------------------------------------------------------------+
    | BAR(7)    Debian, the Universal Operating System     BAR(7) |
    |                                                             |
    | NAME                                                        |
    | SYNOPSIS                                                    |
    | ...                                                         |
    |                                                             |
    ~                                                             ~
    |                                                             |
    | The Debian Project      1970-01-01                   Page 1 |
    +-------------------------------------------------------------+

One is aware that many manual pages print "Foo Manual" at the top,
but when package foo installs no other executable than foo(1), the
legend "Foo Manual" seems repetitive and uninformative. [2]

If the Debian Project were to have a convention or to issue guidance
regarding the header and footer legends of Debian Project manual pages,
what should that convention or guidance be, in your view?

    1: It's probably irrelevant but, for information, my drafts were
       not autogenerated by a tool like, for example, pod2man(1).
       Rather, they were marked up by hand according to groff_man(7).
    2: In the lower right, whether groff(1) prints "Page 1"
       or "FOO(1)" depends on the output device.

Attachment: signature.asc
Description: PGP signature


Reply to: