xenocara/README

	Notes on building Xenocara for OpenBSD X hackers

This document presents some techniques that can be useful for people
wanting to hack the xenocara tree. It assumes some basic knowledge of
the OpenBSD build system, as described in the release(8) manual page.

o About Xenocara
  --------------
Xenocara is the name choosen for OpenBSD's version of X. It's
currently based on X.Org 7.2 and its dependencies. The goal of
Xenocara is to provide a framework to host local modifications and to
automate the build of the modular X.Org components, including 3rd
party packages and some software maintained by OpenBSD developpers.

o Source tree
  -----------

The organisation of the xenocara directory follows the general
organisation used in X.Org:

- app:	     X applications and utilities
- data:	     various data files (keyboard mappings and bitmaps)
- doc:	     documentation
- driver:    input and video drivers
- font:	     fonts
- lib:	     libraries
- proto:     X protocol headers
- util:	     utilities that don't fit anywhere else
- xserver:   the source for the X servers 

In addition Xenocara uses the following directories:

- dist:	    contains the Mesa sources, shared by lib and xserver above
- distrib:  all binary distribution related tools and data
- etc:	    mtree(8) data files
- share:    make(1) configuration for Xenocara

At the top-level directory two files describe the individual
components of Xenocara:

- MODULES  lists all X.Org components (imported from the X.Org
	   distribution at http://xorg.freedesktop.org/archive/)
- 3RDPARTY lists all 3rd party software components provided in Xenocara,
	   either as dependencies of the X.Org software, or as
	   complements to it to provide a more useable default
	   environment.

o Compiling and installing
  ------------------------

Xenocara is made up of more than three hundred different
independent packages that need to be build and installed in the right
order, especially while bootstrapping (while /usr/X11R6 is still
empty). The Xenocara Makefiles take care of that using the 'build'
target.

  Quick startup guide

The following steps will build and install everything for the first time.

 mkdir -p /usr/obj/xenocara
 cd xenocara
 make bootstrap
 make obj
 make build

If you want to use another obj directory see below.

  Requirements

A freshly checked out xenocara tree is buildable without any external
tool. However if you start modifying things in the automake build
system used by many packages, you will need to have the following
GNU autotools packages installed:

    - automake 1.9 (devel/automake/1.9)
    - autoconf 2.59 (devel/autoconf/2.59)
    - metaauto 0.6 (or later) (devel/metaauto)
    - libtool 1.5.22 (or later) (devel/libtool)

  Sudo

If the SUDO variable points to your sudo(8) binary in /etc/mk.conf,
'make build' can be run as a normal user. It will raise its privileges
whenever needed with sudo. Otherwise, you need to run make build as
root.

If you have installed the full Xenocara X sets on your system, you
don't need to build all of Xenocara to patch one element. You can go
to any module sub-directory and run 'make build' from there. 

  Objdirs

Xenocara supports objdirs (and it's even the recommended way to build
things). Just run 'make obj' at any level before 'make build' to make
sure that the object directories are created. 
XENOCARA_OBJDIR defines the default obj directory that is used.

  Shadow trees 

Alternatively, the old 'lndir(1)' method can still be used to build
Xenocara outside of its source tree. Just don't use 'make obj' in this
case. 

o Regenerating configure scripts
  ------------------------------

Whenever you touched an import file for GNU autotools (Makefile.am,
configure.ac mostly), you need to rebuild the configure script and
makefiles skeletons. For that use the following command:

 env XENOCARA_RERUN_AUTOCONF=Yes make -f Makefile.bsd-wrapper build

You can also set XENOCARA_RERUN_AUTOCONF in /etc/mk.conf to force
regeneration of configure scripts in every component.

$OpenBSD: README,v 1.7 2007/01/04 20:56:55 matthieu Exp $