- updated to 1.15.1 (improved perl and gzip compatibility)
[packages/automake.git] / automake-man.patch
1 --- automake-1.8.orig/automake.1
2 +++ automake-1.8/automake.1
3 @@ -0,0 +1,247 @@
4 +.\" Copyright (C) 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
5 +.\" Copyright (C) 1998 Ben Pfaff.
6 +.\"
7 +.\" Permission is granted to make and distribute verbatim copies of
8 +.\" this manual provided the copyright notice and this permission notice
9 +.\" are preserved on all copies.
10 +.\" 
11 +.\" Permission is granted to copy and distribute modified versions of this
12 +.\" manual under the conditions for verbatim copying, provided that the entire
13 +.\" resulting derived work is distributed under the terms of a permission
14 +.\" notice identical to this one.
15 +.\" 
16 +.\" Permission is granted to copy and distribute translations of this manual
17 +.\" into another language, under the above conditions for modified versions,
18 +.\" except that this permission notice may be stated in a translation approved
19 +.\" by the Foundation.
20 +.\"
21 +.TH AUTOMAKE 1 "28 Jan 2002"
22 +.SH NAME
23 +automake - automatically create Makefile.in's from Makefile.am's
24 +.SH SYNOPSIS
25 +.B automake
26 +[
27 +.B -a
28 +|
29 +.B --add-missing
30 +] [
31 +.BR --amdir= DIR
32 +] [
33 +.BR --build-dir= DIR
34 +] [
35 +.B -c
36 +|
37 +.B --copy
38 +] [
39 +.B --cygnus
40 +] [
41 +.B -f
42 +|
43 +.B --force-missing
44 +] [
45 +.B --foreign
46 +] [
47 +.B --gnits
48 +] [
49 +.B --gnu
50 +] [
51 +.B --help
52 +] [
53 +.B -i
54 +|
55 +.B --ignore-deps
56 +] [
57 +.B --include-deps
58 +] [
59 +.B --no-force
60 +] [
61 +.B -o 
62 +DIR
63 +] [
64 +.BR --output-dir= DIR
65 +] [
66 +.BR --srcdir-name= DIR
67 +] [
68 +.B -v
69 +|
70 +.B --verbose
71 +] [
72 +.B --version
73 +] [
74 +.B --Werror
75 +|
76 +.B --Wno-error
77 +]
78 +.SH DESCRIPTION
79 +.PP
80 +To create all the 
81 +.BR Makefile.in s 
82 +for a package, run the 
83 +.B automake
84 +program in the top level directory, with no arguments.  
85 +.B automake
86 +will automatically find each appropriate 
87 +.B Makefile.am
88 +(by scanning
89 +.BR configure.in )
90 +and generate the corresponding 
91 +.BR Makefile.in .
92 +Note that 
93 +.B automake
94 +has a rather simplistic view of what constitutes a package; it assumes
95 +that a package has only one
96 +.BR configure.in , 
97 +at the
98 +top.  If your package has multiple 
99 +.BR configure.in s, 
100 +then you must run
101 +.B automake
102 +in each directory holding a 
103 +.BR configure.in .
104 +.PP
105 +You can optionally give 
106 +.B automake
107 +an argument; 
108 +.B .am
109 +is appended to the argument and the result is used as the name of the
110 +input file.  This feature is generally only used to automatically
111 +rebuild an out-of-date
112 +.BR Makefile.in .  
113 +Note that 
114 +.I automake
115 +must always be run from the topmost directory of a project, even if
116 +being used to regenerate the
117 +.B Makefile.in
118 +in some subdirectory.  This is necessary
119 +because 
120 +.I automake
121 +must scan 
122 +.BR configure.in ,
123 +and because 
124 +.I automake
125 +uses the knowledge that a 
126 +.B Makefile.in
127 +is in a subdirectory to change its behavior in some cases.
128 +.PP
129 +.I automake
130 +accepts the following options:
131 +.TP
132 +.BI -a
133 +.TP
134 +.BI --add-missing
135 +Automake requires certain common files to exist in certain
136 +situations; for instance 
137 +.B config.guess
138 +is required if
139 +.B configure.in
140 +runs 
141 +.BR AC_CANONICAL_HOST .  
142 +Automake is distributed with several of these files; this option will
143 +cause the missing ones to be automatically added to the package,
144 +whenever possible.  In general if Automake tells you a file is
145 +missing, try using this option. By default Automake tries to make a
146 +symbolic link pointing to its own copy of the missing file; this can
147 +be changed with \fB--copy\fP.
148 +.TP
149 +.BI --libdir=\fRDIR
150 +Look for Automake data files in directory DIR instead of in the
151 +installation directory.  This is typically used for debugging.
152 +.TP
153 +.BI -c
154 +.TP
155 +.BI --copy
156 +When used with \fB--add-missing\fP, causes installed files to be copied.
157 +The default is to make a symbolic link.
158 +.TP
159 +.BI --cygnus
160 +Causes the generated 
161 +.BR Makefile.in s 
162 +to follow Cygnus rules, instead of GNU or Gnits rules.
163 +.TP
164 +.BI -f
165 +.TP
166 +.BI --force-missing
167 +When used with \fB--add-missing\fP, causes standard files to be rebuilt
168 +even if they already exist in the source tree.
169 +This involves removing the file from the source tree before creating the
170 +new symlink (or, with \fB--copy\fP, copying the new file).
171 +.TP
172 +.BI --foreign
173 +Set the global strictness to 
174 +.BR foreign .
175 +.TP
176 +.BI --gnits
177 +Set the global strictness to 
178 +.BR gnits .
179 +.TP
180 +.BI --gnu
181 +Set the global strictness to 
182 +.BR gnu .
183 +This is the default strictness.
184 +.TP
185 +.BI --help
186 +Print a summary of the command line options and exit.
187 +.TP
188 +.BI -i
189 +.TP
190 +.BI --ignore-deps
191 +This disables the dependency tracking feature.
192 +.TP
193 +.BI --include-deps
194 +This enables the dependency tracking feature. This feature is
195 +enabled by default. This option is provided for historical
196 +reasons only and probably should not be used.
197 +.TP
198 +.BI --no-force
199 +Ordinarily 
200 +.B automake
201 +creates all 
202 +.BR Makefile.in s
203 +mentioned in
204 +.BR configure.in .
205 +This option causes it to only update those
206 +.BR Makefile.in s 
207 +which are out of date with respect to one of their dependents.
208 +.TP
209 +.BI -o\ \fRDIR
210 +.TP
211 +.BI --output-dir=\fRDIR
212 +Put the generated 
213 +.B Makefile.in
214 +in the directory DIR.  Ordinarily
215 +each 
216 +.B Makefile.in
217 +is created in the directory of the
218 +corresponding 
219 +.BR Makefile.am .  
220 +This option is used when making
221 +distributions.
222 +.TP
223 +.BI -v
224 +.TP
225 +.BI --verbose
226 +Cause Automake to print information about which files are being read
227 +or created.
228 +.TP
229 +.BI --version
230 +Print the version number of Automake and exit.
231 +.TP
232 +.BI --Werror
233 +.TP
234 +.BI --Wno-error
235 +.B --Werror
236 +will cause all warnings issued by
237 +.I automake
238 +to become errors. Errors affect the exit status of
239 +\fIautomake\fP, while warnings do not.
240 +\fB--Wno-error\fP, the default, causes warning to be treated as warnings only.
241 +.PP
242 +.SH "SEE ALSO"
243 +.BR aclocal (1),
244 +and the Texinfo documentation for automake
245 +.SH AUTHORS
246 +Automake was written primarily by David Mackenzie and Tom Tromey.
247 +This manpage written by Ben Pfaff <pfaffben@pilot.msu.edu> for the
248 +Debian GNU/Linux
249 +.B automake
250 +package.
251
252 --- automake-1.8.orig/aclocal.1
253 +++ automake-1.8/aclocal.1
254 @@ -0,0 +1,106 @@
255 +.\" Copyright (C) 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
256 +.\" Copyright (C) 1998 Ben Pfaff.
257 +.\"
258 +.\" Permission is granted to make and distribute verbatim copies of
259 +.\" this manual provided the copyright notice and this permission notice
260 +.\" are preserved on all copies.
261 +.\" 
262 +.\" Permission is granted to copy and distribute modified versions of this
263 +.\" manual under the conditions for verbatim copying, provided that the entire
264 +.\" resulting derived work is distributed under the terms of a permission
265 +.\" notice identical to this one.
266 +.\" 
267 +.\" Permission is granted to copy and distribute translations of this manual
268 +.\" into another language, under the above conditions for modified versions,
269 +.\" except that this permission notice may be stated in a translation approved
270 +.\" by the Foundation.
271 +.\"
272 +.TH ACLOCAL 1 "Automake"
273 +.SH NAME
274 +aclocal - automatically generate aclocal.m4 from configure.in
275 +.SH SYNOPSIS
276 +.B aclocal
277 +[
278 +.BR --acdir= DIR
279 +] [
280 +.B --help
281 +] [
282 +.B -I
283 +DIR ] [
284 +.BR --output= FILE
285 +] [
286 +.B --verbose
287 +] [
288 +.B --version
289 +]
290 +.SH DESCRIPTION
291 +.PP
292 +Automake includes a number of Autoconf macros which can be used in
293 +your package; some of them are actually required by Automake in certain
294 +situations.  These macros must be defined in your 
295 +.BR aclocal.m4 ;
296 +otherwise they will not be seen by 
297 +.BR autoconf .
298 +.PP
299 +The 
300 +.B aclocal
301 +program will automatically generate 
302 +.B aclocal.m4
303 +files based on the contents of 
304 +.BR configure.in .  
305 +This provides a convenient way to get Automake-provided macros,
306 +without having to search around.  Also, the 
307 +.B aclocal
308 +mechanism is extensible for use by other packages.
309 +.PP
310 +At startup, 
311 +.B aclocal
312 +scans all the 
313 +.B .m4
314 +files it can find, looking for macro definitions.  Then it scans
315 +.BR configure.in .  
316 +Any mention of one of the macros found in the first step causes that
317 +macro, and any macros it in turn requires, to be put into
318 +.BR aclocal.m4 .
319 +.PP
320 +The contents of 
321 +.BR acinclude.m4 , 
322 +if it exists, are also automatically included in 
323 +.BR aclocal.m4 .  
324 +This is useful for incorporating local macros into 
325 +.BR configure .
326 +.PP
327 +.B aclocal
328 +accepts the following options:
329 +.TP
330 +.BI --acdir=\fRDIR
331 +Look for the macro files in DIR instead of the installation
332 +directory.  This is typically used for debugging.
333 +.TP
334 +.BI --help
335 +Print a summary of the command line options and exit.
336 +.TP
337 +.BI -I\fR\ DIR
338 +Add the directory DIR to the list of directories searched for
339 +.B .m4
340 +files.
341 +.TP
342 +.BI --output=\fRFILE
343 +Cause the output to be put into FILE instead of 
344 +.BR aclocal.m4 .
345 +.TP
346 +.BI --verbose
347 +Print the names of the files it examines.
348 +.TP
349 +.BI --version
350 +Print the version number of Automake and exit.
351 +.PP
352 +.SH "SEE ALSO"
353 +.BR automake (1),
354 +and the Texinfo documentation for automake
355 +.SH AUTHORS
356 +Automake was written primarily by David Mackenzie and Tom Tromey.
357 +This manpage written by Ben Pfaff <pfaffben@pilot.msu.edu> for the
358 +Debian GNU/Linux
359 +.B automake
360 +package.
This page took 0.0865669999999999 seconds and 3 git commands to generate.