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 /general/platforms | |
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>
Diffstat (limited to 'general/platforms')
-rw-r--r-- | general/platforms/Darwin.xml | 42 | ||||
-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 | 174 |
5 files changed, 1492 insertions, 0 deletions
diff --git a/general/platforms/Darwin.xml b/general/platforms/Darwin.xml new file mode 100644 index 0000000..552eee0 --- /dev/null +++ b/general/platforms/Darwin.xml @@ -0,0 +1,42 @@ +<?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>X.Org X11R&relvers; on Darwin and Mac OS X</title> + <pubdate>October 2009</pubdate> + + </articleinfo> + + <sect1> + <title>Introduction</title> + + <para> + <productname>X11R&relvers;</productname>, a freely + redistributable open-source implementation of the + <ulink url="http://www.x.org/">X Window System</ulink> from + the <ulink url="http://www.x.org/wiki/XorgFoundation">X.Org + Foundation</ulink>, has been ported to + <ulink url="http://developer.apple.com/Darwin/">Darwin</ulink> + and <ulink url="http://www.apple.com/macosx/">Mac OS X</ulink>. + </para> + + <para> + Most of the current work on X for Darwin and Mac OS X is + centered around the + <ulink url="http://xquartz.macosforge.org/">XQuartz Project</ulink> + at <ulink url="http://macosforge.org/">MacOSforge</ulink>. + If you are interested in up-to-date status, want to report a bug, + or are interested in working on X11 for Darwin, stop by the project + website at <ulink url="http://xquartz.macosforge.org/"></ulink> + </para> + + </sect1> + +</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/general/platforms/Solaris.xml b/general/platforms/Solaris.xml new file mode 100644 index 0000000..0a60a34 --- /dev/null +++ b/general/platforms/Solaris.xml @@ -0,0 +1,174 @@ +<?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> + +<!-- Title information --> +<articleinfo> + + <title>X Window System support for <trademark>Solaris</trademark> & + <trademark>OpenSolaris</trademark> from X.Org + </title> + <authorgroup> + <author> + <firstname>David</firstname><surname>Holland</surname> + <affiliation><orgname><ulink url="http://www.xfree86.org/">XFree86 + Project</ulink></orgname></affiliation> + </author> + + <author> + <firstname>Marc</firstname><surname>Aurele La France</surname> + <affiliation><orgname><ulink url="http://www.xfree86.org/">XFree86 + Project</ulink></orgname></affiliation> + </author> + + <author> + <firstname>Alan</firstname><surname>Coopersmith</surname> + <affiliation><orgname><ulink url="http://www.sun.com/">Sun + Microsystems, Inc.</ulink></orgname></affiliation> + </author> + </authorgroup> + + <date>2009 September 16</date> +</articleinfo> + +<!-- Table of contents --> + +<!-- Begin the document --> +<sect1> +<title>The VT-switching sub-system in Solaris</title> + +<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> + +<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> +When available, the virtual terminals of Solaris work basically the same way as +most other VT sub-systems. +</para> + +</sect1> + +<sect1> +<title>Notes for building X11R&relvers; on Solaris</title> + +<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> +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> + +</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> +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 +<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> + +</orderedlist> + +</para> + +</sect1> + +<sect1> +<title>Notes for running Xorg on Solaris</title> + +<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> +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> +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> + +</orderedlist> + +</para> + +</sect1> + + +<sect1> +<title>Bug Notification</title> + +<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> + +</sect1> + +</article> |