doc/README

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