doc/README

   1 This directory contains the bash documentation.
   2
   3 FAQ             - a set of frequently-asked questions about Bash with answers
   4 article.ms      - an article I wrote about bash for The Linux Journal
   5 bash.1          - the bash man page
   6 builtins.1      - a man page that documents the builtins, extracted from bash.1
   7 features.texi   - the `bash reference manual'
   8 features.info   - the `bash reference manual' processed by `makeinfo'
   9 readline.3      - the readline man page
  10
  11 The `.ps' files are postscript versions of the above.  The `.html'
  12 files are HTML versions of the man page and reference manual.  The
  13 `.0' files are formatted manual pages.  The `.txt' versions are
  14 ascii -- the output of `groff -Tascii'.
  15
  16 The rest of this file explains how to use the `builtins.1' man page.
  17
  18 For each command in the list of builtins create a file in man/man1 called:
  19
  20 ${command}.1
  21
  22 eg.
  23 for.1
  24 type.1
  25 alias.1
  26 etc.
  27
  28 All these files are identical as follows:
  29
  30 jaws@jaws(264)$ cat alias.1
  31 .so man1/builtins.1
  32 jaws@jaws(265)$
  33
  34 Make sure you adjust the .so line in builtins.1 to reflect where you
  35 put it.