Sync usage with man page.
[netbsd-mini2440.git] / gnu / dist / groff / contrib / mom / BUGS
blob33765ba0140fe90385aa5f552b1b183e5745ab9d
1 Assume that anything that doesn't work or behaves oddly is a bug.
2 The documentation should be taken as the authoritative source for
3 how things ought to be.
5 Post to the groff mailing list with bug reports, questions and
6 suggestions, or contact me directly at:
8     peter@faustus.dyn.ca
9     or
10     ptpi@golden.net
12 If writing me directly, please include the word "groff" or "mom" in
13 the Subject line or you risk my spam filters nuking your message.
14 Also, please--no html email.  That, too, gets nuked.
16 --Peter Schaffter
18 ========================================================================
20 Version 1.3
21 ===========
23 Persistent error in html coding of docs (<nobr> tag).
24 ---Fixed---
26 Version 1.2-f
27 ============
29 Multiple line subheads near page bottom sometimes printing one line
30 of subhead at page bottom, and subsequent lines on next page.
31 ---Fixed---
33 Post-quote spacing still wonky when paragraph spacing is turned on.
34 ---Fixed--- (for good would be nice)
36 RULE not always resetting quad and quad value.
37 ---Fixed---
39 Version 1.2-e
40 =============
42 Some string definitions in om.tmac had superfluous spaces after
43 them (e.g. $COVERTITLE).
44 ---Fixed---
46 Spacing under quotes not correct when paragraph spacing is turned
47 on.
48 ---Fixed---
51 First word of last line before footnotes is getting chopped.
52 ---Fixed---
54 Version 1.2-d
55 =============
57 HEADER_FAMILY not changing header family.
58 ---Fixed---
60 FAMILY, after COLLATE, not changing the family of all and every
61 page element or tag.
62 ---Fixed---
64 Heads and subheads at the start of docs are printing one line lower
65 than they should.
66 ---Fixed---
68 Gaps are appearing at the bottom of pages when there's a linebreak
69 followed by a subhead.
70 ---Fixed---
72 When LS is invoked after a single text line at the top of a page
73 containing a T_MARGIN (set with T_MARGIN or PAGE), mom is performing
74 spacing adjustments as if the first line doesn't exist.
75 ---Fixed---
77 Changes made to ALD and LS in version 1.2-c should not apply when
78 the document processing macros are used.  There is a significant
79 conflict with the internal use of ALD when the docheader is only
80 one line long (as, for example, when DOCTYPE is CHAPTER).
81 ---Fixed, pending discovery of further conflicts---
83 Version 1.2-c
84 =============
86 Deferred footnotes not always being output, and groff complains
87 "ending diversion FN_OVERFLOW on exit."
88 ---Fixed---
90 First .LS call after a top margin has been set (with .T_MARGIN
91 or .PAGE) causing mom to move off the top margin baseline.  Also,
92 there are conflicts between ALD, LS and T_MARGIN.
93 ---Fixed---
95 DROPCAP not properly restoring a running \*[COND] or \*[EXT] after
96 COND or EXT are given as arguments to DROPCAP.
97 ---Fixed---
99 Version 1.2
100 ===========
102 .PAD not co-operating with mom's fontstyles, esp. when a full
103 family+fontstyle is given to .FT.
104 ---Fixed---
106 .DROPCAP -- ditto the above.
107 ---Fixed---
109 Version 1.1.9
110 =============
112 Footnote markers not resetting properly on new pages when COLUMNS
113 is enabled.
114 ---Fixed---
116 When overflowed footnote material is the only footnote material on
117 the page or in the column, no footnotes are output.
118 ---Fixed---
120 The AUTOLEAD used in FOOTNOTE not being disabled after FOOTNOTES
121 are output, or after PROCESS_FN_LEFTOVER/PROCESS_FN_IN_DIVER.
122 ---Fixed---
124 COL_NEXT and COL_BREAK, when invoked during the last column on a
125 page, are overprinting the last column instead of breaking to a new
126 page when there are footnotes in the column.
127 ---Fixed---
129 BR_AT_LINE_KERN not "break-and-spreading" text when used in
130 justified copy.
131 ---Fixed---
133 Version 1.1.8
134 =============
136 BLOCKQUOTE_FAMILY not changing blockquote family.
137 ---Fixed---
139 FOOTNOTE, whether in column mode or not, was using
140 #FN_COUNT_FOR_COLS for all footnote markers and handling.
141 ---Fixed---
143 Deferred footnotes that occured on the second to last page of
144 documents not printing.
145 ---Fixed---
147 Version 1.1.7-a
148 ===============
150 Suite number in DOCTYPE LETTER not printing.
151 ---Fixed---
153 Footer elements not always vertically aligning.
154 ---Fixed---
156 Footer rule gap not always correctly observed.
157 ---Fixed---
159 Page numbering, when at top of page, not always falling on
160 HDRFTR_MARGIN.
161 ---Fixed---
163 Default page numbering style for COPYSTYLE draft is DIGIT instead
164 of roman.
165 ---Fixed---
167 Hyphens around page numbering when style is DIGIT, ROMAN or ALPHA
168 not vertically centered.
169 ---Fixed---
171 EXT arg not working with DROPCAP.
172 ---Fixed---
174 DOC_QUAD not automatically set immediately after START
175 ---Fixed--
177 Tabs behaving erratically during document processing.
178 ---Fixed---
180 Version 1.1.7
181 =============
183 When DOCHEADER OFF <distance> is given, if <distance> falls short
184 of the top margin of running text, <distance> is not respected and
185 bottom margin falls low.
186 ---Fixed---
189 Version 1.1.6-e
190 ===============
192 The " mark (doublequote), when entered while not in document
193 processing mode (i.e. just straightforward typesetting), outputs
194 nothing unless SMARTQUOTES is invoked explicitly.
195 ---Fixed---
197 Version 1.1.6-c
198 ===============
200 In document processing mode, docs that use *none* of the
201 docprocessing tags being ignored.
202 ---Fixed---
204 Version 1.1.6-b
205 ===============
207 String tabs not picking up #L_MARGIN when #L_MARGIN not explicitly
208 set with L_MARGIN, PAPER or PAGE.
209 ---Fixed---
211 Infinite loop when B_MARGIN is set lower than FOOTER_MARGIN during
212 doc processing.
213 ---Fixed---
215 Version 1.1.6-a
216 ===============
218 Mom partially broken when run with groff 1.19.1.  Don't know yet
219 what this is, whether bad coding in mom, or a problem with 1.19.1.
220 Only solution for now: run mom 1.1.6 with groff 1.18.
221 ----Fixed---
223 Top margin of endnotes pages after the first endnotes page when
224 PRINTSTYLE is TYPEWRITE and endnotes single-spacing is turned on
225 falling one line too high.
226 ---Fixed---
228 Version 1.1.6
229 =============
231 DOCHEADER OFF (distance) not being respected.
232 ---Fixed---
234 FINIS killing ENDNOTES page numbering and heads.
235 ---Fixed---
237 Version 1.1.5
238 =============
240 Draft and revision not appearing in page headers.
241 ---Fixed---
243 \*[RULE] not working properly with indents and justified copy.
244 ---Fixed---
246 Post-epigraph spacing in TYPEWRITE causing some first pages to run too
247 deep.
248 ---Fixed---
250 Spacing of docheaders in TYPEWRITE not always consistent.
251 ---Fixed---
253 Version 1.1.4
254 =============
256 Blockquotes that span pages running too deep.
257 ---Fixed---
259 Version 1.1.3
260 =============
262 Footnotes not outputting on final page of document body when ENDNOTES
263 is invoked.
264 ---Fixed---
266 Pad not working properly and/or spitting out warnings when fill mode is
268 ---Fixed---
270 Version 1.1.2
271 =============
273 PAGENUM_STYLE being ignored unless entered after START.
274 ---Fixed---
276 Version 1.1
277 ===========
279 String tabs not working as advertised when set from within other tabs.
280 ---Fixed---
282 .COLLATE sometimes depositing a header on the first page of a subsequent doc.
283 ---Fixed with workaround BREAK_QUOTE---
285 .UNDERLINE_QUOTES in PRINTSTYLE TYPEWRITE not on by default as advertised.
286 ---Fixed---
288 .TI not cooperating with other indent styles.
289 ---Fixed---
291 .WS and .SS not cooperating.
292 ---Fixed---
294 .RW and .EW not working.
295 ---Fixed---
297 ========================================================================
299 KNOWN PROBLEMS
300 --------------
302 The indent macros from the typesetting macro set may not always
303 perform well in conjunction with the document processing macros,
304 especially when documents are set in columns.  Mostly, this is the
305 result of inadequate testing.  There are only so many "who'd want to
306 do this anyway?" scenarios I can think of on my own.
308 Epigraphs at the bottoms of page may sometimes run exactly one line
309 deeper than they should.  The alternative (from my point of view) is
310 to have them run 1 line shorter than they should.  The problem stems
311 from the fact the epigraphs are leaded differently than all other text,
312 and there's only so much adjusting that can be done with the whitespace
313 surrounding them to get them to bottom align.  Since stylistically,
314 epigraphs should never appear at the bottom of a page/column without at
315 least some running text beneath them in order to make sense of the role
316 they play in page layout, this not likely to be fixed for some time.