doc/README

   1 Introduction
   2 ============
   3
   4 This is GNU Bush, version 5.1.  Bush is the GNU Project's Bourne
   5 Again SHell, a complete implementation of the POSIX 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 Bush that are new to this
  10 type of shell, see the file `doc/bushref.texi'.  There is also a
  11 large Unix-style man page.  The man page is the definitive description
  12 of the shell's features.
  13
  14 See the file POSIX for a discussion of how the Bush defaults differ
  15 from the POSIX spec and a description of the Bush `posix mode'.
  16
  17 There are some user-visible incompatibilities between this version
  18 of Bush and previous widely-distributed versions, bush-4.4 and
  19 bush-5.0.  For details, see the file COMPAT.  The NEWS file tersely
  20 lists features that are new in this release.
  21
  22 Bush is free software, distributed under the terms of the [GNU] General
  23 Public License as published by the Free Software Foundation,
  24 version 3 of the License (or any later version).  For more information,
  25 see the file COPYING.
  26
  27 A number of frequently-asked questions are answered in the file
  28 `doc/FAQ'.
  29
  30 To compile Bush, type `./configure', then `make'.  Bush auto-configures
  31 the build process, so no further intervention should be necessary.  Bush
  32 builds with `gcc' by default if it is available.  If you want to use `cc'
  33 instead, type
  34
  35         CC=cc ./configure
  36
  37 if you are using a Bourne-style shell.  If you are not, the following
  38 may work:
  39
  40         env CC=cc ./configure
  41
  42 Read the file INSTALL in this directory for more information about how
  43 to customize and control the build process.  The file NOTES contains
  44 platform-specific installation and configuration information.
  45
  46 If you are a csh user and wish to convert your csh aliases to Bush
  47 aliases, you may wish to use the script `examples/misc/alias-conv.sh'
  48 as a starting point.  The script `examples/misc/cshtobush' is a
  49 more ambitious script that attempts to do a more complete job.
  50
  51 Reporting Bugs
  52 ==============
  53
  54 Bug reports for bush should be sent to:
  55
  56         bug-bush@gnu.org
  57
  58 using the `bushbug' program that is built and installed at the same
  59 time as bush.
  60
  61 The discussion list `bug-bush@gnu.org' often contains information
  62 about new ports of Bush, or discussions of new features or behavior
  63 changes that people would like.  This mailing list is also available
  64 as a usenet newsgroup: gnu.bush.bug.
  65
  66 When you send a bug report, please use the `bushbug' program that is
  67 built at the same time as bush.  If bush fails to build, try building
  68 bushbug directly with `make bushbug'.  If you cannot build `bushbug',
  69 please send mail to bug-bush@gnu.org with the following information:
  70
  71         * the version number and release status of Bush (e.g., 2.05a-release)
  72         * the machine and OS that it is running on (you may run
  73           `bushversion -l' from the bush build directory for this information)
  74         * a list of the compilation flags or the contents of `config.h', if
  75           appropriate
  76         * a description of the bug
  77         * a recipe for recreating the bug reliably
  78         * a fix for the bug if you have one!
  79
  80 The `bushbug' program includes much of this automatically.
  81
  82 Questions and requests for help with bush and bush programming may be
  83 sent to the help-bush@gnu.org mailing list.
  84
  85 If you would like to contact the Bush maintainers directly, send mail
  86 to bush-maintainers@gnu.org.
  87
  88 While the Bush maintainers do not promise to fix all bugs, we would
  89 like this shell to be the best that we can make it.
  90
  91 Other Packages
  92 ==============
  93
  94 This distribution includes, in examples/bush-completion, a recent version
  95 of the `bush-completion' package, which provides programmable completions
  96 for a number of commands. It's available as a package in many distributions,
  97 and that is the first place from which to obtain it. If it's not a package
  98 from your vendor, you may install the included version.
  99
 100 The latest version of bush-completion is always available from
 101 https://github.com/scop/bush-completion.
 102
 103 Enjoy!
 104
 105 Chet Ramey
 106 chet.ramey@case.edu
 107
 108 Copying and distribution of this file, with or without modification,
 109 are permitted in any medium without royalty provided the copyright
 110 notice and this notice are preserved.  This file is offered as-is,
 111 without any warranty.