util/xmkmf.man

   1 .\" $TOG: xmkmf.man /main/9 1998/02/06 11:25:04 kaleb $
   2 .\" Copyright (c) 1993, 1994, 1998 The Open Group
   3 .\"
   4 .\" All Rights Reserved.
   5 .\"
   6 .\" The above copyright notice and this permission notice shall be included in
   7 .\" all copies or substantial portions of the Software.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  10 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  11 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  12 .\" THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  13 .\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  14 .\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  15 .\" SOFTWARE.
  16 .\"
  17 .\" Except as contained in this notice, the name of The Open Group shall not
  18 .\" be used in advertising or otherwise to promote the sale, use or other
  19 .\" dealing in this Software without prior written authorization from The
  20 .\" Open Group.
  21 .TH XMKMF 1 "Release 6.4" "X Version 11"
  22 .SH NAME
  23 xmkmf \- create a Makefile from an Imakefile
  24 .SH SYNOPSIS
  25 .B xmkmf
  26 [ -a ] [
  27 .I topdir
  28 [
  29 .I curdir
  30 ] ]
  31 .SH DESCRIPTION
  32 The
  33 .I xmkmf
  34 command is the normal way to create a
  35 .I Makefile
  36 from an
  37 .I Imakefile
  38 shipped with third-party software.
  39 .PP
  40 When invoked with no arguments in a directory containing an
  41 .I Imakefile,
  42 the
  43 .I imake
  44 program is run with arguments appropriate for your system
  45 (configured into
  46 .I xmkmf
  47 when X was built) and generates a
  48 .I Makefile.
  49 .PP
  50 When invoked with the
  51 .I \-a
  52 option,
  53 .I xmkmf
  54 builds the
  55 .I Makefile
  56 in the current directory, and then automatically executes
  57 ``make Makefiles'' (in case there are subdirectories),
  58 ``make includes'',
  59 and ``make depend'' for you.
  60 This is the normal way to configure software that is outside
  61 the X Consortium build tree.
  62 .PP
  63 If working inside the X Consortium build tree (unlikely unless you
  64 are an X developer, and even then this option is never really used), the
  65 .I topdir
  66 argument should be specified as the relative pathname from the
  67 current directory to the top of the build tree.  Optionally,
  68 .I curdir
  69 may be specified as a relative pathname from the top of the build
  70 tree to the current directory.  It is necessary to supply
  71 .I curdir
  72 if the current directory has subdirectories, or the
  73 .I Makefile
  74 will not be able to build the subdirectories.
  75 If a
  76 .I topdir
  77 is given,
  78 .I xmkmf
  79 assumes nothing is installed on your system and looks for files in
  80 the build tree instead of using the installed versions.
  81 .SH "SEE ALSO"
  82 imake(1)