summaryrefslogtreecommitdiff
path: root/documentation/README
blob: c20007dbce059ac6607dec896c1d5c2ab6d04124 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
This directory contains the bash documentation.

FAQ		- a set of frequently-asked questions about Bash with answers
article.ms	- an article I wrote about bash for The Linux Journal
bash.1		- the bash man page
builtins.1	- a man page that documents the builtins, extracted from bash.1
features.texi	- the `bash features' document, suitable for an info tree
readline.3	- the readline man page

The `.ps' files are postscript versions of the above.  The `.txt' versions
are ascii -- the output of `nroff'.

The rest of this file explains how to use the `builtins.1' man page.

For each command in the list of builtins create a file in man/man1 called:

${command}.1

eg.
for.1
type.1
alias.1
etc.

All these files are identical as follows:

jaws@jaws(264)$ cat alias.1
.so man1/builtins.1
jaws@jaws(265)$ 

Make sure you adjust the .so line in builtins.1 to reflect where you
put it.