Re: desired .Bk semantics?

[Jason McIntyre <jmc@kerhand.co.uk>]

On Sat, Jul 03, 2010 at 02:27:21PM +0200, Kristaps Dzonsons wrote:
> >>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.
> 

i agree (with kristaps).

> 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.
> 

absolutely! SYNOPSIS is a hugely important part of the page - it's the
first thing people see. and we don;t want it looking like shit. and we
don;t want man page writers fannying around trying to make it look ok.
it should just work sanely.

> Is `Bk' used often outside of this where .nr nS 1 is otherwise 
> unacceptable (like those OpenBSD .9 manuals)?
> 

it is a synopsis-only thing. obviously we sometimes have mini synopses
outside the main SYNOPSIS section. in those cases we could currently
find Bk. i'm not aware of any other places it would normally occur.

jmc
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv