blob: 2d43cea62284fdee3ff22dacc0d7dbe276fadf52 [file] [log] [blame]
Jari Aaltoccc6cda1996-12-23 17:02:34 +00001Introduction
2============
Jari Aalto726f6381996-08-26 18:22:31 +00003
Jari Aalto31859422009-01-12 13:36:28 +00004This is GNU Bash, version 4.0. 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 Aaltob80f6442004-07-27 13:29:18 +000014See the file POSIX for a discussion of how the Bash defaults differ
Jari Aaltoccc6cda1996-12-23 17:02:34 +000015from 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 Aalto31859422009-01-12 13:36:28 +000018of Bash and previous widely-distributed versions, bash-2.05b and
19bash-3.2. For details, see the file COMPAT. The NEWS file tersely
Jari Aalto06285672006-10-10 14:15:34 +000020lists features that are new in this release.
Jari Aaltoccc6cda1996-12-23 17:02:34 +000021
Jari Aalto31859422009-01-12 13:36:28 +000022Bash is free software, distributed under the terms of the [GNU] General
23Public License as published by the Free Software Foundation,
24version 3 of the License (or any later version). For more information,
25see the file COPYING.
Jari Aaltoccc6cda1996-12-23 17:02:34 +000026
Jari Aaltod166f041997-06-05 14:59:13 +000027A number of frequently-asked questions are answered in the file
28`doc/FAQ'.
29
Jari Aaltoccc6cda1996-12-23 17:02:34 +000030To compile Bash, try typing `./configure', then `make'. Bash
31auto-configures the build process, so no further intervention
32should be necessary. Bash builds with `gcc' by default if it is
33available. If you want to use `cc' instead, type
34
35 CC=cc ./configure
36
37if you are using a Bourne-style shell. If you are not, the following
38may work:
39
40 env CC=cc ./configure
41
42Read the file INSTALL in this directory for more information about how
43to customize and control the build process. The file NOTES contains
44platform-specific installation and configuration information.
Jari Aalto726f6381996-08-26 18:22:31 +000045
46If you are a csh user and wish to convert your csh aliases to Bash
Jari Aaltoccc6cda1996-12-23 17:02:34 +000047aliases, you may wish to use the script `examples/misc/alias-conv.sh'
Jari Aaltod166f041997-06-05 14:59:13 +000048as a starting point. The script `examples/misc/cshtobash' is a
49more ambitious script that attempts to do a more complete job.
Jari Aalto726f6381996-08-26 18:22:31 +000050
Jari Aaltoccc6cda1996-12-23 17:02:34 +000051Reporting Bugs
52==============
53
Jari Aaltob72432f1999-02-19 17:11:39 +000054Bug reports for bash should be sent to:
Jari Aalto726f6381996-08-26 18:22:31 +000055
Jari Aaltobb706242000-03-17 21:46:59 +000056 bug-bash@gnu.org
Jari Aalto726f6381996-08-26 18:22:31 +000057
58using the `bashbug' program that is built and installed at the same
59time as bash.
60
Jari Aaltobb706242000-03-17 21:46:59 +000061The discussion list `bug-bash@gnu.org' often contains information
62about new ports of Bash, or discussions of new features or behavior
63changes that people would like. This mailing list is also available
64as a usenet newsgroup: gnu.bash.bug.
Jari Aalto726f6381996-08-26 18:22:31 +000065
Jari Aaltod166f041997-06-05 14:59:13 +000066When you send a bug report, please use the `bashbug' program that is
67built at the same time as bash. If bash fails to build, try building
68bashbug directly with `make bashbug'. If you cannot build `bashbug',
Jari Aaltobb706242000-03-17 21:46:59 +000069please send mail to bug-bash@gnu.org with the following information:
Jari Aalto726f6381996-08-26 18:22:31 +000070
Jari Aalto7117c2d2002-07-17 14:10:11 +000071 * the version number and release status of Bash (e.g., 2.05a-release)
72 * the machine and OS that it is running on (you may run
73 `bashversion -l' from the bash build directory for this information)
Jari Aaltoccc6cda1996-12-23 17:02:34 +000074 * a list of the compilation flags or the contents of `config.h', if
75 appropriate
Jari Aalto726f6381996-08-26 18:22:31 +000076 * a description of the bug
77 * a recipe for recreating the bug reliably
78 * a fix for the bug if you have one!
79
80The `bashbug' program includes much of this automatically.
81
Jari Aaltod166f041997-06-05 14:59:13 +000082If you would like to contact the Bash maintainers directly, send mail
Jari Aaltobb706242000-03-17 21:46:59 +000083to bash-maintainers@gnu.org.
Jari Aaltoccc6cda1996-12-23 17:02:34 +000084
Jari Aalto726f6381996-08-26 18:22:31 +000085While the Bash maintainers do not promise to fix all bugs, we would
86like this shell to be the best that we can make it.
87
88Enjoy!
89
90Chet Ramey
Jari Aalto06285672006-10-10 14:15:34 +000091chet.ramey@case.edu