xref: /openbsd-src/regress/usr.bin/mandoc/mdoc/Bk/break.in (revision 943fb9d8c7fc1b7e0db8c617168f7360d3ee357c)
1.\" $OpenBSD: break.in,v 1.7 2017/07/04 14:53:24 schwarze Exp $
2.Dd $Mdocdate: July 4 2017 $
3.Dt BK-BREAK 1
4.Os
5.Sh NAME
6.Nm Bk-break
7.Nd handling of word keeps
8.Sh DESCRIPTION
9Even though it is called a word keep,
10.Bk -words
11it will not keep words together in free-form text.
12.Ek
13However, even the noop macro
14.Bk -words
15.No is sufficient to let the keep take effect .
16.Ek
17Even text generated in pre-handlers must be kept together with
18the text following it:
19.Bk -words
20.Xr one 1 No and Xr two 2
21.Ek
22should be on the same line.
23.Pp
24Including the whole output line into the keep is not required,
25including just the macros to be kept together is sufficient:
26.Pp
27.Nm
28.Ar x x x x x x x x
29.Ar x x x x x x x x
30.Ar x x x x x x x x
31.Ar x x x x x x
32.Bk -words
33.Op o Ar a
34.Ek
35.Pp
36.Bk -words
37.Nm
38.Ar x x x x x x x x
39.Ar x x x x x x x x
40.Ar x x x x x x x x
41.Ar x x x x x x
42.Op o Ar a
43.Ek
44.Pp
45Even text printed without spacing must be kept together
46with the text following it:
47.Pp
48.Bk -words
49.Fn xxxxxxxxxxxxxxxxxxxx "xxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxx" xxxxxxxxxxxxxxxxxxxx
50.Pp
51.Fo xxxxxxxxxxxxxxxxxxxx
52.Fa "xxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxx" xxxxxxxxxxxxxxxxxxxx
53.Fc
54.Ek
55