The traditional vi
Go to file
Gunnar Ritter aada6fd740 * Ex does not exit on errors immediately anymore if standard input is not
a terminal but a pipe or regular file.
2005-02-17 17:00:56 +00:00
catd Initial revision 2004-12-04 13:17:05 +00:00
libterm Initial revision 2004-12-04 13:17:05 +00:00
Changes * Ex does not exit on errors immediately anymore if standard input is not 2005-02-17 17:00:56 +00:00
LICENSE Initial revision 2004-12-04 13:17:05 +00:00
Makefile changes to adopt local structure 2004-12-04 13:27:58 +00:00
README * Made multicolumn characters work in lines longer than the screen width in 2005-02-15 16:31:11 +00:00
TODO Initial revision 2004-12-04 13:17:05 +00:00
config.h Initial revision 2004-12-04 13:17:05 +00:00
ex.1 Initial revision 2004-12-04 13:17:05 +00:00
ex.c * Made multicolumn characters work in lines longer than the screen width in 2005-02-15 16:31:11 +00:00
ex.h * Ex does not exit on errors immediately anymore if standard input is not 2005-02-17 17:00:56 +00:00
ex.spec documented support for East Asian encodings 2005-01-22 16:54:26 +00:00
ex_addr.c * When the name of a nonexisting file is given with the 'edit' ex command, 2005-02-17 14:48:49 +00:00
ex_argv.h Initial revision 2004-12-04 13:17:05 +00:00
ex_cmds.c * Ex does not exit on errors immediately anymore if standard input is not 2005-02-17 17:00:56 +00:00
ex_cmds2.c * Ex does not exit on errors immediately anymore if standard input is not 2005-02-17 17:00:56 +00:00
ex_cmdsub.c * Ex does not exit on errors immediately anymore if standard input is not 2005-02-17 17:00:56 +00:00
ex_data.c Initial revision 2004-12-04 13:17:05 +00:00
ex_extern.c Initial revision 2004-12-04 13:17:05 +00:00
ex_get.c * The 'source' ex command now works if command input comes from a pipe or 2005-02-17 16:03:03 +00:00
ex_io.c * The 'source' ex command now works if command input comes from a pipe or 2005-02-17 16:03:03 +00:00
ex_proto.h * When moving left while the cursor is positioned over a multicolumn 2005-02-15 22:39:33 +00:00
ex_put.c * If standard output is not a terminal, no '\r' is written at the end of 2005-02-17 15:16:43 +00:00
ex_re.c * Made multicolumn characters work in lines longer than the screen width in 2005-02-15 16:31:11 +00:00
ex_re.h Initial revision 2004-12-04 13:17:05 +00:00
ex_set.c Initial revision 2004-12-04 13:17:05 +00:00
ex_subr.c * When moving left while the cursor is positioned over a multicolumn 2005-02-15 22:39:33 +00:00
ex_tagio.c Initial revision 2004-12-04 13:17:05 +00:00
ex_temp.c Initial revision 2004-12-04 13:17:05 +00:00
ex_temp.h Initial revision 2004-12-04 13:17:05 +00:00
ex_tty.c * If standard output is not a terminal, no '\r' is written at the end of 2005-02-17 15:16:43 +00:00
ex_tty.h Initial revision 2004-12-04 13:17:05 +00:00
ex_tune.h Initial revision 2004-12-04 13:17:05 +00:00
ex_unix.c Initial revision 2004-12-04 13:17:05 +00:00
ex_v.c Initial revision 2004-12-04 13:17:05 +00:00
ex_vadj.c Initial revision 2004-12-04 13:17:05 +00:00
ex_vars.h Initial revision 2004-12-04 13:17:05 +00:00
ex_version.c * If both the '-t' and the '-c' option are given, the '-t' option is now 2005-02-17 12:15:36 +00:00
ex_vget.c singlebyte compile fixes 2005-02-15 16:55:39 +00:00
ex_vis.h * Undoing the replacement of a multicolumn character by a singlecolumn 2005-01-10 21:59:00 +00:00
ex_vmain.c Initial revision 2004-12-04 13:17:05 +00:00
ex_voper.c * When moving left while the cursor is positioned over a multicolumn 2005-02-15 22:39:33 +00:00
ex_vops.c * The position of '$' when changing text was fixed for cases where the first 2005-01-13 19:03:43 +00:00
ex_vops2.c * When an illegal multibyte sequence is entered in vi insert mode, no garbage 2005-01-12 17:26:23 +00:00
ex_vops3.c * Handle character case conversions with the '~' vi command correctly if the 2005-01-01 23:14:53 +00:00
ex_vput.c * When moving left while the cursor is positioned over a multicolumn 2005-02-15 22:39:33 +00:00
ex_vwind.c Initial revision 2004-12-04 13:17:05 +00:00
expreserve.c Initial revision 2004-12-04 13:17:05 +00:00
exrecover.c Initial revision 2004-12-04 13:17:05 +00:00
makeoptions Initial revision 2004-12-04 13:17:05 +00:00
malloc.c Initial revision 2004-12-04 13:17:05 +00:00
mapmalloc.c Initial revision 2004-12-04 13:17:05 +00:00
printf.c Initial revision 2004-12-04 13:17:05 +00:00
vi.1 Initial revision 2004-12-04 13:17:05 +00:00

README

Welcome to the ex/vi port!
==========================

This implementation is derived from ex/vi 3.7 of 6/7/85 and the BSD
termcap library, originally from the 2.11BSD distribution. All of them
were changed to compile and run on newer POSIX compatible Unix systems.
Support for international character sets was added, including support
for multibyte locales (based on UTF-8 or East Asian encodings), and some
changes were made to get closer to the POSIX.2 guidelines for ex and
vi. Some issues that were clearly bugs and not features have also been
resolved; see the Changes file for details.

New releases are announced on Freshmeat. If you want to get
notified by email on each release, use their subscription service at
<http://freshmeat.net/projects/vi/>.

The project homepage is currently at <http://ex-vi.sourceforge.net>.


How to build
============

First look at the Makefile and change the settings there to match your
build environment. Explanations are provided directly in this file.

You can tune the sizes of some internal buffers by editing config.h. In
particular, you will have to raise the size of the 'TUBE' constants if
you wish to use really large-sized terminals.

Then type 'make' and 'make install'.

It is possible to build a RPM file directly from the source distribution
by executing

	rpmbuild -tb ex-<version>.tar.bz2

Note that the RPM spec installs the binary in /usr/5bin by default to
avoid conflicts with vendor files in /usr/bin. The default locations
match those of the Heirloom Toolchest <http://heirloom.sourceforge.net>.

The following systems have been reported to compile this code:

Linux		Kernel 2.0 and above; libc4, libc5, glibc 2.2 and above,
		diet libc, uClibc; gcc, Intel C
Sun Solaris	2.5.1 and above
Open UNIX	8.0.0
UnixWare	7.1.1, 7.0.1, 2.1.2
HP HP-UX	B.11.23, B.11.11, B.11.00, B.10.20
HP Tru64 UNIX	4.0G, 5.1B
IBM AIX		5.1, 4.3
NEC SUPER-UX	10.2
NEC UX/4800	Release11.5 Rev.A
FreeBSD		3.1, 4.5, 5.x
NetBSD		1.6, 2.0

Reports about other Unix systems are welcome, whether successful or not
(in the latter case add a detailed description). This port of vi is only
aimed at Unix, though, so I am not interested about results from running
this software on Windows etc.

Prerequisites for ports to other systems are:

- The system must provide an ANSI C-89 compiler and POSIX.1-1990 functions.

- The system must provide an sbrk() call to increase the memory heap size.
  If only a fake sbrk() call is provided that works by pre-allocating
  several MB, vi will probably work too.

- The system library must allow replacement of malloc() and printf() by the
  versions provided by vi. For malloc(), it also must make its own internal
  memory requests using the vi malloc(). Otherwise, vi will likely die with
  a segmentation fault because the storage allocated by sbrk() interferes
  with usual Unix library implementations of malloc().

The last two requirements could probably be eliminated with some effort, but
it would not result in any real improvements for usual the Unix platforms vi
is targeted at, so it has not be done yet.


Multibyte locale support
========================

Support for multibyte locales has been added to vi. It requires a number of
functions that, while specified in XPG6, are not present on all systems that
provide basic multibyte support. In particular, vi needs wcwidth() to
determine the visual width of a character, and mbrtowc() to detect when a
byte sequence that is entered at the terminal has been completed.

The multibyte code is known to work on the following systems:

Linux		glibc 2.2.2 and later
Sun Solaris	9 and later
HP HP-UX	B.11.11 and later
FreeBSD		5.3
NetBSD		2.0

It has been tested on xterm patch #192, rxvt-unicode 4.2, mlterm 2.9.1, and
xiterm 0.5.

Successful operation is known for the following encodings: UTF-8, EUC-JP,
EUC-KR, Big5, Big5-HKSCS, GB 2312, GBK. vi does not support locking-shift
encodings like those that use ISO 2022 escape sequences. It also requires
that the first byte of any multibyte character has the highest bit set.
This excludes 7-bit encodings like UTF-7, and encodings whose sequences
start with ASCII characters like TCVN 5712.

To use UTF-8 locales in ex mode, the terminal should be put in 'stty iutf8'
mode on Linux if it does not perform this automatically. Otherwise, typing
the erase key once after entering a multibyte character will result in an
incomplete byte sequence.


Gunnar Ritter						2/15/05
Freiburg i. Br.
Germany
<Gunnar.Ritter@pluto.uni-freiburg.de>