NetBSD-Users archive

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

Re: Improved manual page for ul(1)



In article <CAGfo=8mxMMgGWVCh49aytU+2vTp22zwcwrsw=HgpANPy=W_TnQ%mail.gmail.com@localhost>,
Mark Heily  <mark%heily.com@localhost> wrote:
>On Sat, Nov 5, 2016 at 7:05 AM, Jonathan de Boyne Pollard <
>J.deBoynePollard-newsgroups%ntlworld.com@localhost> wrote:
>
>> So whither does one submit an improved manual page for ul(1) ? Here's the
>> source:
>>
>> * http://jdebp.eu./Proposals/ul.1
>>
>> The current FreeBSD/NetBSD manual page really doesn't describe what ul
>> does and is even somewhat misleading.  So the aforelinked has some
>> improvements.
>>
>>
>I don't think putting this level of detail into the ul(1) manpage is the
>best approach.
>
>Would it be better to create a new manpage in section 5 to describe the
>TTY-37 control sequences in all their gory detail?  You could call it
>tty37_control(5) or something similar.
>
>For comparison, there is a groff_out(5) manpage that you could use as an
>example.
>
>The benefit of a separate manpage for TTY-37 information is that any other
>commands that deal with these control sequences can have their manpages
>updated to refer to the tty37_control(5) manual.

I don't have a problem with the information content and I don't have a strong
preference if that should be in a different man page, but if the information
stays, the

    1. Input
    2. Output
    3. Differences from a real Teletype Model 37

subsections belong to a .Sh "TECHNICAL DETAILS" section
(.Xr pkg_add 1, etc. for prior art), because right now they clutter
the information that a casual user needs to use the command.

If that is done, then the "Options" subsection heading can be removed
(only the heading not the content), and this will look more like a
normal man page.

christos



Home | Main Index | Thread Index | Old Index