From: Kristaps Dzonsons <kristaps@bsd.lv>
To: discuss@mdocml.bsd.lv
Subject: Re: desired .Bk semantics?
Date: Sat, 03 Jul 2010 14:27:21 +0200 [thread overview]
Message-ID: <4C2F2CA9.2030209@bsd.lv> (raw)
In-Reply-To: <20100703065442.GA5970@bramka.kerhand.co.uk>
>> after much headbanging while trying to understand tmac files,
>> i guess i finally figured out what .Bk -words is supposed to do.
>> It seems it has nothing to do with macros, but simply with -
>> lines in the input file! My impression is that .Bk -words
>> avoids line breaks inside the output generated from each input
>> line. Perhaps that's why it is called -words (as opposed to -line).
>> Duh.
>>
>
> according to mdoc.samples(7) it is useful for "preventing line breaks in
> the middle of options", and that is how i've always used it. i just
> realised that the same piece of text notes that the effect was once
> achieved using the Op macro.
Ingo, if you and Jason think this is worth the effort (and correct),
then by all means. HOWEVER. `Bk' is a turd that should be flushed: it
gives the author unnecessary control over output. This is wrong.
What we should do is ignore `Bk' and follow an easy algorithm for
SYNOPSIS mode regarding breaking between children. This, I think, is
easier for us and manual writers alike.
Is `Bk' used often outside of this where .nr nS 1 is otherwise
unacceptable (like those OpenBSD .9 manuals)?
Kristaps
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next prev parent reply other threads:[~2010-07-03 12:27 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-07-02 23:43 Ingo Schwarze
2010-07-03 6:54 ` Jason McIntyre
2010-07-03 12:27 ` Kristaps Dzonsons [this message]
2010-07-03 14:11 ` Jason McIntyre
2010-07-03 16:24 ` Kristaps Dzonsons
2010-07-03 16:52 ` Jason McIntyre
2010-07-03 17:25 ` desired .Bk semantics? [UPDATED PATCH] Kristaps Dzonsons
2010-07-03 17:28 ` desired .Bk semantics? Ingo Schwarze
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=4C2F2CA9.2030209@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).