blob: 3eceeb50fa2b0cfc383a8287c78cd6ee088890f6 [file] [log] [blame]
Jari Aaltoccc6cda1996-12-23 17:02:34 +00001Introduction
2============
Jari Aalto726f6381996-08-26 18:22:31 +00003
Jari Aaltobb706242000-03-17 21:46:59 +00004This is GNU Bash, version 2.04. Bash is the GNU Project's Bourne
Jari Aaltoccc6cda1996-12-23 17:02:34 +00005Again SHell, a complete implementation of the POSIX.2 shell spec,
Jari Aalto726f6381996-08-26 18:22:31 +00006but also with interactive command line editing, job control on
Jari Aaltoccc6cda1996-12-23 17:02:34 +00007architectures that support it, csh-like features such as history
8substitution and brace expansion, and a slew of other features.
9For more information on the features of Bash that are new to this
Jari Aaltod166f041997-06-05 14:59:13 +000010type of shell, see the file `doc/bashref.texi'. There is also a
11large Unix-style man page. The man page is the definitive description
12of the shell's features.
Jari Aalto726f6381996-08-26 18:22:31 +000013
Jari Aaltoccc6cda1996-12-23 17:02:34 +000014See the file CWRU/POSIX.NOTES for a discussion of how Bash differs
15from the POSIX.2 spec and a description of the Bash `posix mode'.
Jari Aalto726f6381996-08-26 18:22:31 +000016
Jari Aaltoccc6cda1996-12-23 17:02:34 +000017There are some user-visible incompatibilities between this version
Jari Aaltod166f041997-06-05 14:59:13 +000018of Bash and the previous widely-distributed version, bash-1.14.
19For details, see the file COMPAT. The NEWS file tersely lists
20features that are new in this release.
Jari Aaltoccc6cda1996-12-23 17:02:34 +000021
22Bash is free software, distributed under the terms of the GNU Public
23License, version 2. For more information, see the file COPYING.
24
Jari Aaltod166f041997-06-05 14:59:13 +000025A number of frequently-asked questions are answered in the file
26`doc/FAQ'.
27
Jari Aaltoccc6cda1996-12-23 17:02:34 +000028To compile Bash, try typing `./configure', then `make'. Bash
29auto-configures the build process, so no further intervention
30should be necessary. Bash builds with `gcc' by default if it is
31available. If you want to use `cc' instead, type
32
33 CC=cc ./configure
34
35if you are using a Bourne-style shell. If you are not, the following
36may work:
37
38 env CC=cc ./configure
39
40Read the file INSTALL in this directory for more information about how
41to customize and control the build process. The file NOTES contains
42platform-specific installation and configuration information.
Jari Aalto726f6381996-08-26 18:22:31 +000043
44If you are a csh user and wish to convert your csh aliases to Bash
Jari Aaltoccc6cda1996-12-23 17:02:34 +000045aliases, you may wish to use the script `examples/misc/alias-conv.sh'
Jari Aaltod166f041997-06-05 14:59:13 +000046as a starting point. The script `examples/misc/cshtobash' is a
47more ambitious script that attempts to do a more complete job.
Jari Aalto726f6381996-08-26 18:22:31 +000048
Jari Aaltoccc6cda1996-12-23 17:02:34 +000049Reporting Bugs
50==============
51
Jari Aaltob72432f1999-02-19 17:11:39 +000052Bug reports for bash should be sent to:
Jari Aalto726f6381996-08-26 18:22:31 +000053
Jari Aaltobb706242000-03-17 21:46:59 +000054 bug-bash@gnu.org
Jari Aalto726f6381996-08-26 18:22:31 +000055
56using the `bashbug' program that is built and installed at the same
57time as bash.
58
Jari Aaltobb706242000-03-17 21:46:59 +000059The discussion list `bug-bash@gnu.org' often contains information
60about new ports of Bash, or discussions of new features or behavior
61changes that people would like. This mailing list is also available
62as a usenet newsgroup: gnu.bash.bug.
Jari Aalto726f6381996-08-26 18:22:31 +000063
Jari Aaltod166f041997-06-05 14:59:13 +000064When you send a bug report, please use the `bashbug' program that is
65built at the same time as bash. If bash fails to build, try building
66bashbug directly with `make bashbug'. If you cannot build `bashbug',
Jari Aaltobb706242000-03-17 21:46:59 +000067please send mail to bug-bash@gnu.org with the following information:
Jari Aalto726f6381996-08-26 18:22:31 +000068
Jari Aaltob72432f1999-02-19 17:11:39 +000069 * the version number and release status of Bash (e.g., 2.01-release)
Jari Aaltod166f041997-06-05 14:59:13 +000070 * the machine and OS that it is running on (look at the file
71 `.made' in the bash build directory)
Jari Aaltoccc6cda1996-12-23 17:02:34 +000072 * a list of the compilation flags or the contents of `config.h', if
73 appropriate
Jari Aalto726f6381996-08-26 18:22:31 +000074 * a description of the bug
75 * a recipe for recreating the bug reliably
76 * a fix for the bug if you have one!
77
78The `bashbug' program includes much of this automatically.
79
Jari Aaltod166f041997-06-05 14:59:13 +000080If you would like to contact the Bash maintainers directly, send mail
Jari Aaltobb706242000-03-17 21:46:59 +000081to bash-maintainers@gnu.org.
Jari Aaltoccc6cda1996-12-23 17:02:34 +000082
Jari Aalto726f6381996-08-26 18:22:31 +000083While the Bash maintainers do not promise to fix all bugs, we would
84like this shell to be the best that we can make it.
85
86Enjoy!
87
88Chet Ramey
89chet@po.cwru.edu