Rombobjörn

summaryrefslogtreecommitdiff
path: root/INSTALL
blob: 850a2e5653c4628910f4a67dd375e48420ebc2e0 (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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
Building and Installing the Ada Milter API
==========================================

Requirements
------------

These instructions assume a Unix-like system with the GNAT tools and GNU Make.
The makefiles may not work with other clones and forks of Make. Use GNU Make if
possible; it is sometimes available as "gmake" on non-GNU systems. If you can't
use Make you will need to manually preprocess some GNAT project files with
Gnatprep. If you have another Ada compiler than GNAT, then the included build
system will probably not work and you should do whatever that compiler requires
you to do to compile the code.

The project files require GPRbuild. Gnatmake won't do because this is a mixed-
language library.


Basic Installation
------------------

The simplest way to build and install the Ada Milter API is:

 1: Go to the directory that contains this file and the makefiles, and run
    "make" to build the library.

 2: Run "make install" to copy the files to the default locations. You will
    probably need root privileges if you install to the default locations.


Testing
-------

"make test_milter" will build a test milter that can be used to check that the
library works. The testing is not automated. A Mail Transfer Agent will need to
be configured to use the test milter, and some email messages will need to be
sent through that MTA.


Installation Directories
------------------------

By default the files are installed in directories under /usr/local. You can
specify other locations by setting variables on the Make command line, or on
the Gnatprep command line if you can't use Make. The following Make variables
are relevant during the build:

 dirgpr
    The filename of the directories project, if your system has one and you
    want to install to the directories it specifies. A directories project is a
    GNAT project file that defines directory variables for use by other project
    files. Multiarch support requires a directories project that can refer to
    different directories depending on the target architecture. A directories
    project overrides some but not all of the directory variables listed below.

 relocatable_package
    If relocatable_package is true and no directories project is provided, then
    the project file that will be installed with the library will be configured
    with relative pathnames so that the installed directory tree as a whole can
    be moved to another location in the filesystem without breaking the project
    file. Default: false

 prefix
    A prefix used in the default values of the directory variables listed
    below. Default: /usr/local

 exec_prefix
    A prefix used in the default locations for programs, binary libraries and
    other architecture-specific files. Default: <prefix>

 bindir
    The directory for programs that can be run from a command prompt, used only
    if no directories project is provided. Default: <exec_prefix>/bin

 datarootdir
    The root of the directory tree for read-only architecture-independent data
    files. Default: <prefix>/share

 includedir
    The top-level directory for source files to be used in the compilation of
    software using libraries, used only if no directories project is provided.
    Default: <prefix>/include

 libdir
    The directory for binary libraries to be used by other software, and the
    top-level directory for other architecture-specific files, used only if no
    directories project is provided. Default: <exec_prefix>/lib

 gprdir
    The directory for GNAT project files to be used in the building of software
    using libraries. If you set this to a directory that GPRbuild and Gnatmake
    don't search by default, then you will need to add it to the project search
    path when using this library, for example through the environment variable
    GPR_PROJECT_PATH. Default: <datarootdir>/gpr

If you want to install to a staging directory from which the files will later
be copied to their final locations, then set DESTDIR to the staging directory.
All the other directory variables shall be the final locations. Unlike the
variables listed above, DESTDIR is effective in the installation step.

The following preprocessor symbols are used when the project files are
preprocessed. They are derived from the Make variables above when the makefiles
invoke Gnatprep. You may need to define them if you run Gnatprep manually.

 Directories_GPR
    The filename of the directories project, if any; corresponding to dirgpr.

 Directories_Project
    The name of the directories project, if any. This is supposed to be the
    filename without a path or a suffix.

 Prefix
 Exec_Prefix
 Bindir
 Includedir
 Libdir
    These correspond to the like-named Make variables. The same defaults as
    above will be used if the symbols are undefined.


Optional Thread Wrapper
-----------------------

The Ada Milter API contains a thread wrapper. It wraps threads that Libmilter
starts, and registers and unregisters them in the Ada run-time system. This may
be necessary on some platforms and works around a memory leak in some versions
of Libgnat, but can also trigger bugs in some older versions of Libgnat. The
thread wrapper is disabled by default. To enable it, set the variable
wrap_threads to "true" on the Make or Gnatprep command line.


Build Tools and Options
-----------------------

The following variables, which may be set in the environment or on the Make
command line, control which programs are invoked to do the build and which
options are passed to them:

 GNATPREP
    The command for invoking Gnatprep, in case you want to use a nondefault
    version of Gnatprep or a wrapper for example. Default: gnatprep

 GNAT_BUILDER
    The command for invoking the builder, that is GPRbuild. Default: gprbuild

 GNATFLAGS
    A space-separated list with all of the optional parameters to be passed to
    the builder, including any options to be forwarded to the compiler, binder
    and linker. If GNATFLAGS is defined it overrides the options variables
    listed below.

 GNAT_BUILDER_FLAGS
    A space-separated list of options for the builder, used only if GNATFLAGS
    is undefined. This may include not only options for the builder itself but
    also command line separators (also called mode switches) followed by
    options to be forwarded to the compiler, binder or linker.

 ADAFLAGS
    A space-separated list of options to be passed to the compiler when
    compiling Ada code, used only if GNATFLAGS is undefined.

 CPPFLAGS
    A space-separated list of options to be passed to the C preprocessor when
    compiling C or C++ code, used only if GNATFLAGS is undefined.

 CFLAGS
    A space-separated list of options to be passed to the compiler when
    compiling C code, used only if GNATFLAGS is undefined.

 GNATBINDFLAGS
    A space-separated list of options to be passed to Gnatbind, used only if
    GNATFLAGS is undefined and only when binding the test milter.

 LDFLAGS
    A space-separated list of options to be passed to the linker, used only if
    GNATFLAGS is undefined and only when linking the test milter.


Copyright of This File
----------------------

Copyright 2013 B. Persson, Bjorn@Rombobeorn.se

This material is provided as is, with absolutely no warranty expressed
or implied. Any use is at your own risk.

Permission is hereby granted to use or copy this documentation file
for any purpose, provided the above notices are retained on all copies.
Permission to modify the text and to distribute modified text is granted,
provided the above notices are retained, and a notice that the text was
modified is included with the above copyright notice.