Imported from ../bash-1.14.7.tar.gz.
[platform/upstream/bash.git] / documentation / 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 features' document, suitable for an info tree
8 readline.3      - the readline man page
9
10 The `.ps' files are postscript versions of the above.  The `.txt' versions
11 are ascii -- the output of `nroff'.
12
13 The rest of this file explains how to use the `builtins.1' man page.
14
15 For each command in the list of builtins create a file in man/man1 called:
16
17 ${command}.1
18
19 eg.
20 for.1
21 type.1
22 alias.1
23 etc.
24
25 All these files are identical as follows:
26
27 jaws@jaws(264)$ cat alias.1
28 .so man1/builtins.1
29 jaws@jaws(265)$ 
30
31 Make sure you adjust the .so line in builtins.1 to reflect where you
32 put it.