From: Kristaps Dzonsons <kristaps@bsd.lv>
To: discuss@mdocml.bsd.lv
Subject: Re: Lengthy documentation in mdoc
Date: Sun, 03 Jul 2011 13:38:13 +0200 [thread overview]
Message-ID: <4E1054A5.2040903@bsd.lv> (raw)
In-Reply-To: <20110703093133.GA17709@marx.bitnet>
On 03/07/2011 11:31, Jukka Ruohonen wrote:
> On Sat, Jul 02, 2011 at 10:37:40PM +0200, Ingo Schwarze wrote:
>>> I looked into multiple scenarios:
>>> - splitting man page like zsh
>>
>> ... you go that way, which i don't recommend at all.
>> It causes many problems. For example, you can't search in a manual
>> like that, and moving about it is a pain in general.
>> In OpenBSD, we even lumped openssl(1) all into one page
>> when importing it from upstream.
>
> I beg to disagree. In NetBSD we have actively tried to split huge pages into
> smaller pieces while providing an introductory summary page (for an example
> see [1]). When viewed from a terminal, anything longer than say three pages
> does not serve well the whole man page format. Also: the search capabilities
> generally suck.
Jukka,
Sounds like more of a problem with the tools than the format. Can you
imagine any ways to fix this? If anything constructive comes to mind,
chime in and maybe it'll be worth some effort in mandoc-tools to field
alternatives to mandoc | less.
Kristaps
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next prev parent reply other threads:[~2011-07-03 11:38 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-07-02 19:36 Paul Onyschuk
2011-07-02 20:37 ` Ingo Schwarze
2011-07-02 21:14 ` Kristaps Dzonsons
2011-07-02 22:58 ` Paul Onyschuk
2011-07-03 9:31 ` Jukka Ruohonen
2011-07-03 11:38 ` Kristaps Dzonsons [this message]
2011-07-03 16:09 ` Jukka Ruohonen
2011-07-03 15:52 ` Ingo Schwarze
2011-07-05 12:24 ` Paul Onyschuk
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4E1054A5.2040903@bsd.lv \
--to=kristaps@bsd.lv \
--cc=discuss@mdocml.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).