Patch-ID: bash32-029
[bash.git] / README
blob4a4f2704895ca391796eae70e7f3d26025ce5833
1 Introduction
2 ============
4 This is GNU Bash, version 3.2.  Bash is the GNU Project's Bourne
5 Again SHell, a complete implementation of the POSIX.2 shell spec,
6 but also with interactive command line editing, job control on
7 architectures that support it, csh-like features such as history
8 substitution and brace expansion, and a slew of other features. 
9 For more information on the features of Bash that are new to this
10 type of shell, see the file `doc/bashref.texi'.  There is also a
11 large Unix-style man page.  The man page is the definitive description
12 of the shell's features. 
14 See the file POSIX for a discussion of how the Bash defaults differ
15 from the POSIX.2 spec and a description of the Bash `posix mode'.
17 There are some user-visible incompatibilities between this version
18 of Bash and previous widely-distributed versions, bash-1.14 and
19 bash-2.05b.  For details, see the file COMPAT.  The NEWS file tersely
20 lists features that are new in this release. 
22 Bash is free software, distributed under the terms of the [GNU]
23 General Public License, version 2.  For more information, see the
24 file COPYING.
26 A number of frequently-asked questions are answered in the file
27 `doc/FAQ'.
29 To compile Bash, try typing `./configure', then `make'.  Bash
30 auto-configures the build process, so no further intervention
31 should be necessary.  Bash builds with `gcc' by default if it is
32 available.  If you want to use `cc' instead, type
34         CC=cc ./configure
36 if you are using a Bourne-style shell.  If you are not, the following
37 may work:
39         env CC=cc ./configure
41 Read the file INSTALL in this directory for more information about how
42 to customize and control the build process.  The file NOTES contains
43 platform-specific installation and configuration information.
45 If you are a csh user and wish to convert your csh aliases to Bash
46 aliases, you may wish to use the script `examples/misc/alias-conv.sh'
47 as a starting point.  The script `examples/misc/cshtobash' is a
48 more ambitious script that attempts to do a more complete job.
50 Reporting Bugs
51 ==============
53 Bug reports for bash should be sent to:
55         bug-bash@gnu.org
57 using the `bashbug' program that is built and installed at the same
58 time as bash.
60 The discussion list `bug-bash@gnu.org' often contains information
61 about new ports of Bash, or discussions of new features or behavior
62 changes that people would like.  This mailing list is also available
63 as a usenet newsgroup: gnu.bash.bug. 
65 When you send a bug report, please use the `bashbug' program that is
66 built at the same time as bash.  If bash fails to build, try building
67 bashbug directly with `make bashbug'.  If you cannot build `bashbug',
68 please send mail to bug-bash@gnu.org with the following information:
70         * the version number and release status of Bash (e.g., 2.05a-release)
71         * the machine and OS that it is running on (you may run
72           `bashversion -l' from the bash build directory for this information)
73         * a list of the compilation flags or the contents of `config.h', if
74           appropriate
75         * a description of the bug
76         * a recipe for recreating the bug reliably
77         * a fix for the bug if you have one!
79 The `bashbug' program includes much of this automatically.
81 If you would like to contact the Bash maintainers directly, send mail
82 to bash-maintainers@gnu.org.
84 While the Bash maintainers do not promise to fix all bugs, we would
85 like this shell to be the best that we can make it.
87 Enjoy!
89 Chet Ramey
90 chet.ramey@case.edu