annotate lisp/viper/README @ 58:8b0bdfdf0cf0 r19-16-pre4

Import from CVS: tag r19-16-pre4
author cvs
date Mon, 13 Aug 2007 08:58:37 +0200
parents 0293115a14e9
children 0132846995bd
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
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents: 14
diff changeset
11 viper-init.el -- Viper Emacs Lisp code
12
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
12 viper-util.el -- Viper Emacs Lisp code
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
13 viper-mous.el -- Viper Emacs Lisp code
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
14 viper-keym.el -- Viper Emacs Lisp code
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
15
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
16 viper.texi -- Manual in Texinfo format, main part
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
17 viper-cmd.texi -- Command reference part of the manual
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
18
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
19 viperCard.tex -- Reference card in TeX format
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
20
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
21 viper, viper-? -- The Info files
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
22
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
23 viper.dvi -- Dvi version of the Viper manual
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
24 viperCard.dvi -- Dvi version of the quick reference card
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
25
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
26 To install Viper, do:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
27
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
28 uncompress viper.tar.Z
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
29 tar xf viper.tar
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
30
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
31
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
32 Then do the following:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
33
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
34 1. To compile Lisp:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
35
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
36 make elc
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
37
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
38 Since the DVI and Info files are bundled with the distribution, this is
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
39 the only make command you need.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
40
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
41 2. To recompile the DVI files (if you have to), type:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
42
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
43 make dvi
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
44
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
45 3. To re-make the info files (if needed), type:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
46
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
47 make info
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
48
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
49 4. To redo everything:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
50
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
51 make all
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
52
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
53 "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
54 *.el files. This way, this single command will recompile exactly what's
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
55 needed.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
56
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
57 5. You can also run
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
58
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
59 make install
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
60
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
61 to do what "make all" does plus to copy viper*.elc into
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
62 a suitable Lisp directory and Viper Info files into the Info
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
63 directory; DVI files containing printable version of Viper
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
64 Manual and Reference Card will be copied into the 'etc' directory.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
65
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
66 You will still have to edit the 'dir' file manually (see below), if
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
67 you haven't done so during a previous installation.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
68
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
69 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
70 variable in Makefile and, possibly, one or more of these variables:
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
71
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
72 DATADIR, LISPDIR, INFODIR, ETCDIR, and VERSION
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
73
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
74 if they don't point to the right directories in your installation.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
75 You also need to have a write permission for all directories
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
76 mentioned in LISPDIR, INFODIR, and ETCDIR.
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
77
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
78 6. XEmacs users must invoke make with the parameter EMACS=xemacs
16
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents: 14
diff changeset
79 or whatever name is used to invoke XEmacs (some backward sites
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents: 14
diff changeset
80 still use xemacs for Emacs 18). An even better thing would be to
0293115a14e9 Import from CVS: tag r19-15b91
cvs
parents: 14
diff changeset
81 edit Makefile directly as indicated in the comments there.
12
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents:
diff changeset
82