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