1 |
Basic Installation |
-*- Text -*- |
2 |
================== |
|
3 |
|
This is the BugCommunicator. Welcome. |
4 |
|
|
5 |
|
This file contains instructions for configuring and installing the |
6 |
|
BugCommunicator (aka bugcomm). |
7 |
|
|
8 |
|
The Requirement |
9 |
|
=============== |
10 |
|
|
11 |
|
BugCommunicator depends on some software packages installed into your |
12 |
|
system. If you don't have any of them, please obtain and install them |
13 |
|
before configuring the BugCommunicator. |
14 |
|
|
15 |
|
All of these are available from the Ruby Application Archive |
16 |
|
<http://www.ruby-lang.org/en/raa.html>. |
17 |
|
|
18 |
|
* Ruby 1.6.7 or later. |
19 |
|
* dRuby 1.3.4 or later. |
20 |
|
* ACL 1.0.1 or later. |
21 |
|
* MySQL/Ruby 2.3.1 or later. |
22 |
|
* ERb 1.4.1 or later. |
23 |
|
* Iconv 0.4.5 or later. |
24 |
|
* RubyMail 0.8 or later. |
25 |
|
|
26 |
These are generic installation instructions. |
If you don't install the server, the first two packages (i.e. Ruby and |
27 |
|
dRuby) are required. |
28 |
|
|
29 |
The `configure' shell script attempts to guess correct values for |
MySQL 3.23.49 or later is also required for the backend of the |
30 |
|
BugCommunicator server, although it may or may not run in the same |
31 |
|
machine. See <http://www.mysql.com/>, for obtaining MySQL. |
32 |
|
|
33 |
|
Configuring the BugCommunicator |
34 |
|
=============================== |
35 |
|
|
36 |
|
The `configure' shell script attempts to guess correct values for |
37 |
various system-dependent variables used during compilation. It uses |
various system-dependent variables used during compilation. It uses |
38 |
those values to create a `Makefile' in each directory of the package. |
those values to create a `Makefile' in each directory of the package. |
39 |
It may also create one or more `.h' files containing system-dependent |
It may also create one or more `.h' files containing system-dependent |
43 |
reconfiguring, and a file `config.log' containing compiler output |
reconfiguring, and a file `config.log' containing compiler output |
44 |
(useful mainly for debugging `configure'). |
(useful mainly for debugging `configure'). |
45 |
|
|
46 |
If you need to do unusual things to compile the package, please try |
If you need to do unusual things to compile the package, please try |
47 |
to figure out how `configure' could check whether to do them, and mail |
to figure out how `configure' could check whether to do them, and mail |
48 |
diffs or instructions to the address given in the `README' so they can |
diffs or instructions to the address given in the `README' so they can |
49 |
be considered for the next release. If at some point `config.cache' |
be considered for the next release. If at some point `config.cache' |
50 |
contains results you don't want to keep, you may remove or edit it. |
contains results you don't want to keep, you may remove or edit it. |
51 |
|
|
52 |
The file `configure.in' is used to create `configure' by a program |
The file `configure.in' is used to create `configure' by a program |
53 |
called `autoconf'. You only need `configure.in' if you want to change |
called `autoconf'. You only need `configure.in' if you want to change |
54 |
it or regenerate `configure' using a newer version of `autoconf'. |
it or regenerate `configure' using a newer version of `autoconf'. |
55 |
|
|
81 |
all sorts of other programs in order to regenerate files that came |
all sorts of other programs in order to regenerate files that came |
82 |
with the distribution. |
with the distribution. |
83 |
|
|
|
Compilers and Options |
|
|
===================== |
|
|
|
|
|
Some systems require unusual options for compilation or linking that |
|
|
the `configure' script does not know about. You can give `configure' |
|
|
initial values for variables by setting them in the environment. Using |
|
|
a Bourne-compatible shell, you can do that on the command line like |
|
|
this: |
|
|
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure |
|
|
|
|
|
Or on systems that have the `env' program, you can do it like this: |
|
|
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure |
|
|
|
|
|
Compiling For Multiple Architectures |
|
|
==================================== |
|
|
|
|
|
You can compile the package for more than one kind of computer at the |
|
|
same time, by placing the object files for each architecture in their |
|
|
own directory. To do this, you must use a version of `make' that |
|
|
supports the `VPATH' variable, such as GNU `make'. `cd' to the |
|
|
directory where you want the object files and executables to go and run |
|
|
the `configure' script. `configure' automatically checks for the |
|
|
source code in the directory that `configure' is in and in `..'. |
|
|
|
|
|
If you have to use a `make' that does not supports the `VPATH' |
|
|
variable, you have to compile the package for one architecture at a time |
|
|
in the source code directory. After you have installed the package for |
|
|
one architecture, use `make distclean' before reconfiguring for another |
|
|
architecture. |
|
|
|
|
84 |
Installation Names |
Installation Names |
85 |
================== |
================== |
86 |
|
|
87 |
By default, `make install' will install the package's files in |
By default, `make install' will install the package's files in |
88 |
`/usr/local/bin', `/usr/local/man', etc. You can specify an |
`/usr/local/bin', `/usr/local/man', etc. You can specify an |
89 |
installation prefix other than `/usr/local' by giving `configure' the |
installation prefix other than `/usr/local' by giving `configure' the |
90 |
option `--prefix=PATH'. |
option `--prefix=PATH'. |
91 |
|
|
92 |
You can specify separate installation prefixes for |
You can specify separate installation prefixes for |
93 |
architecture-specific files and architecture-independent files. If you |
architecture-specific files and architecture-independent files. If you |
94 |
give `configure' the option `--exec-prefix=PATH', the package will use |
give `configure' the option `--exec-prefix=PATH', the package will use |
95 |
PATH as the prefix for installing programs and libraries. |
PATH as the prefix for installing programs and libraries. |
96 |
Documentation and other data files will still use the regular prefix. |
Documentation and other data files will still use the regular prefix. |
97 |
|
|
98 |
In addition, if you use an unusual directory layout you can give |
In addition, if you use an unusual directory layout you can give |
99 |
options like `--bindir=PATH' to specify different values for particular |
options like `--bindir=PATH' to specify different values for particular |
100 |
kinds of files. Run `configure --help' for a list of the directories |
kinds of files. Run `configure --help' for a list of the directories |
101 |
you can set and what kinds of files go in them. |
you can set and what kinds of files go in them. |
102 |
|
|
103 |
If the package supports it, you can cause programs to be installed |
If the package supports it, you can cause programs to be installed |
104 |
with an extra prefix or suffix on their names by giving `configure' the |
with an extra prefix or suffix on their names by giving `configure' the |
105 |
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. |
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. |
106 |
|
|
|
Optional Features |
|
|
================= |
|
|
|
|
|
Some packages pay attention to `--enable-FEATURE' options to |
|
|
`configure', where FEATURE indicates an optional part of the package. |
|
|
They may also pay attention to `--with-PACKAGE' options, where PACKAGE |
|
|
is something like `gnu-as' or `x' (for the X Window System). The |
|
|
`README' should mention any `--enable-' and `--with-' options that the |
|
|
package recognizes. |
|
|
|
|
|
For packages that use the X Window System, `configure' can usually |
|
|
find the X include and library files automatically, but if it doesn't, |
|
|
you can use the `configure' options `--x-includes=DIR' and |
|
|
`--x-libraries=DIR' to specify their locations. |
|
|
|
|
|
Specifying the System Type |
|
|
========================== |
|
|
|
|
|
There may be some features `configure' can not figure out |
|
|
automatically, but needs to determine by the type of host the package |
|
|
will run on. Usually `configure' can figure that out, but if it prints |
|
|
a message saying it can not guess the host type, give it the |
|
|
`--host=TYPE' option. TYPE can either be a short name for the system |
|
|
type, such as `sun4', or a canonical name with three fields: |
|
|
CPU-COMPANY-SYSTEM |
|
|
|
|
|
See the file `config.sub' for the possible values of each field. If |
|
|
`config.sub' isn't included in this package, then this package doesn't |
|
|
need to know the host type. |
|
|
|
|
|
If you are building compiler tools for cross-compiling, you can also |
|
|
use the `--target=TYPE' option to select the type of system they will |
|
|
produce code for and the `--build=TYPE' option to select the type of |
|
|
system on which you are compiling the package. |
|
|
|
|
|
Sharing Defaults |
|
|
================ |
|
|
|
|
|
If you want to set default values for `configure' scripts to share, |
|
|
you can create a site shell script called `config.site' that gives |
|
|
default values for variables like `CC', `cache_file', and `prefix'. |
|
|
`configure' looks for `PREFIX/share/config.site' if it exists, then |
|
|
`PREFIX/etc/config.site' if it exists. Or, you can set the |
|
|
`CONFIG_SITE' environment variable to the location of the site script. |
|
|
A warning: not all `configure' scripts look for a site script. |
|
|
|
|
107 |
Operation Controls |
Operation Controls |
108 |
================== |
================== |
109 |
|
|
110 |
`configure' recognizes the following options to control how it |
`configure' recognizes the following options to control how it |
111 |
operates. |
operates. |
112 |
|
|
113 |
`--cache-file=FILE' |
`--cache-file=FILE' |
133 |
Print the version of Autoconf used to generate the `configure' |
Print the version of Autoconf used to generate the `configure' |
134 |
script, and exit. |
script, and exit. |
135 |
|
|
136 |
`configure' also accepts some other, not widely useful, options. |
`--enable-maintainer-mode' |
137 |
|
Enable make rules and dependencies not useful (and sometimes |
138 |
|
confusing) to the casual installer. If you are a BugCommunicator |
139 |
|
developer, it is a good idea to specify this option. |
140 |
|
|
141 |
|
`--disable-server' |
142 |
|
Do not install the BugCommunicator server. This option is useful, |
143 |
|
if you intend to run the clients in another machine. |
144 |
|
|
145 |
|
`--disable-mail-client' |
146 |
|
Do not install the BugCommunicator mail client. |
147 |
|
|
148 |
|
`--disable-cgi-client' |
149 |
|
Do not install the BugCommunicator CGI client. |
150 |
|
|
151 |
|
`--with-cgidir=DIR' |
152 |
|
Install the CGI client into directory DIR. |
153 |
|
|
154 |
|
`--with-bugcomm-conf=FILE' |
155 |
|
Use FILE as the configuration file for the BugCommunicator |
156 |
|
clients. |
157 |
|
|
158 |
|
`--with-bugcommd-conf=FILE' |
159 |
|
Use FILE as the configuration file for the BugCommunicator |
160 |
|
server. |