<!doctype linuxdoc system>

<article>

<title> Readme for the XFree86 3.1.1 LinkKit
<author> The XFree86 Project, Inc.
<date> 7 January 1995

<sect> Readme for the XFree86 3.1.1 LinkKit <p>
<enum>
<item> For systems which don't use gcc-2, you may need to install libgcc.a if
   the binary distribution you are using was built with gcc-2.

<item> Make sure that you have the XFree86 3.1.1 config files and libraries
   and headers installed under /usr/X11R6.  For some OSs these will be
   included in the `lib' and `inc' packages.  For others they are included
   in the `prog' or `dev' package.  Older versions are not compatible.

<item> Edit the site.def file to define which servers you want to build, and
   the drivers and extensions you want included.

    <itemize>
    <item> Set <tt>HasGcc</tt> and <tt>HasGcc2</tt> to match the compiler
      you are using if the defaults aren't correct.
    <item> If the LinkKit was built with gcc-2.x and you are using some other
      compiler, you must install libgcc.a and set <tt>NeedLibGcc</tt> to
      <tt>YES</tt>.
    <item>To build the 256 colour server:
	set <tt>XF86SVGAServer</tt> to <tt>YES</tt>.
    <item>To build the 16 colour server:
	set <tt>XF86VGA16Server</tt> to <tt>YES</tt>.
    <item>To build the monochrome server:
	set <tt>XF86MonoServer</tt> to <tt>YES</tt>.
    <item>To build the S3 server:
	set <tt>XF86S3Server</tt> to <tt>YES</tt>.
    <item>To build the Mach8 server:
	set <tt>XF86Mach8Server</tt> to <tt>YES</tt>.
    <item>To build the Mach32 server:
	set <tt>XF86Mach32Server</tt> to <tt>YES</tt>.
    <item>To build the Mach64 server:
	set <tt>XF86Mach64Server</tt> to <tt>YES</tt>.
    <item>To build the P9000 server:
	set <tt>XF86P9000Server</tt> to <tt>YES</tt>.
    <item>To build the AGX server:
	set <tt>XF86AGXServer</tt> to <tt>YES</tt>.
    <item>To build the ET4000/W32 server:
	set <tt>XF86W32Server</tt> to <tt>YES</tt>.
    <item>To build the IBM 8514/A server:
	set <tt>XF86I8514Server</tt> to <tt>YES</tt>.
    <item>To build the Xnest server:
	set <tt>XnestServer</tt> to <tt>YES</tt>.

    <item> Set <tt>XF86SvgaDrivers</tt> to the list of drivers you want to
	include in the SVGA server.
    <item> Set <tt>XF86Vga16Drivers</tt> to the list of drivers you want to
	include in the 16 colour server.
    <item> Set <tt>XF86Vga2Drivers</tt> to the list of drivers you want to
	include in the monochrome vga server.
    <item> Set<tt> XF86MonoDrivers</tt> to the list of non-vga mono drivers
	you want to include in the mono or VGA16 servers (when building
	dual-headed servers).
    <item>Note: the ordering of drivers determines the order in which the
        probing is done.  The `<tt>generic</tt>' driver should be the last one
        included in the Mono and VGA16 and SVGA servers because its probe
        always succeeds.
    <item>To include the PEX extension:
	set <tt>BuildPexExt</tt> to <tt>YES</tt>.
    <item>To include the X Image Extension:
	set <tt>BuildXIE</tt> to <tt>YES</tt>.
    <item>To include the Low Bandwidth X extension:
	set <tt>BuildLBX</tt> to <tt>YES</tt>.
    <item>To include the Screen Saver extension:
	set <tt>BuildScreenSaverExt</tt> to <tt>YES</tt>.

    <item>If you are building more than one Xserver, uncomment the
        <tt>ServerToInstall</tt> line and set it to the name of the
        Xserver you want to be the default server (i.e., the one that
        the ``X'' sym-link points to).
    </itemize>

<item> If you are including a driver that it not part of the standard
   distribution, make a directory in <tt>drivers/vga256</tt>
   (<tt>drivers/vga2</tt> if it is for the VGA2 part of the Mono server,
    <tt>drivers/vga16</tt> if it is for the 16
   colour server, or <tt>drivers/mono</tt> non-VGA part of the Mono and VGA16
   servers) and copy either the source or .o file and a suitable Imakefile
   into that directory.  The name of the directory should be the same as the
   name of the driver (refer to the documentation in the <tt>VGADriverDoc</tt>
   directory for more details).

<item> To build the Makefile, run
<verb>
  ./mkmf
</verb>
<item> Run `<tt>make</tt>' to link the server(s) as configured.

<item> Run `<tt>make install</tt>' to install the new server(s).

<item> Run `<tt>make clean</tt>' to remove the files that were created by this
   procedure.

<item> If you edit the site.def file and change the selection of servers
   being built or the drivers included in them, repeat the above procedure.
   If changing the selection of Xserver extensions being included it is
   sufficient to run `<tt>make Makefile</tt>' instead of `<tt>./xmkmf</tt>'.

<item> It is possible to see which drivers are included in the Xserver by
   running it with the `<tt>-showconfig</tt>' flag.  To check which extensions
   are included, start the Xserver wand run `<tt>xdpyinfo</tt>'.
</enum>

<verb>
$XConsortium: LinkKit.sgml,v 1.2 95/01/16 13:17:43 kaleb Exp $
$XFree86: xc/programs/Xserver/hw/xfree86/doc/sgml/LinkKit.sgml,v 3.2 1995/01/14 10:47:43 dawes Exp $
</verb>

</article>
