annotate lisp/viper/README @ 14:9ee227acff29 r19-15b90

Import from CVS: tag r19-15b90
author cvs
date Mon, 13 Aug 2007 08:48:42 +0200
parents bcdc7deadc19
children 0293115a14e9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
1 **** Viper requires Emacs 19.23 or later.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
2
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
3 This directory:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
4
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
5 README -- This file
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
6 Makefile -- Automated installation file
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
7
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
8 viper.el -- Viper Emacs Lisp code
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
9 viper-macs.el -- Viper Emacs Lisp code
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
10 viper-ex.el -- Viper Emacs Lisp code
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
11 viper-util.el -- Viper Emacs Lisp code
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
12 viper-mous.el -- Viper Emacs Lisp code
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
13 viper-keym.el -- Viper Emacs Lisp code
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
14
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
15 viper.texi -- Manual in Texinfo format, main part
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
16 viper-cmd.texi -- Command reference part of the manual
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
17
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
18 viperCard.tex -- Reference card in TeX format
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
19
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
20 viper, viper-? -- The Info files
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
21
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
22 viper.dvi -- Dvi version of the Viper manual
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
23 viperCard.dvi -- Dvi version of the quick reference card
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
24
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
25 To install Viper, do:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
26
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
27 uncompress viper.tar.Z
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
28 tar xf viper.tar
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
29
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
30
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
31 Then do the following:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
32
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
33 1. To compile Lisp:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
34
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
35 make elc
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
36
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
37 Since the DVI and Info files are bundled with the distribution, this is
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
38 the only make command you need.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
39
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
40 2. To recompile the DVI files (if you have to), type:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
41
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
42 make dvi
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
43
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
44 3. To re-make the info files (if needed), type:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
45
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
46 make info
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
47
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
48 4. To redo everything:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
49
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
50 make all
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
51
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
52 "make all" is useful if you made your own changes to the *.texi or
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
53 *.el files. This way, this single command will recompile exactly what's
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
54 needed.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
55
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
56 5. You can also run
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
57
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
58 make install
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
59
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
60 to do what "make all" does plus to copy viper*.elc into
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
61 a suitable Lisp directory and Viper Info files into the Info
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
62 directory; DVI files containing printable version of Viper
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
63 Manual and Reference Card will be copied into the 'etc' directory.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
64
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
65 You will still have to edit the 'dir' file manually (see below), if
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
66 you haven't done so during a previous installation.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
67
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
68 To make all this happen, you will most likely have to change the PREFIX
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
69 variable in Makefile and, possibly, one or more of these variables:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
70
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
71 DATADIR, LISPDIR, INFODIR, ETCDIR, and VERSION
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
72
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
73 if they don't point to the right directories in your installation.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
74 You also need to have a write permission for all directories
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
75 mentioned in LISPDIR, INFODIR, and ETCDIR.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
76
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
77 6. XEmacs users must invoke make with the parameter EMACS=xemacs
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
78 or whatever name is used to invoke XEmacs (some sites still use xemacs
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
79 for Emacs 18). An even better thing would be to edit Makefile directly
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
80 as indicated in the comments there.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
81
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
82 For manual installation, copy viper.elc into a directory on your load-path.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
83
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
84 To install on-line documentation, you need to install the Info files
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
85 by copying the files
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
86
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
87 viper.info*
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
88
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
89 into your Info directory (which is emacs-root-dir/info,
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
90 if emacs-root-dir is the root directory of the installation).
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
91
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
92 Then edit the file
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
93
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
94 emacs-root-dir/info/dir
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
95
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
96 to include the root menu item for Viper (check how other menu
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
97 items look like in this file).
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
98
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
99 In Emacs, this item should look like this:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
100
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
101 * Viper: (viper.info). A VI Plan to Rescue Emacs and a venomous VI PERil
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
102
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
103 In XEmacs, it should look like:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
104
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
105 * Viper:: A VI Plan to Rescue Emacs and a venomous VI PERil
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
106
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
107
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
108 If you need a hard copy of the documentation, the files
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
109
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
110 viper.dvi
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
111 viperCard.dvi
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
112
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
113 contain the Viper manual and the quick reference card, respectively.
14
9ee227acff29 Import from CVS: tag r19-15b90
cvs
parents: 12
diff changeset
114
9ee227acff29 Import from CVS: tag r19-15b90
cvs
parents: 12
diff changeset
115