diff options
author | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-11-02 19:25:40 -0700 |
---|---|---|
committer | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-11-02 19:33:52 -0700 |
commit | 8c9927593051c952b0a18616418519ca8b01db19 (patch) | |
tree | b725525a5b9a68bd291bd16540a54d974f4ca5a7 | |
parent | a6f01f42733110b191d95cb9f48357c92a796f08 (diff) |
Convert platform docs from DocBook SGML to DocBook XML
Uses newer tools for formatting, better matching other new docs
Moved from sgml/platform to new directory general/platform
Delete SCO.sgml, since it's not been updated since the monolith
and the SCO port hasn't been maintained in a while.
Since these were the last sgml documents, remove the sgml subdirectory,
and the configure.ac macros to find the docbook sgml tools.
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
-rw-r--r-- | Makefile.am | 2 | ||||
-rw-r--r-- | configure.ac | 4 | ||||
-rw-r--r-- | general/Makefile.am | 2 | ||||
-rw-r--r-- | general/platforms/Darwin.xml (renamed from sgml/platforms/Darwin.sgml) | 7 | ||||
-rw-r--r-- | general/platforms/Makefile.am | 12 | ||||
-rw-r--r-- | general/platforms/NetBSD.xml | 801 | ||||
-rw-r--r-- | general/platforms/OpenBSD.xml | 463 | ||||
-rw-r--r-- | general/platforms/Solaris.xml (renamed from sgml/platforms/Solaris.sgml) | 141 | ||||
-rw-r--r-- | sgml/Makefile.am | 23 | ||||
-rw-r--r-- | sgml/platforms/Makefile.am | 11 | ||||
-rw-r--r-- | sgml/platforms/NetBSD.sgml | 797 | ||||
-rw-r--r-- | sgml/platforms/OpenBSD.sgml | 476 | ||||
-rw-r--r-- | sgml/platforms/SCO.sgml | 278 | ||||
-rw-r--r-- | sgmlrules.in | 64 |
14 files changed, 1355 insertions, 1726 deletions
diff --git a/Makefile.am b/Makefile.am index a938766..ef60bbe 100644 --- a/Makefile.am +++ b/Makefile.am @@ -20,7 +20,7 @@ # # Process this file with autoconf to create configure. -SUBDIRS = general man sgml specs +SUBDIRS = general man specs dist_doc_DATA = MAINTAINERS diff --git a/configure.ac b/configure.ac index 29de701..a1dbe0b 100644 --- a/configure.ac +++ b/configure.ac @@ -42,16 +42,14 @@ XORG_ENABLE_SPECS XORG_WITH_XMLTO(0.0.20) XORG_WITH_FOP XORG_CHECK_SGML_DOCTOOLS(1.5) -XORG_CHECK_DOCBOOK AC_CONFIG_FILES([Makefile general/Makefile general/fonts/Makefile general/input/Makefile general/graphics/Makefile + general/platforms/Makefile man/Makefile - sgml/Makefile - sgml/platforms/Makefile specs/Makefile specs/CTEXT/Makefile specs/ICCCM/Makefile diff --git a/general/Makefile.am b/general/Makefile.am index a3857e2..e9731cb 100644 --- a/general/Makefile.am +++ b/general/Makefile.am @@ -1,6 +1,6 @@ # Process this file with automake to create Makefile.in -SUBDIRS = fonts input graphics +SUBDIRS = fonts input graphics platforms doc_sources = \ License.xml \ diff --git a/sgml/platforms/Darwin.sgml b/general/platforms/Darwin.xml index 645a8ad..552eee0 100644 --- a/sgml/platforms/Darwin.sgml +++ b/general/platforms/Darwin.xml @@ -1,5 +1,8 @@ -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ -<!ENTITY % defs SYSTEM "X11/defs.ent"> %defs; +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ +<!ENTITY % defs SYSTEM "/xorg-sgml-doctools/X11/defs.ent"> %defs; ]> <article> diff --git a/general/platforms/Makefile.am b/general/platforms/Makefile.am new file mode 100644 index 0000000..eeab5dc --- /dev/null +++ b/general/platforms/Makefile.am @@ -0,0 +1,12 @@ +# Process this file with automake to create Makefile.in + +doc_sources = \ + Darwin.xml \ + NetBSD.xml \ + OpenBSD.xml \ + Solaris.xml + +xmldir = $(docdir)/platforms +dist_xml_DATA = $(doc_sources) + +include $(top_srcdir)/xmlrules.in diff --git a/general/platforms/NetBSD.xml b/general/platforms/NetBSD.xml new file mode 100644 index 0000000..92fa212 --- /dev/null +++ b/general/platforms/NetBSD.xml @@ -0,0 +1,801 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ +<!ENTITY % defs SYSTEM "/xorg-sgml-doctools/X11/defs.ent"> %defs; +]> + +<article> + +<articleinfo> + +<title>README for X11R&relvers; on NetBSD</title> +<author><firstname>Rich</firstname><surname>Murphey</surname></author> +<author><firstname>David</firstname><surname>Dawes</surname></author> +<author><firstname>Marc</firstname><surname>Wandschneider</surname></author> +<author><firstname>Mark</firstname><surname>Weaver</surname></author> +<author><firstname>Matthieu</firstname><surname>Herrb</surname></author> +</articleinfo> + +<sect1> +<title>What and Where is X11R&relvers;?</title> + +<para> +X11R&relvers; is an Open Source version of the X Window System that supports +several UNIX(R) and UNIX-like operating systems (such as Linux, the BSDs +and Solaris x86) on Intel and other platforms. This version is compatible +with X11R6.6, and is based on the XFree86 4.4.0RC2 code base, which, +in turn was based on the X consortium sample implementation. +</para> + +<para> +See the <ulink url="../License.html">Copyright Notice</ulink>. +</para> + +<para> +The sources for X11R&relvers; are available from: +</para> + +<para> +<ulink url="http://wiki.x.org">http://wiki.x.org</ulink> +</para> + +<para> +X11R&relvers; also builds on other NetBSD architectures. See section +<xref linkend="otherarchs" /> for details. +</para> + +</sect1> + +<sect1> +<title>New OS dependent features</title> + +<para> +See the <ulink url="../ReleaseNotes.html">Release Notes</ulink> for +non-OS dependent new features in X11R&relvers;. +</para> + +<sect2> +<title>New OS dependent features in XFree86 4.2.0</title> + +<para> + +<itemizedlist> +<listitem> + +<para> +Support of client side on NetBSD/sparc64 +</para> +</listitem> +<listitem> + +<para> +Support for in-kernel MTRR and AGP support in NetBSD 1.5Y +</para> +</listitem> + +</itemizedlist> + +</para> + +</sect2> + +<sect2> +<title>New OS dependent features in XFree86 4.1.0</title> + +<para> + +<itemizedlist> +<listitem> + +<para> +Enable wide characters support in NetBSD 1.5P and later. +</para> +</listitem> + +</itemizedlist> + +</para> + +</sect2> + +<sect2> +<title>New OS dependent features in XFree86 4.0.2</title> + +<para> + +<itemizedlist> +<listitem> + +<para> +A fix for libXmu OS detection which was broken since <symbol>unix</symbol> +isn't defined anymore by the C preprocessor. +</para> +</listitem> +<listitem> + +<para> +(limited) native wscons support. This is not activated by +default. +</para> +</listitem> +<listitem> + +<para> +Updates to the aperture driver +</para> +</listitem> +<listitem> + +<para> +Support for multithread libraries with GNU pth +</para> +</listitem> +<listitem> + +<para> +Add <filename>/usr/pkg/bin</filename> to the default user path. +</para> +</listitem> + +</itemizedlist> + +</para> + +</sect2> + +<sect2> +<title>New OS dependent features in XFree86 4.0.1</title> + +<para> + +<itemizedlist> +<listitem> + +<para> +Support for NetBSD 1.5_ALPHA +</para> +</listitem> +<listitem> + +<para> +The Xsun server can be built on NetBSD/sparc +</para> +</listitem> + +</itemizedlist> + +</para> + +</sect2> + +<sect2> +<title>New OS dependent features in XFree86 4.0</title> + +<para> + +<itemizedlist> +<listitem> + +<para> +Preliminary APM support. +</para> +</listitem> + +</itemizedlist> + +</para> + +</sect2> + +<sect2> +<title>New OS dependent features in XFree86 3.9.18</title> + +<para> + +<itemizedlist> +<listitem> + +<para> +Soft-booting secondary cards through the int10 BIOS interface is +now possible using the x86emu real mode emulator. +</para> +</listitem> + +</itemizedlist> + +</para> + +</sect2> + +<sect2> +<title>New OS dependent features in XFree86 3.9.17</title> + +<para> + +<itemizedlist> +<listitem> + +<para> +Support for <emphasis>silken mouse</emphasis> with the wsmouse protocol has +been added. +</para> +</listitem> +<listitem> + +<para> +A new version of the Aperture driver which provides MTRR +support is included. +</para> +</listitem> + +</itemizedlist> + +</para> + +</sect2> + +</sect1> + +<!-- +<sect1> +<title>Installing the Binaries</title> + +<para> +Refer to the <ULink URL="Install.html">Installation Document</ULink> +for detailed installation instructions. +</para> + +</sect1> +--> + +<sect1> +<title>Configuring X for Your Hardware</title> + +<para> +The <filename>/etc/X11/xorg.conf</filename> file tells the X server what kind of +monitor, +video card and mouse you have, if it cannot determine the information by +probing the hardware. +</para> + +<para> +You'll need info on your hardware: + +<itemizedlist> +<listitem> + +<para> +Your mouse type, baud rate and its /dev entry. +</para> +</listitem> +<listitem> + +<para> +The video card's chipset (e.g. ET4000, S3, etc). +</para> +</listitem> +<listitem> + +<para> +Your monitor's sync frequencies. +</para> +</listitem> + +</itemizedlist> + +</para> + +<para> +For details about the <filename>xorg.conf</filename> file format, refer to the +<emphasis><ulink url="xorg.conf.5.html">xorg.conf(5)</ulink></emphasis> manual page. +</para> + +<para> +Once you've set up a xorg.conf file, you can fine tune the video +modes with the <command>xvidtune</command> utility. +</para> + +<sect2> +<title>About mouse configuration</title> + +<para> +X11R&relvers; has support for the mouse driver included in +the <filename>wscons</filename> console driver introduced by NetBSD 1.4. Specify +<quote><literal remap="tt">wsmouse</literal></quote> as the protocol +and <quote><literal remap="tt">/dev/wsmouse0</literal></quote> as the +device in <filename>/etc/X11/xorg.conf</filename> if you're using NetBSD 1.4 or later +with a PS/2 mouse. +</para> + +<para> +For older releases, the NetBSD <filename>pms</filename> mouse driver handles PS/2 style +mice as Busmouse. Specify the protocol as <quote><literal remap="tt">busmouse</literal></quote> in the +mouse section of your <filename>xorg.conf</filename> file if you're using a PS/2 +mouse with NetBSD 1.3 or former releases. +</para> + +<para> +Only standard PS/2 mice are supported by this driver. Newest PS/2 +mice that send more than three bytes at a time (especially +Intellimouse, or MouseMan+ with a wheel) are not supported by NetBSD +1.3 and former releases. +</para> + +<para> +See <ulink url="../mouse.html">README.mouse</ulink> for general +instruction on mouse configuration. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Running X</title> + +<para> +The easiest way for new users to start X windows is to type: + +<screen> +startx >& startx.log +</screen> + +Error messages are lost unless you redirect them +because the server takes over the screen. +</para> + +<para> +To get out of X windows, type: <quote><userinput>exit</userinput></quote> +in the console <command>xterm</command>. +You can customize your X by creating <filename>.xinitrc</filename>, +<filename>.xserverrc</filename>, and <filename>.twmrc</filename> files +in your home directory as described in the <command>xinit</command> +and <command>startx</command> man pages. +</para> + +<sect2> +<title>Starting Xdm, the display manager</title> + +<para> +To start the display manager, log in as root on the console and type: +<quote><userinput>xdm -nodaemon</userinput></quote>. +</para> + +<para> +You can start xdm automatically on bootup by changing the line + +<screen> +xdm=NO xdm_flags="" # x11 display manager +</screen> + +to: + +<screen> +xdm=YES xdm_flags="" # x11 display manager +</screen> + +in <filename>/etc/rc.conf</filename>. +</para> + +<para> +Under NetBSD 1.4 and later with the wscons console driver, you must +enable a virtual console for the X server first. To do this follow +these steps: + +<itemizedlist> +<listitem> + +<para> +Make sure the device file exists. If not, <quote><userinput>cd /dev ; +./MAKEDEV wscons</userinput></quote>. +</para> +</listitem> +<listitem> + +<para> +Next, make sure your kernel wants to do wscons. (see <xref linkend="wscons"/>). +</para> +</listitem> +<listitem> + +<para> +Next, make sure <quote><literal remap="tt">wscons=YES</literal></quote> in +<filename>/etc/rc.conf</filename>. +</para> +</listitem> +<listitem> + +<para> +Next, make sure <filename>/etc/wscons.conf</filename> exists. The relevant +bits: + +<screen> +#screen 0 - vt100 +screen 1 - vt100 +screen 2 - vt100 +screen 3 - vt100 +screen 4 - - +screen 5 - vt100 +</screen> + +</para> +</listitem> + +</itemizedlist> + +(Thanks to Mason Loring Bliss +<email><mason@acheron.middleboro.ma.us></email> for this explanation) +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Kernel Support for X</title> + +<para> +To make sure X support is enabled under NetBSD, the following +line must be in your config file in <filename>/sys/arch/i386/conf</filename>: +</para> + +<para> + +<screen> +options XSERVER, UCONSOLE +</screen> + +</para> + +<sect2> +<title>Console drivers</title> + +<para> +The server supports the standard NetBSD/i386 +console drivers: pccons, pcvt and wscons (in pcvt compatibility +mode). They are detected at runtime and no +configuration of the server itself is required. +</para> + +<para> +The pccons driver is the most widely tested and is the console driver +contained in the NetBSD binary distribution's kernels. +</para> + +<para> +The pcvt console driver was bundled with NetBSD until 1.4. The pcvt X +mode is compatible with the pccons driver X mode. It offers several +virtual consoles and international keyboard support. In order to use +this driver, change the line: +</para> + +<para> + +<screen> +device pc0 at isa? port "IO_KBD" irq 1 +</screen> + +</para> + +<para> +to +</para> + +<para> + +<screen> +device vt0 at isa? port "IO_KBD" irq 1 +</screen> + +</para> + +<para> +in your kernel config file, and rebuild and install your kernel. +</para> + +<para id="wscons" xreflabel="below"> +Wscons is the current console driver, included in NetBSD 1.4 and +later. For now, X supports wscons using the pcvt compatibility +mode, so be sure to have the lines: + +<screen> +options WSDISPLAY_COMPAT_PCVT # emulate some ioctls +options WSDISPLAY_COMPAT_SYSCONS # emulate some ioctls +options WSDISPLAY_COMPAT_USL # VT handling +options WSDISPLAY_COMPAT_RAWKBD # can get raw scancodes +</screen> + +in your kernel configuration file if you're using wscons. Refer to the +<emphasis>wscons(4)</emphasis> and <emphasis>wsmouse(4)</emphasis> manual pages for +informations on how to configure wscons into the kernel. +</para> + +</sect2> + +<sect2> +<title>Aperture Driver</title> + +<para> +By default NetBSD include the BSD 4.4 kernel security +feature that disable access to the <filename>/dev/mem</filename> device when in +multi-users mode. But X.Org Foundation X servers can take advantage +(or require) +linear access to the display memory. +</para> + +<para> +Most X11R&relvers; card drivers require linear memory access. +There are two ways to allow X to access linear memory: +</para> + +<para> +The first way is to disable the kernel security feature by adding +<quote><filename>option INSECURE</filename></quote> in the kernel configuration file and build a new +kernel. +</para> + +<para> +The second way is to install the aperture driver, included in source form in +<filename>xc/programs/Xserver/hw/xfree86/etc/apNetBSD.shar</filename> in the +X11R6.9 source distribution. Unpack it in a new directory of your +choice by running: + +<screen> + sh apNetBSD.shar +</screen> + +By default the aperture driver will be installed in +<filename>/usr/local/aperture</filename>. You can change this default directory by +editing <filename>Makefile.inc</filename> before building it. +</para> + +<para> +Then run <quote><userinput>make build</userinput></quote> as root to install it. To enable it, +add the following line to <filename>/etc/lkm.conf</filename>: + +<screen> +/usr/local/aperture/lkm/xf86.o - - /usr/local/aperture/lkm/xf86_mod_install - - +</screen> + +and set <quote><literal remap="tt">lkm=YES</literal></quote> in <filename>/etc/rc.conf</filename> +</para> + +<para> +Reboot your system. X will auto-detect the aperture +driver if available. +</para> + +<para> +<emphasis remap="bf">Warning 1:</emphasis> if you boot another kernel than <filename>/netbsd</filename>, +loadable kernel modules can crash your system. Always boot in +single user mode when you want to run another kernel. +</para> + +<para> +<emphasis remap="bf">Warning 2:</emphasis> the aperture driver only allows one access at a time +(so that the system is in the same security state once X is +launched). This means that if you run multiple servers on multiples +VT, only the first one will have linear memory access. +Use <quote>option INSECURE</quote> if you need more that one X server at a time. +</para> + +<para> +Starting with XFree86 3.9.17, the XFree86 aperture driver +also supports MTRR write combining on Pentiums II +and AMD K6 class processors. +</para> + +</sect2> + +<sect2> +<title>MIT-SHM</title> + +<para> +NetBSD 1.0 and later supports System V shared memory. If X +detects this support in your kernel, it will support the MIT-SHM +extension. +</para> + +<para> +To add support for system V shared memory to your kernel add the +lines: +</para> + +<para> + +<screen> + # System V-like IPC + options SYSVMSG + options SYSVSEM + options SYSVSHM +</screen> + +</para> + +<para> +to your kernel config file. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Rebuilding the X Distribution</title> + +<para> +You should configure the distribution by editing +<filename>xc/config/cf/host.def</filename> before compiling. To compile the +sources, invoke <quote><userinput>make World</userinput></quote> in the xc directory. +</para> + +<sect2> +<title>Aperture driver</title> + +<para> +To build the X server with the Aperture driver enabled, you +should unpack <filename>apNetBSD.shar</filename> and install it first. +</para> + +<para> +Then edit <filename>xc/config/cf/host.def</filename> and add the line + +<screen> +#define HasNetBSDApertureDriver YES +</screen> + +to it before rebuilding X. +</para> + +</sect2> + +<sect2 id="console-drivers"> +<title>Console drivers</title> + +<para> +X has a configuration option to select the console +drivers to use in <filename>host.def</filename>: + +<itemizedlist> +<listitem> + +<para> + if you're using pccons put: + +<screen> + #define XFree86ConsoleDefines -DPCCONS_SUPPORT +</screen> + +</para> +</listitem> +<listitem> + +<para> +if you're using pcvt put: + +<screen> + #define XFree86ConsoleDefines -DPCVT_SUPPORT +</screen> + +</para> +</listitem> + +</itemizedlist> + +If you don't define <emphasis remap="bf">XFree86ConsoleDefines</emphasis> in <filename>host.def</filename> the +pccons and pcvt drivers will be supported by default. +</para> + +<para> +Experimental native support for the wscons console driver can be built +by adding: + +<screen> + #define XFree86ConsoleDefines -DWSCONS_SUPPORT +</screen> + +to <filename>xc/config/host.def</filename> before rebuilding the server. +This has not been thoroughly tested, except on the macppc. +</para> + +<para> +For the i386, you should include both pcvt and wscons support in order +to use the pcvt compatibility mode of wscons: + +<screen> + #define XFree86ConsoleDefines -DPCVT_SUPPORT -DWSCONS_SUPPORT +</screen> + +</para> + +</sect2> + +<sect2 id="otherarchs"> +<title>Building on other architectures</title> + +<para> + +Note that the NetBSD project has now its own source tree, based on the +X source tree, with some local modifications. You may want to +start with this tree to rebuild from sources. +The NetBSD xsrc source tree is available at: +<ulink +url="ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/xsrc/" +>ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/xsrc/</ulink> +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Building New X Clients</title> + +<para> +The easiest way to build a new client (X application) is to use +<command>xmkmf</command> if an <filename>Imakefile</filename> is included +in the sources. Type <quote><userinput>xmkmf -a</userinput></quote> to +create the Makefiles, check the configuration if necessary and +type <quote><userinput>make</userinput></quote>. Whenever you install +additional man pages you should update <filename>whatis.db</filename> by +running <quote><userinput>makewhatis /usr/X11R6/man</userinput></quote>. +</para> + +<para> +When porting clients to *BSD +systems, make use of the symbol <symbol>BSD</symbol> for code which is truly +BSD-specific. The value of the symbol can be used to distinguish +different BSD releases. For example, code specific to the Net-2 and +later releases can use: +</para> + +<para> + +<programlisting> + +#if (BSD >= 199103) +</programlisting> + +</para> + +<para> +To ensure that this symbol is correctly defined, include +<filename><sys/param.h></filename> in the source that requires it. Note that +the symbol <emphasis remap="bf">CSRG_BASED</emphasis> is defined for *BSD systems in XFree86 3.1.1 +and later. This should be used to protect the inclusion of +<filename><sys/param.h></filename>. +</para> + +<para> +For code that really is specific to a particular i386 BSD port, use +<emphasis remap="bf">__FreeBSD__</emphasis> for FreeBSD, <emphasis remap="bf">__NetBSD__</emphasis> for NetBSD, +<emphasis remap="bf">__OpenBSD__</emphasis> for OpenBSD, +and <emphasis remap="bf">__bsdi__</emphasis> for BSD/386. +</para> + +</sect1> + +<sect1> +<title>Thanks</title> + +<para> +Many thanks to all people who contributed to make XFree86 work on +*BSD, in particular: +<emphasis remap="bf">David Dawes</emphasis>, +<emphasis remap="bf">Todd Fries</emphasis>, +<emphasis remap="bf">Rod Grimes</emphasis>, +<emphasis remap="bf">Charles Hannum</emphasis>, +<emphasis remap="bf">Amancio Hasty</emphasis>, +<emphasis remap="bf">Christoph Robitschko</emphasis>, +<emphasis remap="bf">Matthias Scheler</emphasis>, +<emphasis remap="bf">Michael Smith</emphasis>, +<emphasis remap="bf">Ignatios Souvatzis</emphasis>, +<emphasis remap="bf">Jack Velte</emphasis>, +<emphasis remap="bf">Nate Williams</emphasis> and +<emphasis remap="bf">Pace Willison</emphasis>. +</para> + +</sect1> + +</article> diff --git a/general/platforms/OpenBSD.xml b/general/platforms/OpenBSD.xml new file mode 100644 index 0000000..a2f81b9 --- /dev/null +++ b/general/platforms/OpenBSD.xml @@ -0,0 +1,463 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ +<!ENTITY % defs SYSTEM "/xorg-sgml-doctools/X11/defs.ent"> %defs; +]> + +<article> + +<articleinfo> + +<title>README for X11R&relvers; on OpenBSD</title> +<author> +<firstname>Matthieu</firstname><surname>Herrb</surname> +</author> +<pubdate>Last modified on: 4 February 2005.</pubdate> + +</articleinfo> + +<sect1> +<title>What and Where is X11R7&relvers;?</title> + +<para> +The X.Org Foundation X11R&relvers; is an Open Source version of +the X Window System that supports +several UNIX(R) and UNIX-like operating systems (such as Linux, the BSDs +and Solaris x86) on Intel and other platforms. +</para> + +<para> +See the <ulink url="../LICENSE.html">Copyright Notice</ulink>. +</para> + +<para> +The sources for X11R&relvers; are available from +<ulink url="http://wiki.x.org">http://wiki.x.org</ulink> +</para> + +<para> +X11R&relvers; builds on most architectures supported by OpenBSD. See section +<xref linkend="otherarch"/> for details. +</para> + +</sect1> + +<sect1> +<title>Bug Reports for This Document</title> + +<para> +Use the X.Org Bugzilla at <ulink +url="http://bugs.freedesktop.org">http://bugs.freedesktop.org</ulink> +to submit comments or suggestions about this file, using the xorg product. +</para> + +</sect1> + +<sect1> +<title>New OS dependent features</title> + +<para> +See the <ulink url="ReleaseNotes.html">Release Notes</ulink> for +non-OS dependent new features in X11R&relvers;. +</para> + +<para> + +<itemizedlist> +<listitem> + +<para> +Switch the the Xinput-aware kbd driver for keyboard input +</para> +</listitem> + +</itemizedlist> + +</para> + +<sect2> +<title>New OS related features in X.Org 6.8</title> + +<para> + +<itemizedlist> +<listitem> + +<para> +Support for Propolice in modules. +</para> +</listitem> +<listitem> + +<para> +Server support for OpenBSD/amd64. +</para> +</listitem> + +</itemizedlist> + +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Configuring X for Your Hardware</title> + +<para> +The <filename>/etc/X11/xorg.conf</filename> file tells the X server what kind of +monitor, +video card and mouse you have. You <emphasis>must</emphasis> create it to tell the +server what specific hardware you have. +</para> + +<para> +You'll need info on your hardware: + +<itemizedlist> +<listitem> + +<para> +Your mouse type, baud rate and its /dev entry. +</para> +</listitem> +<listitem> + +<para> +The video card's chipset (e.g. ATI Radeon, nVidia GeForce 4/MX etc). +</para> +</listitem> +<listitem> + +<para> +Your monitor's sync frequencies. +</para> +</listitem> + +</itemizedlist> + +</para> + +<para> +The recommended way to generate an <filename>xorg.conf</filename> file is to use the +<command>xorgcfg</command> utility. The xorgconfig text utility is still there +for the (few) cases where xorgcfg can't be used. Also, there is a +sample file installed as <filename>/usr/X11R6/lib/X11/xorg.conf.eg</filename>, +which can be used as a starting point. +</para> + +<para> +For details about the <filename>xorg.conf</filename> file format, refer to the +<emphasis><ulink url="xorg.conf.5.html">xorg.conf(5)</ulink></emphasis> +manual page. +</para> + +<para> +Once you've set up a xorg.conf file, you can fine tune the video +modes with the <command>xvidtune</command> utility. +</para> + +<sect2> +<title>About mouse configuration</title> + +<para> +X11R&relvers; has support for the mouse driver included in +the new <emphasis remap="bf">wscons</emphasis> console driver. +Specify <quote><filename>wsmouse</filename></quote> as the protocol and +<quote><filename>/dev/wsmouse</filename></quote> as the device in <filename>/etc/X11/xorg.conf</filename> +with a PS/2 or USB mouse. +</para> + +<para> +See <ulink +url="mouse.html" +>README.mouse</ulink +> for general +instruction on mouse configuration. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Running X</title> + +<sect2> +<title>Starting xdm, the display manager</title> + +<para> +To start the display manager, log in as root on the console and type: +<quote><userinput>xdm -nodaemon</userinput></quote>. +</para> + +<para> +You can start xdm automatically on bootup by adding the line: + +<screen> +xdm_flags="" # for normal use: xdm_flags="" +</screen> + +in <filename>/etc/rc.conf.local</filename>. +</para> + +</sect2> + +<sect2> +<title>Running X without the display manager</title> + +<para> +The easiest way for new users to start X windows is to type: <quote><userinput>startx +>& startx.log</userinput></quote>. Error messages are lost unless you redirect them +because the server takes over the screen. +</para> + +<para> +To get out of X windows, type: <quote><userinput>exit</userinput></quote> in the console xterm. +You can customize your X by creating <filename>.xinitrc</filename>, <filename>.xserverrc</filename>, +and <filename>.twmrc</filename> files in your home directory as described in the xinit +and startx man pages. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Kernel Support for X</title> + +<para> +OpenBSD's GENERIC kernels have all support for running X enabled. +</para> + +<sect2> +<title>Console drivers</title> + +<para> +The server supports wscons, the standard OpenBSD/i386 console driver. +</para> + +</sect2> + +<sect2> +<title>Aperture Driver</title> + +<para> +By default OpenBSD includes the BSD 4.4 kernel security +feature that disables access to the <filename>/dev/mem</filename> device when in +multi-user mode. But the X server requires +linear access to the display memory in most cases. +</para> + +<para> +OpenBSD requires the aperture driver to be enabled for all X +servers, because the aperture driver also controls access to the +I/O ports of the video boards. +</para> + +<para> +To enable the aperture driver, once included in the kernel, set + +<screen> +machdep.allowaperture=2 +</screen> + +in <filename>/etc/sysctl.conf</filename>. See the +<ulink +url="http://www.openbsd.org/cgi-bin/man.cgi?query=xf86&apropos=0&sektion=4&manpath=OpenBSD+Current&arch=i386&format=html" +>xf86(4)</ulink +> +manual page for details. +</para> + +<para> +Another (less recommended) way to enable linear memory and I/O ports +access is to disable the kernel security feature by +initializing <varname>securelevel</varname> to -1 +in <filename>/etc/rc.securelevel</filename>. +</para> + +<note><title>Caveat:</title> +<para> +the aperture driver only allows one access at a time +(so that the system is in the same security state once X is +launched). This means that if you run multiple servers on multiple +virtual terminals, only the first one will have linear memory access. +Set <varname>securelevel</varname> to -1 if you need more that one X +server at a time. +</para></note> + +</sect2> + +<sect2> +<title>MIT-SHM</title> + +<para> +OpenBSD supports System V shared memory. If X +detects this support in your kernel, it will support the MIT-SHM +extension. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Rebuilding the X Distribution</title> + +<para> + +Note that OpenBSD project now has its own source tree, +with some local modifications. You may want +to start with this tree to rebuild from sources. The OpenBSD XF4 +source tree is available by anoncvs from all OpenBSD anoncvs +servers. See <ulink url="http://www.openbsd.org/anoncvs.html" +>http://www.openbsd.org/anoncvs.html</ulink> for details on anoncvs. +</para> + +<para> +<anchor id="otherarch" xreflabel="Building on other architectures" /> +</para> + +<para> +X11R&relvers; compiles on most OpenBSD architectures. The X.Org +X server builds and run on the following systems. On other +architectures supported by OpenBSD, only client side libraries and +applications are supported. +</para> + +<sect2> +<title>OpenBSD/alpha</title> + +<para> +The X server is known to work on some VGA cards in alpha +machines that support BWX I/O, with OpenBSD 3.2 and higher. +</para> + +<para> +The following cards have been successfully tested for now: + +<itemizedlist> +<listitem> + +<para> +3DLabs Permedia 2 (8, 15, 16 and 24 bits depth) +</para> +</listitem> +<listitem> + +<para> +ATI Rage Pro (works with 'Option "NoAccel"') +</para> +</listitem> +<listitem> + +<para> +Cirrus Logic CL5430 (works with 'Option "NoAccel"') +</para> +</listitem> +<listitem> + +<para> +Cirrus Logic GD5446 (8, 16 and 24 bits depth) +</para> +</listitem> +<listitem> + +<para> +Matrox MGA 2064 (8, 16 and 24 bits depth) +</para> +</listitem> + +</itemizedlist> + +</para> + +<para> +Note that this version of doesn't work on TGA cards. The +version shipped with OpenBSD 3.1 and higher includes an OS-specific +driver <emphasis>wsfb</emphasis> that is used to support TGA cards. +</para> + +</sect2> + +<sect2> +<title>OpenBSD/macppc</title> + +<para> +The X server is currently known to work on most of the G4 Macs and +iBooks with ATI or nVidia cards. +Other machines are more or less untested. +</para> + +<para> +Use xorgconfig to build a /etc/X11/xorg.conf file before starting +the server for the first time. +</para> + +<para> +For the Titanium Powerbook G4, you can try the following mode line in +<filename>/etc/X11/xorg.conf</filename> to match the flat panel resolution: +</para> + +<para> + +<screen> +Modeline "1152x768" 64.995 1152 1213 1349 1472 768 771 777 806 -HSync -VSync +</screen> + +</para> + +</sect2> + +<sect2> +<title>OpenBSD/sparc</title> + +<para> +OpenBSD 3.2 on sparc switched to the wscons device driver and now uses +the OS specific <emphasis>wsfb</emphasis> driver in the X server. This driver is +not included in X11R&relvers;. Please use the version shipped with +OpenBSD instead. +</para> + +</sect2> + +<sect2> +<title>OpenBSD/sparc64</title> + +<para> +This version only has support PCI based machines using ATI cards on +OpenBSD/sparc64. Note that the version shipped with OpenBSD has +support for the X server on both SBus and UPA (unaccelerated) based cards. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Thanks</title> + +<para> +Many thanks to all people who contributed to make X11R&relvers; work on +*BSD, in particular: +<emphasis remap="bf">David Dawes</emphasis>, +<emphasis remap="bf">Todd Fries</emphasis>, +<emphasis remap="bf">Miodrag Vallat</emphasis>, +<emphasis remap="bf">Rod Grimes</emphasis>, +<emphasis remap="bf">Charles Hannum</emphasis>, +<emphasis remap="bf">Amancio Hasty</emphasis>, +<emphasis remap="bf">Christoph Robitschko</emphasis>, +<emphasis remap="bf">Matthias Scheler</emphasis>, +<emphasis remap="bf">Michael Smith</emphasis>, +<emphasis remap="bf">Ignatios Souvatzis</emphasis>, +<emphasis remap="bf">Jack Velte</emphasis>, +<emphasis remap="bf">Nate Williams</emphasis> and +<emphasis remap="bf">Pace Willison</emphasis>. +</para> + +</sect1> + +</article> diff --git a/sgml/platforms/Solaris.sgml b/general/platforms/Solaris.xml index 3a2b382..0a60a34 100644 --- a/sgml/platforms/Solaris.sgml +++ b/general/platforms/Solaris.xml @@ -1,8 +1,11 @@ -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ -<!ENTITY % defs SYSTEM "X11/defs.ent"> %defs; +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ +<!ENTITY % defs SYSTEM "/xorg-sgml-doctools/X11/defs.ent"> %defs; ]> -<Article> +<article> <!-- Title information --> <articleinfo> @@ -36,138 +39,136 @@ <!-- Table of contents --> <!-- Begin the document --> -<Sect1> -<Title>The VT-switching sub-system in Solaris</Title> +<sect1> +<title>The VT-switching sub-system in Solaris</title> -<Para> +<para> The original virtual terminal sub-system is a undocumented, and unsupported feature of Solaris x86 releases 2.1 through 7. It was removed in Solaris 8 and later releases, and was never present on Solaris SPARC. Support for this version of virtual terminals is only present in Xorg 1.6.x and earlier releases of Xorg, and has been removed in Xorg 1.7 and later. If you use this form of virtual terminals, you do so at -<Emphasis remap="bf">YOUR OWN RISK</Emphasis>. -</Para> +<emphasis remap="bf">YOUR OWN RISK</emphasis>. +</para> -<Para> -A new virtual terminal sub-system has been introduced in OpenSolaris 2010.02 +<para> +A new virtual terminal sub-system has been introduced in Solaris 11 (currently available in pre-release development builds). This version is supported on both SPARC and x86 platforms, though SPARC support is limited to devices with "Coherent Console" support in the kernel frame buffer driver. Support for it is found only in Xorg 1.7 and later releases. -</Para> +</para> -<Para> +<para> When available, the virtual terminals of Solaris work basically the same way as most other VT sub-systems. -</Para> +</para> -</Sect1> +</sect1> -<Sect1> -<Title>Notes for building X11R&relvers; on Solaris</Title> +<sect1> +<title>Notes for building X11R&relvers; on Solaris</title> -<Para> +<para> -<OrderedList> -<ListItem> -<Para> +<orderedlist> +<listitem> +<para> Both GCC, and the Sun Studio compilers are supported by X11R&relvers;. The minimum recommended GCC release is 3.4. Some earlier GCC's are known to not work and should be avoided. -</Para> -<Para> +</para> +<para> You should also make certain your version of GCC predefines `sun'. If needed edit <filename>/usr/local/lib/gcc-lib/*/*/specs</filename>, and modify the -<Literal remap="tt">*predefines:</Literal> line. -</Para> +<literal remap="tt">*predefines:</literal> line. +</para> -</ListItem> -<ListItem> -<Para> +</listitem> +<listitem> +<para> To build X11R&relvers; with GCC you need gcc and (optionally) c++filt from GNU binutils. Don't install gas or ld from GNU binutils, use the one provided by Sun. -</Para> -</ListItem> -<ListItem> -<Para> +</para> +</listitem> +<listitem> +<para> If you are using Sun compilers to compile the X11R&relvers; distribution, you need to modify your PATH appropriately so the Sun compiler tools are available. Normally, they should be in <filename class="directory">/opt/SUNWspro/bin</filename> -</Para> -</ListItem> -<ListItem> -<Para> -You <Emphasis remap="bf">MUST</Emphasis> put +</para> +</listitem> +<listitem> +<para> +You <emphasis remap="bf">MUST</emphasis> put <filename class="directory">/usr/ccs/bin</filename> at the front of your PATH. There are known problems with some GNU replacements for the utilities found there, so the <filename class="directory">/usr/ccs/bin</filename> versions of these programs must be found before any possible GNU versions. (Most notably GNU '<command>ar</command>' does not work during the build). -</Para> -</ListItem> +</para> +</listitem> -</OrderedList> +</orderedlist> -</Para> +</para> -</Sect1> +</sect1> -<Sect1> -<Title>Notes for running Xorg on Solaris</Title> +<sect1> +<title>Notes for running Xorg on Solaris</title> -<Para> +<para> -<OrderedList> -<ListItem> -<Para> +<orderedlist> +<listitem> +<para> Depending on the release or architecture of Solaris you are running, you might need to install an OS driver for an aperture device. -</Para> -<Para> +</para> +<para> Under Solaris x86 2.5 and later, there's a system driver (<filename class="devicefile">/dev/xsvc</filename>) that provides this functionality. It will be detected automatically by the server, so you don't need to install the aperture driver. -</Para> +</para> -<Para> +<para> For older Solaris x86 and for Solaris SPARC releases, the source for this driver is included in <filename>hw/xfree86/os-support/solaris/apSolaris.shar</filename> in the xserver source distribution. Building, and installing the driver is relatively straight forward. Please read its accompanying README file. -</Para> -</ListItem> -<ListItem> -<Para> -Xqueue is <Emphasis remap="bf">NOT</Emphasis> supported under Solaris. -</Para> -</ListItem> +</para> +</listitem> +<listitem> +<para> +Xqueue is <emphasis remap="bf">NOT</emphasis> supported under Solaris. +</para> +</listitem> -</OrderedList> +</orderedlist> -</Para> +</para> -</Sect1> +</sect1> -<Sect1> -<Title>Bug Notification</Title> +<sect1> +<title>Bug Notification</title> -<Para> +<para> Bug reports should be reported at <ulink url="http://bugs.freedesktop.org/"></ulink> using the -xorg product or sent to <EMAIL ->xorg@lists.freedesktop.org</EMAIL ->. -</Para> +xorg product or sent to <email>xorg@lists.freedesktop.org</email>. +</para> -</Sect1> +</sect1> -</Article> +</article> diff --git a/sgml/Makefile.am b/sgml/Makefile.am deleted file mode 100644 index 68fb762..0000000 --- a/sgml/Makefile.am +++ /dev/null @@ -1,23 +0,0 @@ -# Copyright 2005 Red Hat, Inc. -# -# Permission to use, copy, modify, distribute, and sell this software -# and its documentation for any purpose is hereby granted without fee, -# provided that the above copyright notice appear in all copies and -# that both that copyright notice and this permission notice appear in -# supporting documentation, and that the name of Red Hat not be used in -# advertising or publicity pertaining to distribution of the software -# without specific, written prior permission. Red Hat makes no -# representations about the suitability of this software for any -# purpose. It is provided "as is" without express or implied warranty. -# -# RED HAT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, -# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN -# NO EVENT SHALL RED HAT BE LIABLE FOR ANY SPECIAL, INDIRECT OR -# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS -# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE -# OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE -# USE OR PERFORMANCE OF THIS SOFTWARE. -# -# Process this file with autoconf to create configure. - -SUBDIRS = platforms diff --git a/sgml/platforms/Makefile.am b/sgml/platforms/Makefile.am deleted file mode 100644 index 9aebd3c..0000000 --- a/sgml/platforms/Makefile.am +++ /dev/null @@ -1,11 +0,0 @@ -# Process this file with automake to create Makefile.in - -x11docdir = $(docdir)/platforms -SGML_FILES = \ - Darwin.sgml \ - NetBSD.sgml \ - OpenBSD.sgml \ - SCO.sgml \ - Solaris.sgml - -include $(top_srcdir)/sgmlrules.in diff --git a/sgml/platforms/NetBSD.sgml b/sgml/platforms/NetBSD.sgml deleted file mode 100644 index 1faf5f3..0000000 --- a/sgml/platforms/NetBSD.sgml +++ /dev/null @@ -1,797 +0,0 @@ -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ -<!ENTITY % defs SYSTEM "X11/defs.ent"> %defs; -]> - -<Article> - -<articleinfo> - -<Title>README for X11R&relvers; on NetBSD</Title> -<author><firstname>Rich</firstname><surname>Murphey</surname></author> -<author><firstname>David</firstname><surname>Dawes</surname></author> -<author><firstname>Marc</firstname><surname>Wandschneider</surname></author> -<author><firstname>Mark</firstname><surname>Weaver</surname></author> -<author><firstname>Matthieu</firstname><surname>Herrb</surname></author> -</articleinfo> - -<Sect1> -<Title>What and Where is X11R&relvers;?</Title> - -<Para> -X11R&relvers; is an Open Source version of the X Window System that supports -several UNIX(R) and UNIX-like operating systems (such as Linux, the BSDs -and Solaris x86) on Intel and other platforms. This version is compatible -with X11R6.6, and is based on the XFree86 4.4.0RC2 code base, which, -in turn was based on the X consortium sample implementation. -</Para> - -<Para> -See the <ULink URL="../LICENSE.html">Copyright Notice</ULink>. -</Para> - -<![ %notsnapshot [ -<Para> -The sources for X11R&relvers; are available from: -</Para> - -<Para> -<ULink URL="http://wiki.x.org">http://wiki.x.org</ULink> -</Para>]]> - -<Para> -X11R&relvers; also builds on other NetBSD architectures. See section -<XRef LinkEnd="otherarchs"> for details. -</Para> - -</Sect1> - -<Sect1> -<Title>New OS dependent features</Title> - -<![ %haverelnotes [ -<Para> -See the <ULink URL="../RELNOTES.html">Release Notes</ULink> for -non-OS dependent new features in X11R&relvers;. -</Para> -]]> - -<Sect2> -<Title>New OS dependent features in XFree86 4.2.0</Title> - -<Para> - -<ItemizedList> -<ListItem> - -<Para> -Support of client side on NetBSD/sparc64 -</Para> -</ListItem> -<ListItem> - -<Para> -Support for in-kernel MTRR and AGP support in NetBSD 1.5Y -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -</Sect2> - -<Sect2> -<Title>New OS dependent features in XFree86 4.1.0</Title> - -<Para> - -<ItemizedList> -<ListItem> - -<Para> -Enable wide characters support in NetBSD 1.5P and later. -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -</Sect2> - -<Sect2> -<Title>New OS dependent features in XFree86 4.0.2</Title> - -<Para> - -<ItemizedList> -<ListItem> - -<Para> -A fix for libXmu OS detection which was broken since <Literal remap="tt">unix</Literal> -isn't defined anymore by the C preprocessor. -</Para> -</ListItem> -<ListItem> - -<Para> -(limited) native wscons support. This is not activated by -default. -</Para> -</ListItem> -<ListItem> - -<Para> -Updates to the aperture driver -</Para> -</ListItem> -<ListItem> - -<Para> -Support for multithread libraries with GNU pth -</Para> -</ListItem> -<ListItem> - -<Para> -Add <Literal remap="tt">/usr/pkg/bin</Literal> to the default user path. -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -</Sect2> - -<Sect2> -<Title>New OS dependent features in XFree86 4.0.1</Title> - -<Para> - -<ItemizedList> -<ListItem> - -<Para> -Support for NetBSD 1.5_ALPHA -</Para> -</ListItem> -<ListItem> - -<Para> -The Xsun server can be built on NetBSD/sparc -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -</Sect2> - -<Sect2> -<Title>New OS dependent features in XFree86 4.0</Title> - -<Para> - -<ItemizedList> -<ListItem> - -<Para> -Preliminary APM support. -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -</Sect2> - -<Sect2> -<Title>New OS dependent features in XFree86 3.9.18</Title> - -<Para> - -<ItemizedList> -<ListItem> - -<Para> -Soft-booting secondary cards through the int10 BIOS interface is -now possible using the x86emu real mode emulator. -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -</Sect2> - -<Sect2> -<Title>New OS dependent features in XFree86 3.9.17</Title> - -<Para> - -<ItemizedList> -<ListItem> - -<Para> -Support for <Emphasis>silken mouse</Emphasis> with the wsmouse protocol has -been added. -</Para> -</ListItem> -<ListItem> - -<Para> -A new version of the Aperture driver which provides MTRR -support is included. -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -</Sect2> - -</Sect1> - -<!-- -<Sect1> -<Title>Installing the Binaries</Title> - -<Para> -Refer to the <ULink URL="Install.html">Installation Document</ULink> -for detailed installation instructions. -</Para> - -</Sect1> ---> - -<Sect1> -<Title>Configuring X for Your Hardware</Title> - -<Para> -The <Literal remap="tt">/etc/X11/xorg.conf</Literal> file tells the X server what kind of -monitor, -video card and mouse you have, if it cannot determine the information by -probing the hardware. -</Para> - -<Para> -You'll need info on your hardware: - -<ItemizedList> -<ListItem> - -<Para> -Your mouse type, baud rate and its /dev entry. -</Para> -</ListItem> -<ListItem> - -<Para> -The video card's chipset (e.g. ET4000, S3, etc). -</Para> -</ListItem> -<ListItem> - -<Para> -Your monitor's sync frequencies. -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -<Para> -For details about the <Literal remap="tt">xorg.conf</Literal> file format, refer to the -<Emphasis><ULink URL="xorg.conf.5.html">xorg.conf(5)</ULink></Emphasis> manual page. -</Para> - -<Para> -Once you've set up a xorg.conf file, you can fine tune the video -modes with the <Literal remap="tt">xvidtune</Literal> utility. -</Para> - -<Sect2> -<Title>About mouse configuration</Title> - -<Para> -X11R&relvers; has support for the mouse driver included in -the <Emphasis remap="bf">wscons</Emphasis> console driver introduced by NetBSD 1.4. Specify -``<Literal remap="tt">wsmouse</Literal>'' as the protocol and ``<Literal remap="tt">/dev/wsmouse0</Literal>'' as the -device in <Literal remap="tt">/etc/X11/xorg.conf</Literal> if you're using NetBSD 1.4 or later -with a PS/2 mouse. -</Para> - -<Para> -For older releases, the NetBSD <Emphasis remap="bf">pms</Emphasis> mouse driver handles PS/2 style -mice as Busmouse. Specify the protocol as ``<Literal remap="tt">busmouse</Literal>'' in the -mouse section of your <Literal remap="tt">xorg.conf</Literal> file if you're using a PS/2 -mouse with NetBSD 1.3 or former releases. -</Para> - -<Para> -Only standard PS/2 mice are supported by this driver. Newest PS/2 -mice that send more than three bytes at a time (especially -Intellimouse, or MouseMan+ with a wheel) are not supported by NetBSD -1.3 and former releases. -</Para> - -<Para> -See <ULink URL="../mouse.html">README.mouse</ULink> for general -instruction on mouse configuration. -</Para> - -</Sect2> - -</Sect1> - -<Sect1> -<Title>Running X</Title> - -<Para> -The easiest way for new users to start X windows is to type: - -<Screen> -startx >& startx.log -</Screen> - -Error messages are lost unless you redirect them -because the server takes over the screen. -</Para> - -<Para> -To get out of X windows, type: ``<Literal remap="tt">exit</Literal>'' in the console xterm. -You can customize your X by creating <Literal remap="tt">.xinitrc</Literal>, <Literal remap="tt">.xserverrc</Literal>, -and <Literal remap="tt">.twmrc</Literal> files in your home directory as described in the xinit -and startx man pages. -</Para> - -<Sect2> -<Title>Starting Xdm, the display manager</Title> - -<Para> -To start the display manager, log in as root on the console and type: -``<Literal remap="tt">xdm -nodaemon</Literal>''. -</Para> - -<Para> -You can start xdm automatically on bootup by changing the line - -<Screen> -xdm=NO xdm_flags="" # x11 display manager -</Screen> - -to: - -<Screen> -xdm=YES xdm_flags="" # x11 display manager -</Screen> - -in <Literal remap="tt">/etc/rc.conf</Literal>. -</Para> - -<Para> -Under NetBSD 1.4 and later with the wscons console driver, you must -enable a virtual console for the X server first. To do this follow -these steps: - -<ItemizedList> -<ListItem> - -<Para> -Make sure the device file exists. If not, ``<Literal remap="tt">cd /dev ; -./MAKEDEV wscons</Literal>''. -</Para> -</ListItem> -<ListItem> - -<Para> -Next, make sure your kernel wants to do wscons. (see <XRef LinkEnd="wscons">). -</Para> -</ListItem> -<ListItem> - -<Para> -Next, make sure ``<Literal remap="tt">wscons=YES</Literal>'' in -<Literal remap="tt">/etc/rc.conf</Literal>. -</Para> -</ListItem> -<ListItem> - -<Para> -Next, make sure <Literal remap="tt">/etc/wscons.conf</Literal> exists. The relevant -bits: - -<Screen> -#screen 0 - vt100 -screen 1 - vt100 -screen 2 - vt100 -screen 3 - vt100 -screen 4 - - -screen 5 - vt100 -</Screen> - -</Para> -</ListItem> - -</ItemizedList> - -(Thanks to Mason Loring Bliss -<Literal remap="tt"><mason@acheron.middleboro.ma.us></Literal> for this explanation) -</Para> - -</Sect2> - -</Sect1> - -<Sect1> -<Title>Kernel Support for X</Title> - -<Para> -To make sure X support is enabled under NetBSD, the following -line must be in your config file in <Literal remap="tt">/sys/arch/i386/conf</Literal>: -</Para> - -<Para> - -<Screen> -options XSERVER, UCONSOLE -</Screen> - -</Para> - -<Sect2> -<Title>Console drivers</Title> - -<Para> -The server supports the standard NetBSD/i386 -console drivers: pccons, pcvt and wscons (in pcvt compatibility -mode). They are detected at runtime and no -configuration of the server itself is required. -</Para> - -<Para> -The pccons driver is the most widely tested and is the console driver -contained in the NetBSD binary distribution's kernels. -</Para> - -<Para> -The pcvt console driver was bundled with NetBSD until 1.4. The pcvt X -mode is compatible with the pccons driver X mode. It offers several -virtual consoles and international keyboard support. In order to use -this driver, change the line: -</Para> - -<Para> - -<Screen> -device pc0 at isa? port "IO_KBD" irq 1 -</Screen> - -</Para> - -<Para> -to -</Para> - -<Para> - -<Screen> -device vt0 at isa? port "IO_KBD" irq 1 -</Screen> - -</Para> - -<Para> -in your kernel config file, and rebuild and install your kernel. -</Para> - -<Para id="wscons" xreflabel="below"> -Wscons is the current console driver, included in NetBSD 1.4 and -later. For now, X supports wscons using the pcvt compatibility -mode, so be sure to have the lines: - -<Screen> -options WSDISPLAY_COMPAT_PCVT # emulate some ioctls -options WSDISPLAY_COMPAT_SYSCONS # emulate some ioctls -options WSDISPLAY_COMPAT_USL # VT handling -options WSDISPLAY_COMPAT_RAWKBD # can get raw scancodes -</Screen> - -in your kernel configuration file if you're using wscons. Refer to the -<Emphasis>wscons(4)</Emphasis> and <Emphasis>wsmouse(4)</Emphasis> manual pages for -informations on how to configure wscons into the kernel. -</Para> - -</Sect2> - -<Sect2> -<Title>Aperture Driver</Title> - -<Para> -By default NetBSD include the BSD 4.4 kernel security -feature that disable access to the <Literal remap="tt">/dev/mem</Literal> device when in -multi-users mode. But X.Org Foundation X servers can take advantage -(or require) -linear access to the display memory. -</Para> - -<Para> -Most X11R&relvers; card drivers require linear memory access. -There are two ways to allow X to access linear memory: -</Para> - -<Para> -The first way is to disable the kernel security feature by adding -``<Literal remap="tt">option INSECURE</Literal>'' in the kernel configuration file and build a new -kernel. -</Para> - -<Para> -The second way is to install the aperture driver, included in source form in -<Literal remap="tt">xc/programs/Xserver/hw/xfree86/etc/apNetBSD.shar</Literal> in the -X11R6.9 source distribution. Unpack it in a new directory of your -choice by running: - -<Screen> - sh apNetBSD.shar -</Screen> - -By default the aperture driver will be installed in -<Literal remap="tt">/usr/local/aperture</Literal>. You can change this default directory by -editing <Literal remap="tt">Makefile.inc</Literal> before building it. -</Para> - -<Para> -Then run ``<Literal remap="tt">make build</Literal>'' as root to install it. To enable it, -add the following line to <Literal remap="tt">/etc/lkm.conf</Literal>: - -<Screen> -/usr/local/aperture/lkm/xf86.o - - /usr/local/aperture/lkm/xf86_mod_install - - -</Screen> - -and set ``<Literal remap="tt">lkm=YES</Literal>'' in <Literal remap="tt">/etc/rc.conf</Literal> -</Para> - -<Para> -Reboot your system. X will auto-detect the aperture -driver if available. -</Para> - -<Para> -<Emphasis remap="bf">Warning 1:</Emphasis> if you boot another kernel than <Literal remap="tt">/netbsd</Literal>, -loadable kernel modules can crash your system. Always boot in -single user mode when you want to run another kernel. -</Para> - -<Para> -<Emphasis remap="bf">Warning 2:</Emphasis> the aperture driver only allows one access at a time -(so that the system is in the same security state once X is -launched). This means that if you run multiple servers on multiples -VT, only the first one will have linear memory access. -Use ``option INSECURE'' if you need more that one X server at a time. -</Para> - -<Para> -Starting with XFree86 3.9.17, the XFree86 aperture driver -also supports MTRR write combining on Pentiums II -and AMD K6 class processors. -</Para> - -</Sect2> - -<Sect2> -<Title>MIT-SHM</Title> - -<Para> -NetBSD 1.0 and later supports System V shared memory. If X -detects this support in your kernel, it will support the MIT-SHM -extension. -</Para> - -<Para> -To add support for system V shared memory to your kernel add the -lines: -</Para> - -<Para> - -<Screen> - # System V-like IPC - options SYSVMSG - options SYSVSEM - options SYSVSHM -</Screen> - -</Para> - -<Para> -to your kernel config file. -</Para> - -</Sect2> - -</Sect1> - -<Sect1> -<Title>Rebuilding the X Distribution</Title> - -<Para> -You should configure the distribution by editing -<Literal remap="tt">xc/config/cf/host.def</Literal> before compiling. To compile the -sources, invoke ``<Literal remap="tt">make World</Literal>'' in the xc directory. -</Para> - -<Sect2> -<Title>Aperture driver</Title> - -<Para> -To build the X server with the Aperture driver enabled, you -should unpack <Literal remap="tt">apNetBSD.shar</Literal> and install it first. -</Para> - -<Para> -Then edit <Literal remap="tt">xc/config/cf/host.def</Literal> and add the line - -<Screen> -#define HasNetBSDApertureDriver YES -</Screen> - -to it before rebuilding X. -</Para> - -</Sect2> - -<Sect2 id="console-drivers"> -<Title>Console drivers</Title> - -<Para> -X has a configuration option to select the console -drivers to use in <Literal remap="tt">host.def</Literal>: - -<ItemizedList> -<ListItem> - -<Para> - if you're using pccons put: - -<Screen> - #define XFree86ConsoleDefines -DPCCONS_SUPPORT -</Screen> - -</Para> -</ListItem> -<ListItem> - -<Para> -if you're using pcvt put: - -<Screen> - #define XFree86ConsoleDefines -DPCVT_SUPPORT -</Screen> - -</Para> -</ListItem> - -</ItemizedList> - -If you don't define <Emphasis remap="bf">XFree86ConsoleDefines</Emphasis> in <Literal remap="tt">host.def</Literal> the -pccons and pcvt drivers will be supported by default. -</Para> - -<Para> -Experimental native support for the wscons console driver can be built -by adding: - -<Screen> - #define XFree86ConsoleDefines -DWSCONS_SUPPORT -</Screen> - -to <Literal remap="tt">xc/config/host.def</Literal> before rebuilding the server. -This has not been thoroughly tested, except on the macppc. -</Para> - -<Para> -For the i386, you should include both pcvt and wscons support in order -to use the pcvt compatibility mode of wscons: - -<Screen> - #define XFree86ConsoleDefines -DPCVT_SUPPORT -DWSCONS_SUPPORT -</Screen> - -</Para> - -</Sect2> - -<Sect2 id="otherarchs"> -<Title>Building on other architectures</Title> - -<Para> - -Note that the NetBSD project has now its own source tree, based on the -X source tree, with some local modifications. You may want to -start with this tree to rebuild from sources. -The NetBSD xsrc source tree is available at: -<ULink -URL="ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/xsrc/" ->ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/xsrc/</ULink> -</Para> - -</Sect2> - -</Sect1> - -<Sect1> -<Title>Building New X Clients</Title> - -<Para> -The easiest way to build a new client (X application) is to use -<Literal remap="tt">xmkmf</Literal> if an <Literal remap="tt">Imakefile</Literal> is included in the sources. Type -``<Literal remap="tt">xmkmf -a</Literal>'' to create the Makefiles, check the configuration if -necessary and type ``<Literal remap="tt">make</Literal>''. Whenever you install additional man -pages you should update <Literal remap="tt">whatis.db</Literal> by running ``<Literal remap="tt">makewhatis -/usr/X11R6/man</Literal>''. -</Para> - -<Para> -When porting clients to *BSD -systems, make use of the symbol <Emphasis remap="bf">BSD</Emphasis> for code which is truly -BSD-specific. The value of the symbol can be used to distinguish -different BSD releases. For example, code specific to the Net-2 and -later releases can use: -</Para> - -<Para> - -<Screen> - -#if (BSD >= 199103) -</Screen> - -</Para> - -<Para> -To ensure that this symbol is correctly defined, include -<Literal remap="tt"><sys/param.h></Literal> in the source that requires it. Note that -the symbol <Emphasis remap="bf">CSRG_BASED</Emphasis> is defined for *BSD systems in XFree86 3.1.1 -and later. This should be used to protect the inclusion of -<Literal remap="tt"><sys/param.h></Literal>. -</Para> - -<Para> -For code that really is specific to a particular i386 BSD port, use -<Emphasis remap="bf">__FreeBSD__</Emphasis> for FreeBSD, <Emphasis remap="bf">__NetBSD__</Emphasis> for NetBSD, -<Emphasis remap="bf">__OpenBSD__</Emphasis> for OpenBSD, -and <Emphasis remap="bf">__bsdi__</Emphasis> for BSD/386. -</Para> - -</Sect1> - -<Sect1> -<Title>Thanks</Title> - -<Para> -Many thanks to all people who contributed to make XFree86 work on -*BSD, in particular: -<Emphasis remap="bf">David Dawes</Emphasis>, -<Emphasis remap="bf">Todd Fries</Emphasis>, -<Emphasis remap="bf">Rod Grimes</Emphasis>, -<Emphasis remap="bf">Charles Hannum</Emphasis>, -<Emphasis remap="bf">Amancio Hasty</Emphasis>, -<Emphasis remap="bf">Christoph Robitschko</Emphasis>, -<Emphasis remap="bf">Matthias Scheler</Emphasis>, -<Emphasis remap="bf">Michael Smith</Emphasis>, -<Emphasis remap="bf">Ignatios Souvatzis</Emphasis>, -<Emphasis remap="bf">Jack Velte</Emphasis>, -<Emphasis remap="bf">Nate Williams</Emphasis> and -<Emphasis remap="bf">Pace Willison</Emphasis>. -</Para> - -</Sect1> - -</Article> diff --git a/sgml/platforms/OpenBSD.sgml b/sgml/platforms/OpenBSD.sgml deleted file mode 100644 index 1ac6927..0000000 --- a/sgml/platforms/OpenBSD.sgml +++ /dev/null @@ -1,476 +0,0 @@ -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ -<!ENTITY % defs SYSTEM "X11/defs.ent"> %defs; -]> - -<Article> - -<articleinfo> - -<Title>README for X11R&relvers; on OpenBSD</Title> -<AUTHOR -> -<FirstName>Matthieu Herrb</FirstName> -</AUTHOR -> -<pubdate>Last modified on: 4 February 2005.</pubdate> - -</articleinfo> - -<Sect1> -<Title>What and Where is X11R7&relvers;?</Title> - -<Para> -The X.Org Foundation X11R&relvers; is an Open Source version of -the X Window System that supports -several UNIX(R) and UNIX-like operating systems (such as Linux, the BSDs -and Solaris x86) on Intel and other platforms. -</Para> - -<Para> -See the <ULink -URL="../LICENSE.html" ->Copyright Notice</ULink ->. -</Para> - -<Para> -The sources for X11R&relvers; are available from -<ULink -URL="http://wiki.x.org" ->http://wiki.x.org</ULink -> -</Para> - -<Para> -X11R&relvers; builds on most architectures supported by OpenBSD. See section -<XRef LinkEnd="otherarch"> for details. -</Para> - -</Sect1> - -<Sect1> -<Title>Bug Reports for This Document</Title> - -<Para> -Use the X.Org Bugzilla at <ULink -URL="http://bugs.freedesktop.org" ->http://bugs.freedesktop.org</ULink -> -to submit comments or suggestions about this file, using the xorg product. -</Para> - -</Sect1> - -<Sect1> -<Title>New OS dependent features</Title> - -<Para> -See the <ULink -URL="RELNOTES.html" ->Release Notes</ULink -> for -non-OS dependent new features in X11R&relvers;. -</Para> - -<Para> - -<ItemizedList> -<ListItem> - -<Para> -Switch the the Xinput-aware kbd driver for keyboard input -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -<Sect2> -<Title>New OS related features in X.Org 6.8</Title> - -<Para> - -<ItemizedList> -<ListItem> - -<Para> -Support for Propolice in modules. -</Para> -</ListItem> -<ListItem> - -<Para> -Server support for OpenBSD/amd64. -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -</Sect2> - -</Sect1> - -<Sect1> -<Title>Configuring X for Your Hardware</Title> - -<Para> -The <Literal remap="tt">/etc/X11/xorg.conf</Literal> file tells the X server what kind of -monitor, -video card and mouse you have. You <Emphasis>must</Emphasis> create it to tell the -server what specific hardware you have. -</Para> - -<Para> -You'll need info on your hardware: - -<ItemizedList> -<ListItem> - -<Para> -Your mouse type, baud rate and its /dev entry. -</Para> -</ListItem> -<ListItem> - -<Para> -The video card's chipset (e.g. ATI Radeon, nVidia GeForce 4/MX etc). -</Para> -</ListItem> -<ListItem> - -<Para> -Your monitor's sync frequencies. -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -<Para> -The recommended way to generate an <Literal remap="tt">xorg.conf</Literal> file is to use the -<Literal remap="tt">xorgcfg</Literal> utility. The xorgconfig text utility is still there -for the (few) cases where xorgcfg can't be used. Also, there is a -sample file installed as <Literal remap="tt">/usr/X11R6/lib/X11/xorg.conf.eg</Literal>, -which can be used as a starting point. -</Para> - -<Para> -For details about the <Literal remap="tt">xorg.conf</Literal> file format, refer to the -<Emphasis><ULink -URL="xorg.conf.5.html" ->xorg.conf(5)</ULink -></Emphasis> manual page. -</Para> - -<Para> -Once you've set up a xorg.conf file, you can fine tune the video -modes with the <Literal remap="tt">xvidtune</Literal> utility. -</Para> - -<Sect2> -<Title>About mouse configuration</Title> - -<Para> -X11R&relvers; has support for the mouse driver included in -the new <Emphasis remap="bf">wscons</Emphasis> console driver. -Specify ``<Literal remap="tt">wsmouse</Literal>'' as the protocol and -``<Literal remap="tt">/dev/wsmouse</Literal>'' as the device in <Literal remap="tt">/etc/X11/xorg.conf</Literal> -with a PS/2 or USB mouse. -</Para> - -<Para> -See <ULink -URL="mouse.html" ->README.mouse</ULink -> for general -instruction on mouse configuration. -</Para> - -</Sect2> - -</Sect1> - -<Sect1> -<Title>Running X</Title> - -<Sect2> -<Title>Starting xdm, the display manager</Title> - -<Para> -To start the display manager, log in as root on the console and type: -``<Literal remap="tt">xdm -nodaemon</Literal>''. -</Para> - -<Para> -You can start xdm automatically on bootup by adding the line: - -<Screen> -xdm_flags="" # for normal use: xdm_flags="" -</Screen> - -in <Literal remap="tt">/etc/rc.conf.local</Literal>. -</Para> - -</Sect2> - -<Sect2> -<Title>Running X without the display manager</Title> - -<Para> -The easiest way for new users to start X windows is to type: ``<Literal remap="tt">startx ->& startx.log</Literal>''. Error messages are lost unless you redirect them -because the server takes over the screen. -</Para> - -<Para> -To get out of X windows, type: ``<Literal remap="tt">exit</Literal>'' in the console xterm. -You can customize your X by creating <Literal remap="tt">.xinitrc</Literal>, <Literal remap="tt">.xserverrc</Literal>, -and <Literal remap="tt">.twmrc</Literal> files in your home directory as described in the xinit -and startx man pages. -</Para> - -</Sect2> - -</Sect1> - -<Sect1> -<Title>Kernel Support for X</Title> - -<Para> -OpenBSD's GENERIC kernels have all support for running X enabled. -</Para> - -<Sect2> -<Title>Console drivers</Title> - -<Para> -The server supports wscons, the standard OpenBSD/i386 console driver. -</Para> - -</Sect2> - -<Sect2> -<Title>Aperture Driver</Title> - -<Para> -By default OpenBSD includes the BSD 4.4 kernel security -feature that disables access to the <Literal remap="tt">/dev/mem</Literal> device when in -multi-user mode. But the X server requires -linear access to the display memory in most cases. -</Para> - -<Para> -OpenBSD requires the aperture driver to be enabled for all X -servers, because the aperture driver also controls access to the -I/O ports of the video boards. -</Para> - -<Para> -To enable the aperture driver, once included in the kernel, set - -<Screen> -machdep.allowaperture=2 -</Screen> - -in <Literal remap="tt">/etc/sysctl.conf</Literal>. See the -<ULink -URL="http://www.openbsd.org/cgi-bin/man.cgi?query=xf86&apropos=0&sektion=4&manpath=OpenBSD+Current&arch=i386&format=html" ->xf86(4)</ULink -> -manual page for details. -</Para> - -<Para> -Another (less recommended) way to enable linear memory and I/O ports -access is to disable the kernel security feature by -initializing <Literal remap="tt">securelevel</Literal> to -1 in <Literal remap="tt">/etc/rc.securelevel</Literal>. -</Para> - -<Para> -<QUOTE -><Emphasis remap="bf">Caveat:</Emphasis> the aperture driver only allows one access at a time -(so that the system is in the same security state once X is -launched). This means that if you run multiple servers on multiple -virtual terminals, only the first one will have linear memory access. -Set <Literal remap="tt">securelevel</Literal> to -1 if you need more that one X server at a time.</QUOTE -> -</Para> - -</Sect2> - -<Sect2> -<Title>MIT-SHM</Title> - -<Para> -OpenBSD supports System V shared memory. If X -detects this support in your kernel, it will support the MIT-SHM -extension. -</Para> - -</Sect2> - -</Sect1> - -<Sect1> -<Title>Rebuilding the X Distribution</Title> - -<Para> - -Note that OpenBSD project now has its own source tree, -with some local modifications. You may want -to start with this tree to rebuild from sources. The OpenBSD XF4 -source tree is available by anoncvs from all OpenBSD anoncvs -servers. See <ULink -URL="http://www.openbsd.org/anoncvs.html" ->http://www.openbsd.org/anoncvs.html</ULink -> for details on anoncvs. -</Para> - -<Para> -<Anchor id="otherarch" xreflabel="Building on other architectures"> -</Para> - -<Para> -X11R&relvers; compiles on most OpenBSD architectures. The X.Org -X server builds and run on the following systems. On other -architectures supported by OpenBSD, only client side libraries and -applications are supported. -</Para> - -<Sect2> -<Title>OpenBSD/alpha</Title> - -<Para> -The X server is known to work on some VGA cards in alpha -machines that support BWX I/O, with OpenBSD 3.2 and higher. -</Para> - -<Para> -The following cards have been successfully tested for now: - -<ItemizedList> -<ListItem> - -<Para> -3DLabs Permedia 2 (8, 15, 16 and 24 bits depth) -</Para> -</ListItem> -<ListItem> - -<Para> -ATI Rage Pro (works with 'Option "NoAccel"') -</Para> -</ListItem> -<ListItem> - -<Para> -Cirrus Logic CL5430 (works with 'Option "NoAccel"') -</Para> -</ListItem> -<ListItem> - -<Para> -Cirrus Logic GD5446 (8, 16 and 24 bits depth) -</Para> -</ListItem> -<ListItem> - -<Para> -Matrox MGA 2064 (8, 16 and 24 bits depth) -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -<Para> -Note that this version of doesn't work on TGA cards. The -version shipped with OpenBSD 3.1 and higher includes an OS-specific -driver <Emphasis>wsfb</Emphasis> that is used to support TGA cards. -</Para> - -</Sect2> - -<Sect2> -<Title>OpenBSD/macppc</Title> - -<Para> -The X server is currently known to work on most of the G4 Macs and -iBooks with ATI or nVidia cards. -Other machines are more or less untested. -</Para> - -<Para> -Use xorgconfig to build a /etc/X11/xorg.conf file before starting -the server for the first time. -</Para> - -<Para> -For the Titanium Powerbook G4, you can try the following mode line in -<Literal remap="tt">/etc/X11/xorg.conf</Literal> to match the flat panel resolution: -</Para> - -<Para> - -<Screen> -Modeline "1152x768" 64.995 1152 1213 1349 1472 768 771 777 806 -HSync -VSync -</Screen> - -</Para> - -</Sect2> - -<Sect2> -<Title>OpenBSD/sparc</Title> - -<Para> -OpenBSD 3.2 on sparc switched to the wscons device driver and now uses -the OS specific <Emphasis>wsfb</Emphasis> driver in the X server. This driver is -not included in X11R&relvers;. Please use the version shipped with -OpenBSD instead. -</Para> - -</Sect2> - -<Sect2> -<Title>OpenBSD/sparc64</Title> - -<Para> -This version only has support PCI based machines using ATI cards on -OpenBSD/sparc64. Note that the version shipped with OpenBSD has -support for the X server on both SBus and UPA (unaccelerated) based cards. -</Para> - -</Sect2> - -</Sect1> - -<Sect1> -<Title>Thanks</Title> - -<Para> -Many thanks to all people who contributed to make X11R&relvers; work on -*BSD, in particular: -<Emphasis remap="bf">David Dawes</Emphasis>, -<Emphasis remap="bf">Todd Fries</Emphasis>, -<Emphasis remap="bf">Miodrag Vallat</Emphasis>, -<Emphasis remap="bf">Rod Grimes</Emphasis>, -<Emphasis remap="bf">Charles Hannum</Emphasis>, -<Emphasis remap="bf">Amancio Hasty</Emphasis>, -<Emphasis remap="bf">Christoph Robitschko</Emphasis>, -<Emphasis remap="bf">Matthias Scheler</Emphasis>, -<Emphasis remap="bf">Michael Smith</Emphasis>, -<Emphasis remap="bf">Ignatios Souvatzis</Emphasis>, -<Emphasis remap="bf">Jack Velte</Emphasis>, -<Emphasis remap="bf">Nate Williams</Emphasis> and -<Emphasis remap="bf">Pace Willison</Emphasis>. -</Para> - -</Sect1> - -</Article> diff --git a/sgml/platforms/SCO.sgml b/sgml/platforms/SCO.sgml deleted file mode 100644 index e6c59a0..0000000 --- a/sgml/platforms/SCO.sgml +++ /dev/null @@ -1,278 +0,0 @@ -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ -<!ENTITY % defs SYSTEM "X11/defs.ent"> %defs; -]> - -<Article> - -<!-- TitleS information --> - -<articleinfo> - -<Title>Information for SCO OpenServer Users</Title> -<AUTHOR><firstname>J. Kean</firstname><surname>Johnston (jkj@sco.com)</surname></AUTHOR> -<PubDate>1 November 2005</PubDate> - -</articleinfo> - -<!-- Table of contents --> - -<!-- Begin the document --> - -<Sect1> -<Title>Requirements</Title> - -<Para> -Before you can either compile or execute a binary distribution of -X11R&relvers;, the following conditions must be met: - -<ItemizedList> -<ListItem> - -<Para> -Ensure that you are running Release 5.0.4 or later. This is required -because OSS646 is only supported on those platforms. There are no plans -to support X11R&relvers; on earlier releases of OpenServer. -</Para> -</ListItem> -<ListItem> - -<Para> -Ensure that OSS646, the ``Execution Environment Update'' package is -installed, if appropriate. Check the release notes for that update -to see whether or not your current operating system requires this -update. At least version OSS646B is required. If you are running -SCO OpenServer Release 5.0.7, you must have Maintenance Pack 4 installed. -</Para> -</ListItem> -<ListItem> - -<Para> -Ensure that the "Graphics, Web and X11 Libraries" package is -installed. At least version 2.1.0Ba is required. You should always -install the latest possible version of this supplement that is valid -for your operating system release. From time to time this release is -bundled with Maintenance Packs, so if you are running 5.0.7 or later, -the latest version may be in the latest Maintenance Pack. Always check -the release notes for GWXLIBS to see if your platform requires the -update. The latest version can always be found at the -<ULink -URL="ftp://ftp.sco.com/pub/openserver5/opensrc" ->SCO FTP site</ULink ->. -</Para> -</ListItem> -<ListItem> - -<Para> -To compile X11R&relvers;, you must use the SCO-supported version of -the GNU C Compiler. It is possible that Skunkware versions of the -compiler will work too, but this has not been tested. The ``GNU -Development System'' is available for all releases from (and including) -SCO OpenServer Release 5.0.5. It is provided with the operating system -in all versions from Release 5.0.7, although you need to run ``custom'' -to install it from the media. You can always download the latest -latest version of the GNU Development System from the -<ULink -URL="ftp://ftp.sco.com/pub/openserver5/opensrc" ->SCO FTP site</ULink ->. -</Para> -</ListItem> -<ListItem> - -<Para> -If you are not using OSR 5.0.7 or later, you need to get an updated -console driver. See <ULink -URL="http://www.sco.com" ->http://www.sco.com</ULink -> for details on -OpenServer supplements. If you can't or don't want to upgrade your -console driver, X11R&relvers; will still compile, but you may run into -problems with some cards such as the Riva TNT and ATI Rage cards. -The problem with the console driver in 5.0.6A and earlier is that -when the X server sets graphics mode, the driver does not set a -status bit, so any text that is sent directly to <Literal remap="tt">/dev/console</Literal>, -such as kernel warning or notice messages when you access tape drives -or NFS notices, will be sent to the console video memory. This just -happens to be slap bang in the middle of palette data for the Riva -TNT, so you get color map corruption. The updated console driver -also has an improved mechanism for allocating video memory that -X11R&relvers; detects at compile time, and it will use it if it exists. -It is STRONGLY recommended that you get the console driver update. - -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -</Sect1> - -<Sect1> -<Title>Compiling X11R&relvers;</Title> - -<Para> -Using the GNU Development System, compiling the distribution should be fairly -straightforward. Before attempting to compile the system though, you -should make sure that you have met all of the requirements above. -To actually start the compilation, perform the following steps: -</Para> - -<Para> - -<ItemizedList> -<ListItem> - -<Para> -Copy the unmodified <Literal remap="tt">xorgsite.def</Literal> in <Literal remap="tt">xc/config/cf</Literal> -to <Literal remap="tt">host.def</Literal>. Edit <Literal remap="tt">host.def</Literal> and make any changes you -think you need. The most useful options to change are <Literal remap="tt">HasTcl</Literal>, -<Literal remap="tt">HasTk</Literal>, <Literal remap="tt">HasXdmAuth</Literal> if you have the file -<Literal remap="tt">WrapHelp.c</Literal> and <Literal remap="tt">GccWarningOptions</Literal>. Due to the nature -of OpenServer's header files, the default options for this last setting -are a bit aggressive, and I recommend you set this option to -<Literal remap="tt">-Wpointer-arith</Literal>. - -</Para> -</ListItem> -<ListItem> - -<Para> -Make sure that the official version of the GNU Development System -is first in your <Literal remap="tt">PATH</Literal>. The official version lives in -<Literal remap="tt">/usr/gnu/bin</Literal>, and the Skunkware version (if any) lives in -<Literal remap="tt">/usr/local/bin</Literal>. You must ensure that <Literal remap="tt">/usr/gnu/bin</Literal> -appears first in your <Literal remap="tt">PATH</Literal>. - -</Para> -</ListItem> -<ListItem> - -<Para> -Go to the top level of the source tree and execute the command -<Literal remap="tt">CC=gcc make World BOOTSTRAPCFLAGS=-DSCO5 2>&1 | tee world.log</Literal>. -This will do a full build, and send all of the build results to the -file <Literal remap="tt">world.log</Literal>. - -</Para> -</ListItem> -<ListItem> - -<Para> -If the build succeeded, install the new server by executing the -command <Literal remap="tt">make install 2>&1 | tee install.log</Literal> as root. -This will send the install results to the file <Literal remap="tt">install.log</Literal>. - -</Para> -</ListItem> -<ListItem> - -<Para> -If you want to install the manual pages, execute the command -<Literal remap="tt">make install.man 2>&1 | tee -a install.log</Literal> as root. -</Para> -</ListItem> - -</ItemizedList> - -</Para> - -</Sect1> - -<Sect1> -<Title>Before Running X11R&relvers;</Title> - -<Para> -<Anchor id="sec-runxorg"> -</Para> - -<Para> -The SCO <Literal remap="tt">xterm</Literal> terminfo description is not compatible with the <Literal remap="tt">xterm</Literal> -in the R5 distribution. -</Para> - -<Para> -To use a Bus/Keyboard or PS2 mouse you should configure the mouse drivers -using '<Literal remap="tt">mkdev mouse</Literal>'. You may then use the -<Literal remap="tt">OsMouse</Literal> option in your <Literal remap="tt">xorg.conf</Literal> to specify that X -should use the SCO mouse drivers. To do this, set the <Literal remap="tt">Protocol</Literal> to -"<Literal remap="tt">OsMouse</Literal>" in the <Literal remap="tt">Pointer</Literal> section of your -<Literal remap="tt">xorg.conf</Literal> file. You can also use "<Literal remap="tt">OsMouse</Literal>" for your -serial mouse, especially if you are having trouble getting your mouse to -work using the X mouse drivers. -</Para> - -</Sect1> - -<Sect1> -<Title>Switching Consoles</Title> - -<Para> -X11R&relvers; uses similar console switching keys as the SCO R4 and R5 -servers. That is, <Literal remap="tt">Ctrl-PrntScr</Literal> takes you to the next console along -from the one X is running on. If this is the last console it will take -you to console 1. <Literal remap="tt">Ctrl-Alt-FXX</Literal>, where <Literal remap="tt">XX</Literal> is a function -key between <Literal remap="tt">F1</Literal> and <Literal remap="tt">F12</Literal> will switch you to the console -number assigned to that function key. <Literal remap="tt">F1</Literal> corresponds to -<Literal remap="tt">tty01</Literal> (or console 1), <Literal remap="tt">F2</Literal> corresponds to <Literal remap="tt">tty02</Literal> -(or console 2) etc. -</Para> - -<Para> -Unlike the SCO X server, the "kill me now" key is <Literal remap="tt">Alt+Ctrl+Backspace</Literal>. -This does not ask for confirmation, it simply kills the X server as -immediately as possible. Use with extreme caution. This may cause -applications to terminate in an unpredictable way. You can set the -<Literal remap="tt">DontZap</Literal> option in the <Literal remap="tt">ServerFlags</Literal> section of your -<Literal remap="tt">XF86Config</Literal> file to disable this. -</Para> - -</Sect1> - -<Sect1> -<Title>Setting up Man Pages</Title> - -<Para> -After compiling the tree, or after installing the binary distribution you -can get <Literal remap="tt">man</Literal> to recognise the Xorg man pages by adding -<Literal remap="tt">/usr/X11R6/man</Literal> to -the <Literal remap="tt">MANPATH</Literal> in <Literal remap="tt">/etc/default/man</Literal>. The line should -look similar to: - -<Screen> - MANPATH=/usr/man:/usr/gnu/man:/usr/X11R6/man:/usr/local/man -</Screen> - -This allows all users to view the X man pages. You may change your own -<Literal remap="tt">MANPATH</Literal> environment variable if you do not want everyone to access the -man pages. -</Para> - -<Para> -By default the man pages are compressed using ``<Literal remap="tt">compress</Literal>'' to -conserve space. If you do not want to compress the man pages change -<Literal remap="tt">CompressManPages</Literal> to <Literal remap="tt">NO</Literal> in your ``<Literal remap="tt">host.def</Literal>'' -file. Those using the binary distribution can use ``<Literal remap="tt">uncompress</Literal>'' -to uncompress the man pages. Binary distributions contain pre-formatted -versions of all man pages. If you are compiling the server yourself, you -need to have the GNU Tools package installed to get groff, the GNU -nroff replacement, to format the man pages. Use the <Literal remap="tt">manroff</Literal> -script to format the manual pages yourself. -</Para> - -</Sect1> - -<Sect1> -<Title>Using SCO binaries/servers.</Title> - -<Para> -X11R&relvers; will accept connections from SCO binaries (R3 upwards) and the -SCO R5 server will also accept connections from X11R&relvers; binaries. This -means you may mix and match the two if you have ODT. For example you may -still use the Panning Motif window manager (pmwm) if you prefer. -</Para> - -</Sect1> - -</Article> diff --git a/sgmlrules.in b/sgmlrules.in deleted file mode 100644 index 0fa8c4c..0000000 --- a/sgmlrules.in +++ /dev/null @@ -1,64 +0,0 @@ -# Copyright 2005 Red Hat, Inc. -# -# Permission to use, copy, modify, distribute, and sell this software -# and its documentation for any purpose is hereby granted without fee, -# provided that the above copyright notice appear in all copies and -# that both that copyright notice and this permission notice appear in -# supporting documentation, and that the name of Red Hat not be used in -# advertising or publicity pertaining to distribution of the software -# without specific, written prior permission. Red Hat makes no -# representations about the suitability of this software for any -# purpose. It is provided "as is" without express or implied warranty. -# -# RED HAT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, -# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN -# NO EVENT SHALL RED HAT BE LIABLE FOR ANY SPECIAL, INDIRECT OR -# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS -# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE -# OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE -# USE OR PERFORMANCE OF THIS SOFTWARE. -# -# This file is included by Makefile.am in this directory and subdirectories. - -TXT_FILES = $(SGML_FILES:%.sgml=%.txt) -PS_FILES = $(SGML_FILES:%.sgml=%.ps) -PDF_FILES = $(SGML_FILES:%.sgml=%.pdf) -HTML_FILES = $(SGML_FILES:%.sgml=%.html) -INSTALL_FILES = - -SUFFIXES = .sgml .txt .html .ps .pdf - -if ENABLE_DOCS -if BUILD_TXTDOC -INSTALL_FILES += $(TXT_FILES) -.sgml.txt: - @rm -f $@ - $(AM_V_GEN)$(MAKE_TEXT) $< -endif - -if BUILD_PDFDOC -INSTALL_FILES += $(PDF_FILES) -.sgml.pdf: - @rm -f $@ - $(AM_V_GEN)$(MAKE_PDF) $< -endif - -if BUILD_PSDOC -INSTALL_FILES += $(PS_FILES) -.sgml.ps: - @rm -f $@ - $(AM_V_GEN)$(MAKE_PS) $< -endif - -if BUILD_HTMLDOC -INSTALL_FILES += $(HTML_FILES) -.sgml.html: - @rm -f $@ - $(AM_V_GEN)$(MAKE_HTML) -u $< -endif -endif ENABLE_DOCS - -# x11docdir is expected to be defined by the including file. -dist_x11doc_DATA = $(INSTALL_FILES) $(SGML_FILES) - -CLEANFILES = $(TXT_FILES) $(PS_FILES) $(PDF_FILES) $(HTML_FILES) |