xref: /freebsd/bin/ed/README (revision 05248206f720394d95c2a7475429311df670a2e9)
189730b29SDavid Greenman
230154ac8SAndrew Mooreed is an 8-bit-clean, POSIX-compliant line editor.  It should work with
330154ac8SAndrew Mooreany regular expression package that conforms to the POSIX interface
430154ac8SAndrew Moorestandard, such as GNU regex(3).
530154ac8SAndrew Moore
630154ac8SAndrew MooreIf reliable signals are supported (e.g., POSIX sigaction(2)), it should
795e6217eSAndrew Moorecompile with little trouble.  Otherwise, the macros SPL1() and SPL0()
830154ac8SAndrew Mooreshould be redefined to disable interrupts.
930154ac8SAndrew Moore
1030154ac8SAndrew MooreThe following compiler directives are recognized:
1195e6217eSAndrew MooreNO_REALLOC_NULL	- if realloc(3) does not accept a NULL pointer
1295e6217eSAndrew MooreBACKWARDS	- for backwards compatibility
1395e6217eSAndrew MooreNEED_INSQUE	- if insque(3) is missing
1430154ac8SAndrew Moore
1530154ac8SAndrew MooreThe file `POSIX' describes extensions to and deviations from the POSIX
1630154ac8SAndrew Moorestandard.
1730154ac8SAndrew Moore
1830154ac8SAndrew MooreThe ./test directory contains regression tests for ed. The README
1930154ac8SAndrew Moorefile in that directory explains how to run these.
2030154ac8SAndrew Moore
2130154ac8SAndrew MooreFor a description of the ed algorithm, see Kernighan and Plauger's book
2230154ac8SAndrew Moore"Software Tools in Pascal," Addison-Wesley, 1981.
23