Annotation of mandoc/TODO, Revision 1.2
1.1 kristaps 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: - man(7) .TH should recognize "3p" as a section number
25: found in usr.bin/pkg_add OpenBSD::Getopt
26:
27: - implement \\
28: in plain text, identical to \e
29: as a macro argument, identical to \ i.e. escaping the next character
30: We do not have macro definitions yet; if we implement them,
31: \\ must behave in a macro def like in a macro argument,
32: and when using the macro, it must expand yet again.
33:
34: - look at bsd.lv tbl(1)
35: from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200
36:
37: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
38: These are a weird mixture of man(7) and custom autogenerated low-level
39: roff stuff. Figure out to what extent we can cope.
40: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
41: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
42:
43:
44: - FIXED OpenBSD term.h 1.16 term.c 1.30 mdoc_term.c 1.75 schwarze 23.4.10
45: handle tab characters outside literal context, e.g. usb(4)
46: reported by jmc@ Mon, 19 Apr 2010 07:42:12 +0100
1.2 ! schwarze 47: NEEDS MERGING TO bsd.lv
1.1 kristaps 48:
49: - FIXED OpenBSD man.h 1.15 libman.h 1.16 man_hash.c 1.9
50: man.c 1.25 man_macro.c 1.15 man_validate.c 1.19 man_action.c 1.15
51: man_term.c 1.28 man_html.c 1.9 schwarze 25.4.
52: implement .if .ie .el
53: noticed by espie@ Fri, 23 Apr 2010 17:10:35 +0200
1.2 ! schwarze 54: NEEDS MERGING TO bsd.lv
1.1 kristaps 55:
56:
57: ************************************************************************
58: * formatting issues: ugly output
59: ************************************************************************
60:
61: - outside list context, text following .Sm off
62: seems to follow without a blank (TERM_NOBLANK reset late?) e.g.
63: .Sm off
64: .Xo
65: .Op Ar bind_address No /
66: .Ar port
67: .Xc
68: .Sm on
69: or by enclosing
70: reported by jmc Tue, 13 Apr 2010 08:48:14 +0100
71:
72: - do not break the line after "--", it's probably a long option
73: reminded by stsp in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
74:
75: - in .Bl -column .It, "\t" seems to be synonymous to " Ta ",
76: see sysctl(3) for many examples;
77: mishandling this results in spurious quotes at EOL
78: reminded by guenther@ Mon, 26 Apr 2010 01:16:52 -0700
79:
80: - URGENT, this is making many kernel manuals look bad:
81: .Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS?
82: autoconf.9:
83: .Sh DIRECT CONFIGURATION
84: .nr nS 1
85: .Ft "struct device *"
86: .Fn config_found_sm "struct device *parent"
87: groff:
88: DIRECT CONFIGURATION
89: struct device *
90: config_found_sm(struct device *parent, ...
91: reported by sthen Tue, 20 Apr 2010 13:42:51 +0100
92:
93: - indentation got lost in SYNOPSIS, e.g.
94: SYNOPSIS
95: date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]
96: - [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
97: + [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
98: reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200
99:
100: - empty phrases in .Bl column produce too few blanks
101: try e.g. .Bl -column It Ta Ta
102: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
103:
104:
105: ************************************************************************
106: * formatting issues: gratuitious differences
107: ************************************************************************
108:
109: - in literal context, groff disables the right margin
110: an example: syslog.conf.5 EXAMPLES section
111: reported by jmc Tue, 13 Apr 2010 10:12:15 +0100
112: solution: raise termp->maxrmargin in literal context
113:
114: - lines containing blank characters, and nothing else,
115: in literal context (.Bd -literal):
116: groff outputs just blank lines "\n"
117: mandoc outputs blanks to the left margin,
118: then the number of balnks minus one
119:
120:
121: ************************************************************************
122: * parser errors without any effect on formatting
123: ************************************************************************
124:
125: - OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree
126:
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to TODO CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc