Mercurial > hg > xemacs-beta

comparison lisp/viper/README @ 78:c7528f8e288d r20-0b34

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