dtstyle: Coverity 89011
[oweals/cde.git] / cde / util / scripts / xmkmf.man
1 .\" $XConsortium: xmkmf.man,v 1.3 91/08/17 13:06:59 rws Exp $
2 .TH XMKMF 1 "Release 5" "X Version 11"
3 .SH NAME
4 xmkmf \- create a Makefile from an Imakefile
5 .SH SYNOPSIS
6 .B xmkmf
7 [ -a ] [
8 .I topdir
9 [
10 .I curdir
11 ] ]
12 .SH DESCRIPTION
13 The
14 .I xmkmf
15 command is the normal way to create a
16 .I Makefile 
17 from an
18 .I Imakefile
19 shipped with third-party software.
20 .PP
21 When invoked with no arguments in a directory containing an
22 .I Imakefile,
23 the
24 .I imake
25 program is run with arguments appropriate for your system
26 (configured into
27 .I xmkmf
28 when X was built) and generates a
29 .I Makefile.
30 .PP
31 When invoked with the
32 .I \-a
33 option,
34 .I xmkmf
35 builds the
36 .I Makefile
37 in the current directory, and then automatically executes
38 ``make Makefiles'' (in case there are subdirectories),
39 ``make includes'',
40 and ``make depend'' for you.
41 This is the normal way to configure software that is outside
42 the MIT X build tree.
43 .PP
44 If working inside the MIT X build tree (unlikely unless you are an X
45 developer, and even then this option is never really used), the
46 .I topdir
47 argument should be specified as the relative pathname from the
48 current directory to the top of the build tree.  Optionally,
49 .I curdir
50 may be specified as a relative pathname from the top of the build
51 tree to the current directory.  It is necessary to supply
52 .I curdir
53 if the current directory has subdirectories, or the
54 .I Makefile
55 will not be able to build the subdirectories.
56 If a
57 .I topdir
58 is given,
59 .I xmkmf
60 assumes nothing is installed on your system and looks for files in
61 the build tree instead of using the installed versions.
62 .SH "SEE ALSO"
63 imake(1)