xref: /zile/
Name Date Size

..29-Nov-20194 KiB

.gitignoreH A D13-Aug-2017410

.gitmodulesH A D01-Jun-2018182

.prev-versionH A D15-Jan-20187

AUTHORSH A D13-Aug-2017582

bootstrapH A D01-Jun-2018154 KiB

bootstrap.confH A D01-Jun-20185.4 KiB

build-aux/H13-Aug-20174 KiB

cfg.mkH A D15-Jan-20181.3 KiB

configure.acH A D08-Jan-20195.3 KiB

doc/H15-Jan-20184 KiB

FAQH A D15-Jan-20184 KiB

gl/H01-Jun-20184 KiB

gl-mod/bootstrap/H01-Jun-20184 KiB

gnulib/H13-Aug-20174 KiB

m4/H08-Jan-20194 KiB

Makefile.amH A D15-Jan-20183.2 KiB

NEWSH A D15-Jan-201823.7 KiB

READMEH A D01-Jun-20188 KiB

src/H01-Jun-20184 KiB

tests/H15-Jan-201812 KiB

THANKSH A D13-Aug-20172.3 KiB

README

1GNU Zile
2========
3
4GNU Zile is free software, licensed under the GNU GPL.
5
6Copyright (c) 1997-2016 Free Software Foundation, Inc.
7
8**Copying and distribution of this file, with or without modification,
9are permitted in any medium without royalty provided the copyright
10notice and this notice are preserved.**
11
12_This file is marked up in [MultiMarkdown][] syntax_.
13
14  [MultiMarkdown]: http://fletcherpenney.net/multimarkdown
15
16------------------------------------------------------------------------
17
18Contents
19========
20
211. [INTRODUCTION][]
22   * [Source Layout][]
23   * [Web Pages][]
24   * [Mailing Lists][]
252. [OBTAINING THE LATEST SOURCES][]
26   * [Official Release][]
27   * [Development Sources][]
283. [REPORTING BUGS][]
29
30------------------------------------------------------------------------
31
32INTRODUCTION
33============
34
35GNU Zile (_Zile Is Lossy Emacs_) is a lightweight [Emacs][] clone. Every
36Emacs user should feel at home with Zile. Zile is aimed at small
37footprint systems (a typical binary is about 100Kb) and quick editing
38sessions (it starts up and shuts down instantly).
39
40Zile is written in **ISO C99** using **POSIX.1-2008** APIs, using
41[libgc][]. It can be built on many other platforms thanks to its use
42of [gnulib][] (version 7.2 or later seems to be required for testing
43with Valgrind, but older versions seem to work fine for normal use).
44
45  [Emacs]:   http://www.gnu.org/s/emacs
46  [libgc]:   http://www.hpl.hp.com/personal/Hans_Boehm/gc
47  [gnulib]:  http://www.gnu.org/s/gnulib
48
49
50Source Layout
51-------------
52
53 * See file `AUTHORS` for the names of maintainers past and present.
54 * See file `COPYING` for copying conditions.
55 * See file `FAQ` for a selection of a Frequently Answered Questions.
56 * See file `INSTALL` for generic compilation and installation
57   instructions.
58 * See file `NEWS` for a list of major changes in each Zile release.
59 * See file `THANKS` for a list of important contributors.
60
61The rest of the files in the top-level directory are part of the
62[Autotools]() build system used to compile and install Zile.
63
64 * Directory `build-aux` contains helper scripts used to build Zile.
65 * Directory `doc` contains files used to create Zile's documentation.
66 * Directory `gl` contains Zile-specific patches to standard [gnulib]().
67 * Directory `lib` contains [gnulib]() source modules used by Zile.
68 * Directory `m4` contains a mixture of [gnulib]() supplied and Zile-
69   specific macros for rebuilding the `configure' script.
70 * Directory `src` contains the source code used to build Zile.
71 * Directory `tests` contains a small suite of tests used by
72   `make check` to sanity check a newly built `src/zile` binary.
73
74  [Autotools]: http://sourceware.org/autobook/
75
76
77Web Pages
78---------
79
80GNU Zile's home page is at:
81
82  > <http://www.gnu.org/s/zile/>
83
84GNU Zile development is co-ordinated from Zile's project page at GNU
85Savannah:
86
87  > <http://savannah.gnu.org/projects/zile/>
88
89An archive of past releases is also archived at:
90
91  > <http://ftp.gnu.org/gnu/zile/>
92
93But please use a mirror for faster downloads and to reduce stress on the
94main gnu machine. The following link will automatically redirect to a
95nearest mirror:
96
97  > <http://ftpmirror.gnu.org/zile/>
98
99Or you can manually select a mirror from the list at:
100
101  > <http://www.gnu.org/order/ftp.html>
102
103
104Mailing Lists
105-------------
106
107Questions, comments and requests should be sent to the Zile user's list
108at <help-zile@gnu.org>.
109
110See [REPORTING BUGS][] for the bug reporting mailing list address.
111
112
113OBTAINING THE LATEST SOURCES
114============================
115
116If you are just building GNU Zile from an [Official Release][], you
117should not normally need to run `./bootstrap` or `autoreconf`; just go
118ahead and start with `./configure`.
119
120If you are trying to build GNU Zile from the [Development Sources][],
121`./configure` will not work until the `./bootstrap` script has completed
122successfully.
123
124
125Official Release
126----------------
127
128Compressed tarballs of all recent GNU Zile releases are available from:
129
130  > <http://ftpmirror.gnu.org/zile>
131
132Compressed tarballs of unstable prereleases are sometimes made available
133from:
134
135  > <ftp://alpha.gnu.org/gnu/zile>
136
137Official tarballs are supplied with a [GnuPG][] detached signature file
138so that you can verify that the corresponding tarball is still the same
139file that was released by the owner of its GPG key ID. First, be sure to
140download both the .sig file and the corresponding release:
141
142    wget http://ftpmirror.gnu.org/zile/zile-2.3.24.tar.gz
143    wget http://ftpmirror.gnu.org/zile/zile-2.3.24.tar.gz.sig
144
145then run a command like this:
146
147    gpg --verify zile-2.3.24.tar.gz.sig
148
149If that command fails because you don't have the required public key,
150then run this command to import it:
151
152    gpg --keyserver keys.gnupg.net --recv-keys 80EE4A00
153
154and then rerun the `gpg --verify' command.
155
156Generic instructions for how to build GNU Zile from a release tarball
157are contained in the file `INSTALL`. Additionally, If you wish to use a
158non-standard curses library name, this can be specified using
159`CURSES_LIB` and `CPPFLAGS`. For example, to use the X version of
160[PDcurses][]:
161
162    CPPFLAGS=/usr/local/include/xcurses CURSES_LIB=-lXCurses ./configure
163
164If you are missing any of the prerequisite libraries needed to
165successfully build GNU Zile, the `configure` script will abort itself
166and tell you right away.
167
168  [GnuPG]:    http://www.gnupg.org/
169  [PDcurses]: http://pdcurses.sf.ne
170
171
172Development Sources
173-------------------
174
175Zile development sources are maintained at the GNU Savannah git server:
176
177  > [git://git.sv.gnu.org/zile.git][gitbrowser]
178
179You can fetch a read-only copy with:
180
181    git clone git://git.sv.gnu.org/zile.git
182
183If you are behind a firewall that blocks the git protocol, you can force
184git to transparently rewrite all savannah references to use http:
185
186    git config --global url.http://git.sv.gnu.org/r/.insteadof \
187	git://git.sv.gnu.org/
188
189When you are building GNU Zile from a git checkout, you first need to
190checkout git submodules:
191
192    git submodule update --init --recursive
193
194then run the `bootstrap` script to generate various files that are shipped
195in release tarballs, but not checked in to git.
196
197Normally, you just need to run `./bootstrap`, and it will either get
198everything ready so that you can then run `./configure` as would for a
199release tarball, or else tell you if your machine is missing some
200packages that it needs in order to do that. One of the first things that
201`bootstrap` will do the first time you run it in a freshly cloned git
202tree is to clone a copy of [gnulib][] as a submodule. If you already
203have an up-to-date [gnulib][] clone on your machine, you can save the
204time and bandwidth of downloading it again by using `--gnulib-srcdir` to
205point at your existing gnulib directory:
206
207    ./bootstrap --gnulib-srcdir=/path/to/existing/gnulib/checkout/
208
209With a copy of gnulib now installed as a submodule, if you wish, you can
210continue to work off-line by passing `--skip-git` to rerun the
211`bootstrap` script, otherwise subsequent `bootstrap` runs will refresh
212the contents of the submodule:
213
214    ./bootstrap --skip-git
215
216  [gitbrowser]: http://git.sv.gnu.org/cgit/zile.git
217
218
219REPORTING BUGS
220==============
221
222If this distribution doesn't work for you, before you report the
223problem, please try upgrading to the latest released version first, to
224see whether your issue has been fixed already. If you can, please also
225check whether the latest development sources for the next release still
226exhibit the problem (see [OBTAINING THE LATEST SOURCES][] above).
227
228Please send bug reports, feature requests and patches to
229<bug-zile@gnu.org> or, preferably, file them directly in the relevant
230tracker at <http://savannah.gnu.org/projects/zile/>.
231
232When you are ready to submit a report, first, please read this:
233
234  > <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>
235
236Zile has a suite of Lisp tests in the tests directory of the source
237distribution, which you can run with:
238
239    make check
240
241If, when you report a bug, you can create a similar test that
242demonstrates it, the maintainers will be most grateful, and it will
243prevent them from accidentally reintroducing the bug in a subsequent
244release.
245