Shell-scripting Notes

Notes on doing shell-scripting: hints, tips & tricks, and peculiarities.

Documenting

• Doxygen comments

Find here a Doxygen filter for processing Doxygen tags in your shell scripts. Currently it only supports file and function comment blocks; global and local variables are not supported.

The filter is a lex file, so you have to compile it first:

# lex filter_sh.lex
# cc -o filter_sh lex.yy.c -lfl

Next, move the executable filter_sh in your search path and update your Doxyfile to process shell scripts with filter_sh. I use something like this in my Doxyfile:

FILE_PATTERNS = *.sh
INPUT_FILTER  = "~/bin/filter_sh"

Documentation

A reference sheet listing the key bindings for readline commands under Bash.
I've prepared a PostScript version (PS) and a PDF version (PDF).
The markup of the reference sheet is plain TeX (TEX).