aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
blob: f9a21b27553fb1441b83ffd769c715d41326e3f7 (plain) (blame)
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
Type './configure --help' for configuration options. The normal settings for a
GNU package should work. If not, please make a bug report.

	On a common GNU/Linux distribution the following should
	be sufficient for most users:

		./configure --prefix=/usr
		make
		make install DESTDIR="somewhere you want the files for now"
		# Now let the package manager put the files in place...

	Or for an unstaged install:

		./configure --prefix=/usr
		make
		sudo make install

By default any applicable pre-install, post-install, pre-uninstall, and
post-install commands is run. This suppress these, run 'make' with 'N=true'
or 'N=:'. IF you want to know which these commands are, you can use the
methods specificed in the GNU Coding Standards. Another method is found in
mk/README. However, for this packages, these will be:

	infodir="usr/local/share/info" ## Assuming default prefix.
	
	post_install () {
	  install-info -- "${infodir}/vtchs.info" "${infodir}/dir"
	}
	
	pre_uninstall () {
	  install-info --delete -- "${infodir}/vtchs.info" "${infodir}/dir"
	}


────────────────────────────────────────────────────────────────────────────────
CUSTOMISED COMPILATION
────────────────────────────────────────────────────────────────────────────────

The makefile is configured to compile the C code with -O2 -g, you can
change this by setting OPTIMISE, or with CFLAGS and LDFLAGS if you want
to change all optional flags compiling and linking flags:

	./configure OPTIMISE="-Og -g"


────────────────────────────────────────────────────────────────────────────────
CUSTOMISED INSTALLATION
────────────────────────────────────────────────────────────────────────────────

If you want to install absolutely everything, you can
instead use the commands below:

	make everything
	make install-everything DESTDIR="pkg"

Or if you only want to absolute basics:

	make base
	make install-base DESTDIR="pkg"

You can select freely what parts of the package to install and not
to install. This rules are available:

┌─────────────┬─────────────────────┬────────────────────────────────────────────┐
│ COMPILATION │ INSTALLATION        │ DESCRIPTION                                │
├─────────────┼─────────────────────┼────────────────────────────────────────────┤
│ base        │ install-base        │ Install be basics:                         │
│   cmd       │   install-cmd       │   Install the vtchs command.               │
│             │   install-copyright │   Install license file.                    │
│ doc         │ install-doc         │ Include all manuals:                       │
│   info      │   install-info      │   Include info manual. (Texinfo)           │
│   dvi       │   install-dvi       │   Include DVI manual. (Texinfo)            │
│   pdf       │   install-pdf       │   Include PDF manual. (Texinfo)            │
│   ps        │   install-ps        │   Include PostScript manual. (Texinfo)     │
│   html      │   install-html      │   Include multifile HTML manual. (Texinfo) │
│             │   install-man       │   Include man pages.                       │
└─────────────┴─────────────────────┴────────────────────────────────────────────┘

install, install-everything, install-base, and install-cmd, have alternatives
that installs a stripped binary: install-strip, install-everything-strip,
install-base-strip, and install-cmd-strip, respectively.