summaryrefslogtreecommitdiff
path: root/contrib/groffer/TODO
blob: 3701b43e86e03df4e9e64ecbcb6495a47415832a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
TODO file for `groffer'

File position: <groff-source>/contrib/groffer/TODO


####### TODO

Revision:
- Revise the `--all' feature to better reflect GNU man.
- The debug function stack is buggy (no effect on normal operation).
- Check main_parse_MANOPT(), not too important.
- Add long option shortcuts.
- The actual replacement `dash' of the POSIX `ash' shell produces
  strange errors with the groffer script, while the former `ash'
  worked successfully.  Are these errors just bugs of `dash'?

Optimization:
- Optimize man path determination in manpath_add_lang_sys() for speed
  by building-up the man path only by and by as far as necessary
  (not trivial).
- To increase the running speed write part of the groffer shell script
  in C/C++.
- Split the groffer.sh shell script into several files for better tests
  of the shell compatibility.

Features of external programs:
- Revise option handling of `grog'.
- `gxditview' needs a complete shower.

Documentation:
- Improve the documentation of the search algorithm for man pages in
  both the groffer script and the man page `groffer.man'.
- In `groff.man', add more documentation for parts that were taken over
  from GNU `man'.
- The documentation in the headers for some function definitions in
  `groffer.sh' needs to be updated.


####### License

Copyright (C) 2003,2004 Free Software Foundation, Inc.
Written by Bernd Warken

This file is part of groffer, which is part of groff.

groff is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

groff is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
License for more details.

You should have received a copy of the GNU General Public License
along with groff; see the files COPYING and LICENSE in the top
directory of the groff source.  If not, write to the Free Software
Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.