| 1 |
# Gash --- Guile As SHell |
| 2 |
|
| 3 |
Gash is a POSIX-compatible shell written in Guile Scheme. It provides |
| 4 |
both the shell interface, as well as a Guile library for parsing shell |
| 5 |
scripts. Gash is designed to bootstrap Bash as part of the Guix |
| 6 |
bootstrap process. We are planning to develop Gash into a |
| 7 |
general-purpose shell and tool for building interfaces between Scheme |
| 8 |
and the shell. |
| 9 |
|
| 10 |
It is still early days for Gash. At the moment, Gash is extremely |
| 11 |
limited and extremely slow, so we cannot recommend using it as your |
| 12 |
shell. It does its bootstrapping job, and the parser works well for |
| 13 |
POSIX-compatible scripts, but that's about it. |
| 14 |
|
| 15 |
## Installing |
| 16 |
|
| 17 |
This package uses GNU Autotools for building and installing. You may |
| 18 |
build it like this: |
| 19 |
|
| 20 |
./bootstrap |
| 21 |
./configure |
| 22 |
make |
| 23 |
make check |
| 24 |
sudo make install |
| 25 |
|
| 26 |
If you have GNU Guix, you can skip all that and install the package |
| 27 |
by running: |
| 28 |
|
| 29 |
guix package -f guix.scm |
| 30 |
|
| 31 |
Gash is designed to work with Guile versions as early as 2.0.9. |
| 32 |
|
| 33 |
Normally, you should build Gash using 'configure' and 'make'. |
| 34 |
However, it can be built with nothing but Guile. There is an example |
| 35 |
of this in the file 'tests/bootstrap/bash-without-bash.scm'. |
| 36 |
|
| 37 |
## Testing |
| 38 |
|
| 39 |
Gash includes a number of unit and integration tests that can be run |
| 40 |
using 'make check'. If you are using Guile 2.0.9, you will have to |
| 41 |
make SRFI 64 available to run the unit tests. To do this, you can |
| 42 |
copy 'module/srfi/srfi-64.scm' and the 'module/srfi/srfi-64' directory |
| 43 |
from a newer version of Guile into a directory named 'srfi' in the |
| 44 |
Gash source code directory. |
| 45 |
|
| 46 |
If you have GNU Guix, you can also run the following extra tests. |
| 47 |
|
| 48 |
The bootstrap test can be run using 'make check-bootstrap'. It builds |
| 49 |
Gash using nothing but Guix's bootstrap Guile, then uses Gash to build |
| 50 |
Bash using Guix's bootstrap toolchain. This test is designed to make |
| 51 |
sure that Gash is suitable for bootstrapping. |
| 52 |
|
| 53 |
The specification tests can be run using 'make check-spec'. These |
| 54 |
tests get copied and adapted from Oil <https://www.oilshell.org/>, and |
| 55 |
then run against Gash. |
| 56 |
|
| 57 |
## Contributing |
| 58 |
|
| 59 |
You can report bugs and propose changes on Codeberg: |
| 60 |
|
| 61 |
https://codeberg.org/guix/gash |
| 62 |
|
| 63 |
A mailing list is also available for discussions: |
| 64 |
|
| 65 |
https://lists.gnu.org/mailman/listinfo/gash-devel |
| 66 |
|
| 67 |
## Copying Gash |
| 68 |
|
| 69 |
Gash is free software released under the GNU GPLv3 (or later). See |
| 70 |
'COPYING' for the full license. Enjoy! |
| 71 |
|
| 72 |
## Copying this file |
| 73 |
|
| 74 |
This file was written by Timothy Sample <[email protected]>. |
| 75 |
|
| 76 |
To the extent possible under law, the author(s) have waived all |
| 77 |
copyright and related or neighboring rights to this file. |
| 78 |
|
| 79 |
You should have received a copy of the CC0 legalcode along with this |
| 80 |
work. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. |