annotate lisp/pcl-cvs/INSTALL @ 0:376386a54a3c r19-14

Import from CVS: tag r19-14
author cvs
date Mon, 13 Aug 2007 08:45:50 +0200
parents
children 131b0175ea99
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 This text is copied from the TeXinfo manual for pcl-cvs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 Installation of the pcl-cvs program
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 ===================================
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 1. Possibly edit the file `Makefile' to reflect the situation at your
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 site. We say "possibly" because the version of pcl-cvs included
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 with CVS uses a configuration mechanism integrated with the overall
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 mechanisms used by the CVS build and install procedures. Thus the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 file `Makefile' will be generated automatically from the file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 `Makefile.in', and it should not be necessary to edit it further.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 If you do have to edit the `Makefile', the only things you have to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 change is the definition of `lispdir' and `infodir'. The elisp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 files will be copied to `lispdir', and the info file(s) to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 `infodir'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 2. Configure pcl-cvs.el
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 There are a couple of pathnames that you have to check to make
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 sure that they match your system. They appear early in the file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 `pcl-cvs.el'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 *NOTE:* If your system is running emacs 18.57 or earlier you MUST
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 uncomment the line that says:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 (setq delete-exited-processes nil)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 Setting `delete-exited-processes' to `nil' works around a bug in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 emacs that causes it to dump core. The bug was fixed in emacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 18.58.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 3. Release 1.05 and later of pcl-cvs requires parts of the Elib
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 library, version 1.0 or later. Elib is available via anonymous
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 ftp from prep.ai.mit.edu in `pub/gnu/elib-1.0.tar.gz', and from a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 lot of other sites that mirror prep. Get Elib, and install it,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 before proceeding.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 *NOTE:* The version of pcl-cvs included with CVS includes a copy
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 of Elib in the sub-directory `elib' under the `contrib/pcl-cvs'
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 directory.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 4. Type `make install' in the source directory. This will
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 byte-compile all `.el' files and copy the `*.elc' files into the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 directory you specified in step 1.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 If you want to install the `*.el' files too, you can type `make
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 install-el' to do so.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 If you only want to create the compiled elisp files, but don't
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 want to install them, you can type `make' without parameters.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 5. Edit the file `default.el' in your emacs lisp directory (usually
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 `/usr/gnu/lib/emacs/site-lisp' or something similar) and enter the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 contents of the file `pcl-cvs-startup.el' into it. It contains a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 couple of `auto-load's that facilitates the use of pcl-cvs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 Installation of the on-line manual.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 ===================================
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 1. Create the info file(s) `pcl-cvs.info*' from `pcl-cvs.texinfo' by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 typing `make info'. If you don't have the program `makeinfo' you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 can get it by anonymous ftp from e.g. `prep.ai.mit.edu' as
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 `pub/gnu/texinfo-3.7.tar.gz' (there might be a newer version there
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 when you read this).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 2. Install the info file(s) `pcl-cvs.info*' into your standard `info'
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 directory. You should be able to do this by typing `make
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 install-info'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 3. Edit the file `dir' in the `info' directory and enter one line to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 contain a pointer to the info file(s) `pcl-cvs.info*'. The line
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 can, for instance, look like this:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 * Pcl-cvs: (pcl-cvs). An Emacs front-end to CVS.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 How to make typeset documentation from pcl-cvs.texinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 ======================================================
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 If you have TeX installed at your site, you can make a typeset manual
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 from `pcl-cvs.texinfo'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83 1. Run TeX by typing ``make pcl-cvs.dvi''. You will not get the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 indices unless you have the `texindex' program.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86 2. Convert the resulting device independent file `pcl-cvs.dvi' to a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 form which your printer can output and print it. If you have a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 postscript printer there is a program, `dvi2ps', which does. There
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 is also a program which comes together with TeX, `dvips', which
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 you can use.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 --
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 #ident "@(#)cvs/contrib/pcl-cvs:$Name: $Id: INSTALL,v 1.1.1.1 1996/12/18 03:32:29 steve Exp $"