89afad4b686252e1fb412e5f8a309c65904f4130
[platform/upstream/bash.git] / README
1 Introduction
2 ============
3
4 This is GNU Bash, version 2.0.  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/features.texi'.  There is also a
11 large man page.  The manual page is the definitive description of
12 the shell's features. 
13
14 See the file CWRU/POSIX.NOTES for a discussion of how Bash differs
15 from the POSIX.2 spec and a description of the Bash `posix mode'.
16
17 There are some user-visible incompatibilities between this version
18 of Bash and the previous version, bash-1.14.  For details, see the
19 file COMPAT.
20
21 Bash is free software, distributed under the terms of the GNU Public
22 License, version 2.  For more information, see the file COPYING.
23
24 To compile Bash, try typing `./configure', then `make'.  Bash
25 auto-configures the build process, so no further intervention
26 should be necessary.  Bash builds with `gcc' by default if it is
27 available.  If you want to use `cc' instead, type
28
29         CC=cc ./configure
30
31 if you are using a Bourne-style shell.  If you are not, the following
32 may work:
33
34         env CC=cc ./configure
35
36 Read the file INSTALL in this directory for more information about how
37 to customize and control the build process.  The file NOTES contains
38 platform-specific installation and configuration information.
39
40 If you are a csh user and wish to convert your csh aliases to Bash
41 aliases, you may wish to use the script `examples/misc/alias-conv.sh'
42 as a starting point.
43
44 Reporting Bugs
45 ==============
46
47 Bug reports for 2.0 should be sent to:
48
49         bug-bash@prep.ai.mit.edu
50
51 using the `bashbug' program that is built and installed at the same
52 time as bash.
53
54 The discussion list `bug-bash@prep.ai.mit.edu' often contains
55 information about new ports of Bash, or discussions of new
56 features or behavior changes that people would like.  This
57 mailing list is also available as a usenet newsgroup:
58 gnu.bash.bug. 
59
60 When you send a bug report to bug-bash@prep.ai.mit.edu, please include:
61
62         * the version number of Bash
63         * the machine and OS that it is running on (see .machine or .made)
64         * a list of the compilation flags or the contents of `config.h', if
65           appropriate
66         * a description of the bug
67         * a recipe for recreating the bug reliably
68         * a fix for the bug if you have one!
69
70 The `bashbug' program includes much of this automatically.
71
72 If you would like to contact the Bash maintainers directly, send mail to
73 bash-maintainers@prep.ai.mit.edu.
74
75 While the Bash maintainers do not promise to fix all bugs, we would
76 like this shell to be the best that we can make it.
77
78 Enjoy!
79
80 Chet Ramey
81 chet@po.cwru.edu