Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/TODO, Revision 1.5

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