]> git.cameronkatri.com Git - mandoc.git/blob - TODO
Smarten BADCHAR check to allow ASCII_HYPH.
[mandoc.git] / TODO
1 ************************************************************************
2 * missing features
3 ************************************************************************
4
5 - explicit blocks with missing end macro should be implicitely closed
6 at the end of the enclosing block, e.g. .Bl It (El) Sh
7 reminded by stsp@ in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
8
9 - .Bl -column .Xo support is missing
10 ultimate goal:
11 restore .Xr and .Dv to
12 lib/libc/compat-43/sigvec.3
13 lib/libc/gen/signal.3
14 lib/libc/sys/sigaction.2
15
16 - .Bk / .Ek is broken, e.g.
17 $ man ssh
18 [...]
19 ssh [-1246AaCfgKkMNnqsTtVvXxYy] [-b bind_address] [-c cipher_spec] [-D
20 [bind_address:]port] [-e escape_char] [-F configfile] [-I pkcs11]
21 reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200
22 also reported by jmc@ earlier
23
24 - implement \\
25 in plain text, identical to \e
26 as a macro argument, identical to \ i.e. escaping the next character
27 We do not have macro definitions yet; if we implement them,
28 \\ must behave in a macro def like in a macro argument,
29 and when using the macro, it must expand yet again.
30
31 - look at bsd.lv tbl(1)
32 from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200
33
34 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
35 These are a weird mixture of man(7) and custom autogenerated low-level
36 roff stuff. Figure out to what extent we can cope.
37 noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
38 reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
39
40
41 - FIXED OpenBSD term.h 1.16 term.c 1.30 mdoc_term.c 1.75 schwarze 23.4.10
42 handle tab characters outside literal context, e.g. usb(4)
43 reported by jmc@ Mon, 19 Apr 2010 07:42:12 +0100
44 NEEDS MERGING TO bsd.lv
45
46 - FIXED OpenBSD man.h 1.15 libman.h 1.16 man_hash.c 1.9
47 man.c 1.25 man_macro.c 1.15 man_validate.c 1.19 man_action.c 1.15
48 man_term.c 1.28 man_html.c 1.9 schwarze 25.4.
49 implement .if .ie .el
50 noticed by espie@ Fri, 23 Apr 2010 17:10:35 +0200
51 NEEDS MERGING TO bsd.lv
52
53
54 ************************************************************************
55 * formatting issues: ugly output
56 ************************************************************************
57
58 - outside list context, text following .Sm off
59 seems to follow without a blank (TERM_NOBLANK reset late?) e.g.
60 .Sm off
61 .Xo
62 .Op Ar bind_address No /
63 .Ar port
64 .Xc
65 .Sm on
66 or by enclosing
67 reported by jmc Tue, 13 Apr 2010 08:48:14 +0100
68
69 - do not break the line after "--", it's probably a long option
70 reminded by stsp in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
71
72 - URGENT, this is making many kernel manuals look bad:
73 .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?
74 autoconf.9:
75 .Sh DIRECT CONFIGURATION
76 .nr nS 1
77 .Ft "struct device *"
78 .Fn config_found_sm "struct device *parent"
79 groff:
80 DIRECT CONFIGURATION
81 struct device *
82 config_found_sm(struct device *parent, ...
83 reported by sthen Tue, 20 Apr 2010 13:42:51 +0100
84
85 - indentation got lost in SYNOPSIS, e.g.
86 SYNOPSIS
87 date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]
88 - [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
89 + [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
90 reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200
91
92 - empty phrases in .Bl column produce too few blanks
93 try e.g. .Bl -column It Ta Ta
94 reported by millert Fri, 02 Apr 2010 16:13:46 -0400
95
96 - nroff inserts a space before :, mandoc doesn't:
97 .Dl expr "/$a" Li : '.*/\e(.*\e)'
98
99 ************************************************************************
100 * formatting issues: gratuitious differences
101 ************************************************************************
102
103 - FIXED OpenBSD mdoc.c 1.52 schwarze 16.5.10
104 lines containing blank characters, and nothing else,
105 in literal context (.Bd -literal):
106 groff outputs just blank lines "\n"
107 mandoc outputs blanks to the left margin,
108 then the number of balnks minus one
109 NEEDS MERGING TO bsd.lv
110
111
112 ************************************************************************
113 * parser errors without any effect on formatting
114 ************************************************************************
115
116 - OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree
117