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 192 193 194 195
|
.TH IMBOOT 1
.\"
.SH NAME
imboot \- bootstrap a
.I Makefile
from an
.I Imakefile
.\"
.SH SYNOPSIS
.B imboot
[
.B \-c
.I name
] [
.B \-C
.I name
] [
.BI \-D define
] [
.BI \-I dir
] [
.B \-d
] [
.B \-u
] [
.I topdir
[
.I curdir
] ]
.\"
.SH DESCRIPTION
.I imboot
is a general-purpose
.I imake
bootstrapper for
generating a
.I Makefile
from an
.IR Imakefile .
By default,
.I imboot
looks for configuration files in a private project-specific
directory (i.e., located within the current project's source tree).
The
.I \-c
(or
.IR \-C )
option may be given to tell
.I imboot
to
use a set of publicly installed configuration files
instead of (or in addition to) any files in the project's private
directory.
.PP
The private configuration file directory, if used, is taken to be
.I config
or
.I config/cf
at the top of the project source tree.
.I config
is the usual location, but by looking in
.I config/cf
as well,
.I imboot
works within the X11R6 source tree.
The public configuration file directory will be one of those located
under
.IR CONFIGROOTDIR .
The name of the directory is specified by the
.I \-c
and
.I \-C
options.
.PP
The
.I topdir
argument specifies the location of the project root.
The default is
``\fB.\fP''
and thus may be omitted if the current directory is the project root.
Otherwise it may be specified as an absolute pathname or as a path relative
to the current directory.
.IR curdir ,
if given, specifies the name of the current directory, relative to the project
root.
.I curdir
is usually omitted.
.\"
.SH OPTIONS
.I imboot
understands the following options:
.TP 8
.B "\-c \fIname\fP
Use the named set of public configuration files instead of the
files in the project's private configuration file
directory.
.TP 8
.B "\-C \fIname\fP
Use the named set of public configuration files in addition
to the files in the project's private configuration file
directory.
.I imboot
tells
.I imake
to look in the private directory under the project root before looking in
the public directory when searching for configuration files.
The intent is to support an extensible configuration file architecture such
that the public files define a baseline configuration that individual
projects can extend or override by providing project-specific information
in files in their private configuration file
directory.
.TP 8
.BI \-D define
This option is passed directly to
.IR imake ,
which passes it to
.IR cpp .
.TP 8
.BI \-I dir
This option is passed directly to
.IR imake ,
which passes it to
.IR cpp .
It can be used to specify additional directories in which to look
to look for configuration files.
.TP 8
.B \-d
Force definition of UseInstalled.
This is shorthand for
.BR \-DUseInstalled ,
which is turned on automatically when you specify
.I \-c
or
.IR \-C .
.TP 8
.B \-u
Force undefinition of UseInstalled.
.PP
For the
.I \-c
.I name
or
.I \-C
.I name
options, the
.I name
argument may also be an absolute pathname, in which case it is used as given
for locating configuration files.
.\"
.SH EXAMPLES
Suppose you want to use a set of public configuration files named XYZ.
If you're in the root directory of a project, you can bootstrap a
.I Makefile
using the XYZ configuration files like this:
.sp .5v
.RS
% imboot \-c XYZ
.RE
.sp .5v
If you're in a subdirectory, say,
.IR src/prog1
(two levels down), the location of the project root is
.B ..\^/..
and you bootstrap the
.I Makefile
with:
.sp .5v
.RS
% imboot \-c XYZ \fB..\^/..\fR
.RE
.sp .5v
If the XYZ configuration files use an extensible architecture and your project
has private configuration files in a
.I config
directory, you can use the private files as well.
The commands just shown become:
.sp .5v
.RS
.nf
% imboot \-C XYZ
% imboot \-C XYZ \fB..\^/..\fR
.fi
.RE
.sp .5v
.\"
.SH "WHO-TO-BLAME"
Paul DuBois, dubois@primate.wisc.edu
.\"
.SH "BUGS"
It's difficult to get
.B \-D
or
.B \-I
arguments that require quotes passed through to
.IR imake.
|