xref: /illumos-gate/usr/src/cmd/vi/README (revision 7c478bd95313f5f23a4c958a745db2134aa03244)
1*7c478bd9Sstevel@tonic-gate#
2*7c478bd9Sstevel@tonic-gate# CDDL HEADER START
3*7c478bd9Sstevel@tonic-gate#
4*7c478bd9Sstevel@tonic-gate# The contents of this file are subject to the terms of the
5*7c478bd9Sstevel@tonic-gate# Common Development and Distribution License, Version 1.0 only
6*7c478bd9Sstevel@tonic-gate# (the "License").  You may not use this file except in compliance
7*7c478bd9Sstevel@tonic-gate# with the License.
8*7c478bd9Sstevel@tonic-gate#
9*7c478bd9Sstevel@tonic-gate# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*7c478bd9Sstevel@tonic-gate# or http://www.opensolaris.org/os/licensing.
11*7c478bd9Sstevel@tonic-gate# See the License for the specific language governing permissions
12*7c478bd9Sstevel@tonic-gate# and limitations under the License.
13*7c478bd9Sstevel@tonic-gate#
14*7c478bd9Sstevel@tonic-gate# When distributing Covered Code, include this CDDL HEADER in each
15*7c478bd9Sstevel@tonic-gate# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*7c478bd9Sstevel@tonic-gate# If applicable, add the following below this CDDL HEADER, with the
17*7c478bd9Sstevel@tonic-gate# fields enclosed by brackets "[]" replaced with your own identifying
18*7c478bd9Sstevel@tonic-gate# information: Portions Copyright [yyyy] [name of copyright owner]
19*7c478bd9Sstevel@tonic-gate#
20*7c478bd9Sstevel@tonic-gate# CDDL HEADER END
21*7c478bd9Sstevel@tonic-gate#
22*7c478bd9Sstevel@tonic-gate#ident	"%Z%%M%	%I%	%E% SMI"	/* SVr4.0 1.7	*/
23*7c478bd9Sstevel@tonic-gate  This directory and its subdirectories contain the files necessary
24*7c478bd9Sstevel@tonic-gatefor making ex/vi in the AT&T UNIX environment:
25*7c478bd9Sstevel@tonic-gate
26*7c478bd9Sstevel@tonic-gate	This is a list of all the important directories and what's
27*7c478bd9Sstevel@tonic-gate	hidden under each.
28*7c478bd9Sstevel@tonic-gate
29*7c478bd9Sstevel@tonic-gate	misc - contains files used in the "make" of ex/vi
30*7c478bd9Sstevel@tonic-gate	      { mkstr.c, xstr.c ...}
31*7c478bd9Sstevel@tonic-gate
32*7c478bd9Sstevel@tonic-gate	port - ex/vi source directory.
33*7c478bd9Sstevel@tonic-gate
34*7c478bd9Sstevel@tonic-gate	local - contains "uparm.h" which must be edited to
35*7c478bd9Sstevel@tonic-gate		reflect your system setup!
36*7c478bd9Sstevel@tonic-gate		EXAMPLE:
37*7c478bd9Sstevel@tonic-gate		--------
38*7c478bd9Sstevel@tonic-gate		#define libpath(file) "/usr/lib/file"
39*7c478bd9Sstevel@tonic-gate		#define loclibpath(file) "/usr/lib/file"
40*7c478bd9Sstevel@tonic-gate		#define binpath(file) "/usr/lbin/file"
41*7c478bd9Sstevel@tonic-gate		#define usrpath(file) "/usr/file"
42*7c478bd9Sstevel@tonic-gate		** libpath is where ex/vi expects the strings file
43*7c478bd9Sstevel@tonic-gate		(exstrings...this file is made as the ex/vi source
44*7c478bd9Sstevel@tonic-gate		is compiled), and ex/vi 's recover & preserve commands
45*7c478bd9Sstevel@tonic-gate		(exrecover and expreserve).
46*7c478bd9Sstevel@tonic-gate		** usrpath is where the preserved files are held after
47*7c478bd9Sstevel@tonic-gate		a hangup or fail..."preserve" is tacked onto
48*7c478bd9Sstevel@tonic-gate		the end of the usrpath string .
49*7c478bd9Sstevel@tonic-gate
50*7c478bd9Sstevel@tonic-gate	PATHs to look at (and possibly change) include:
51*7c478bd9Sstevel@tonic-gate
52*7c478bd9Sstevel@tonic-gate	  port/makefile.usg   ---|
53*7c478bd9Sstevel@tonic-gate	  preserve and recover commands all are installed in
54*7c478bd9Sstevel@tonic-gate	  ${LIBDIR}....make sure this is where you
55*7c478bd9Sstevel@tonic-gate	  want them to go.  This path must be the same as
56*7c478bd9Sstevel@tonic-gate	  the path defined in local/uparm.h ...c variable
57*7c478bd9Sstevel@tonic-gate	  name is usrpath.
58*7c478bd9Sstevel@tonic-gate
59*7c478bd9Sstevel@tonic-gate	     In the event of a hangup, the editor will place a
60*7c478bd9Sstevel@tonic-gate	  copy of the temporary file in /usr/preserve.
61