summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/plain/pdcmac/install.txt
blob: 51455322ef08206598e4279a17e06569e63622fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
install.txt -*-text-*- Time-stamp: <pdc 1995-02-23>

			   INSTALLING PDCMAC

1. GNERIC INSTALLATION

	The file "contents.txt" gives a list of all the files (except
	itself) with their sizes in bytes.

	The macro files are packaged with their documentation in "dtx"
	files (the LaTeX 2e distribution uses files with the same suffix
	for a similar purpose).  

	You do not need Docstrip or LaTeX to unpack these files; all you
	need is a copy of "pdccode.tex".  Just run plain TeX on the
	"dtx" files to generate the macro files and the printed
	documentation all at the same time.  

	Then put the macro files somewhere where TeX can find them.  For
	systems with the new TeX Directory Structure this directory
	might be "$texmf/tex/plain/pdcmac/"; for UNIXTeX 6.1 it might be
	"$texmf/tex/plain/"; for older TeX it might be "$tex/inputs" or
	"$tex/macros".

	You may want to put the DVI files and the DTX files together in
	a documentation directory if you have one.  On TDS systems this
	might be "$texmf/doc/pdcmac/".


2. UNIX SYSTEMS

	For the benefit of people on UNIX systems I can supply a
	Makefile template and a configuration script.  The conventions
	for the config scriopt are based on the GNU Coding Standards.

(1) Configuration.  Run the command "./configure" (you may need to say
	"sh configure"); this is a shell script that attempts to guess
	sensible values for things like "texdir" (the directory to put
	TeX macro files).  It generates a shellscript "config.status"
	which records the current configuration; running it recreates
	the "Makefile".

	The "configure" script understands the following options.
	*You should not need to specify any of these.*

    -n, -nocreate, --nocreate
	Make  "config.status" but don't run it to generate "Makefile".

    -h, -help, --help
	Print a summary of options.

    -pDIR, -prefix DIR, --prefix=DIR 
	Set the "prefix" for directory names.  FOr example, "-p/usr"
	indcates that TeX files are under "/usr/texmf" or "/usr/tex" or
	somesuch.
	
    -sDIR, -srcdir DIR, --srcdir=DIR
	Tell "configure" where the source files are.  This is used when
	building the package in a different directory.   Normally even
	in this case "configure" can guess the cirrect dierctory by
	examining $0.

    -tDIR, -texdir DIR, --texdir=DIR
	Tell "configure" where TeX files are (this makes -p redundant).
	For example "-t/usr/texmf".

    -wtds, -with tds, --with-tds
	Tell "configure" you have a new-style TeX Directory Structure.
	Usually "configure" can guess correctly.

	Other options are ignored.

(2) Run "make".  The makefile generated by "configure" is tested with
	GNU "make".  The makefile understands the following conventional
	targets: 

    "make" 
	Generates all the "tex" macro files, and runs TeX on the other 
	documentation files. 

    "make install"
	Copies the macro files into TeX's macros directory, and the DVI
	files into the $docdir.

    "make uninstall"
	Deletes the files that would be created by "make install".

    "make mostlyclean|clean|distclean|realclean" 
	Delete files made from source files.  "mostlyclean" removes the
	ones that are generated most often; "realclean" removes even
	those that are rarely deleted.