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