aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
blob: 6a7c3191c4105cd40f1b15a1f1478a940fa7bcbb (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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
For most users the following should be sufficient:

	make
	make install DESTDIR="pkg"  # install to ./pkg temporarily instead
	                            # of to /, installed files can then be
	                            # moved by root.

Note however, `make install` will not run `install-info'
to add the info manual to `info '(dir)'`. Distributors
should postinstall and preuninstall commands:

	infodir="usr/share/info"
	
	post_install() {
	  install-info -- "${infodir}/scrotty.info" "${infodir}/dir"
	}
	
	post_upgrade() {
	  post_install "$1"
	}
	
	pre_uninstall() {
	  install-info --delete -- "${infodir}/scrotty.info" "${infodir}/dir"
	}

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"


────────────────────────────────────────────────────────────────────────────────
INTERNATIONALISATION
────────────────────────────────────────────────────────────────────────────────

If you want to do not want internationalisation build and install
with WITHOUT_GETTEXT=1. For example:

	make base WITHOUT_GETTEXT=1
	make install-base WITHOUT_GETTEXT=1 DESTDIR="pkg"

You can also chose to restrict the locales to install:

	make all LOCALES=sv
	make install LOCALES=sv DESTDIR="pkg"

You can select which translations of the man page you want to
install too:

	make install MAN_LOCALES=sv DESTDIR="pkg"


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

If you do not have GCC, you may want to set WARN to an empty string:

	make WARN=

The makefile is configured to compile the C code with -O2, you can
change this by setting OPTIMISE:

	make OPTIMISE="-Og -g"

If you want to build the package with another prefix the /usr, set
PREFIX:

	make PREFIX=/usr/local

See the beginning of the Makefile for further file system hierarchy
customisations. These changes, including PREFIX, should be used both
when compiling and installing.


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

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 scrotty command.             │
│             │   install-copyright │   Install legal documents:                 │
│             │     install-copying │     Install copyright notice.              │
│             │     install-license │     Install the GNU GPL version 3.         │
│ 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.                       │
│ locale      │ install-locale      │ Include locales.                           │
└─────────────┴─────────────────────┴────────────────────────────────────────────┘

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.

The untranslated man page is installed via the rule install-man-untranslated.
Additional translations are installed via the rule install-man-locale, which
installes the locales listed in MAN_LOCALES.