.\"edit a file
.TH ed 3 "5 Sep 1994" MudOS "LPC Library Functions"

.SH NAME
ed() - edit a file

.SH SYNOPSIS
.nf
void ed( string file, string exit_fn, int restricted );
void ed( string file, string write_fn, string exit_fn, int restricted );

.SH DESCRIPTION
This is a funny function. It will start a local editor on an optional
file.  This editor is almost UNIX ed compatible.  When in the editor
type 'h' for help.

The <write_fn> function allows the mudlib to handle file locks and
administrative logging of files modified.
When the editor writes to a file, the driver will callback the <write_fn>
function twice.  The first time, the function is called before the
write takes place -- <flag> will be 0.  If the function returns TRUE,
the write will continue,
otherwise it will abort.  The second time, the function is called
after the write has completed -- <flag> will be non-zero.
This callback function should have the form:
.IP
int write_fn(string fname, int flag)
.PP
When the editor is exited, the driver will callback the <exit_fn>
function.  This function allows the mudlib to clean up.  This 
callback function has the form:
.IP
void exit_fn()
.PP
The optional <restricted> flag limits the editor's
capabilities, such as inserting a file, and saving using an alternate
file name.

.SH SEE ALSO
regexp(3), valid_read(4), valid_write(4), get_save_file_name(4)