I would like to make a few small suggestions about the teTeX
documentation, based on what I see in version 1.0.

1. Running texdoc with no arguments does nothing. Why not make it run
the --help option?

2. It would be good if this command would show something useful:

  texdoc texdoc

3. It would be good if this command would show something useful:

  texdoc teTeX

Maybe by having symlinks teTeX.pdf -> TETEXDOC.pdf, teTeX.dvi ->
TETEXDOC.dvi, etc.?

4. It would be good if this command would show the FAQ with "more", or
something to that effect:

  texdoc teTeX-FAQ

Instead what I see is this:

  /usr/local/bin/texdoc: /usr/local/teTeX/share/texmf/doc/tetex/teTeX-FAQ: cannot 
execute

Perhaps something along the lines of

  case "$filename" in
    *FAQ *faq *.txt *README*) $TEXDOCVIEW_txt $filename ;;
    ...

5. It would be good to have an additional option to allow grepping
through the documentation tree, perhaps

  texdoc -l -s 'regular-expression-for-grep'

This would be slower, of course, but it would help to have it as a
fallback for situations like

  texdoc teTeX
  texdoc amsthm

that fail only because the documentation file is called by a different
name.

This would only work well if it were a general practice to have *.tex
and other source formats in the doc tree for searching, in addition to
the derived formats for viewing. But I think this is a good idea anyway,
because not infrequently when looking at some documentation it is useful
also to look at the source to see how the documentation was produced.

Or, perhaps, have a parallel subtree "docsource" ??

I am willing to help work on some of these features but I wanted to ask first
if some or all of them are already being addressed by others.

Reply via email to