summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKeith Packard <keithp@keithp.com>2004-03-29 06:11:51 +0000
committerKeith Packard <keithp@keithp.com>2004-03-29 06:11:51 +0000
commit62b71364780f50b48eb9971f9921fe575762a1bc (patch)
tree65a9847424a37ac19c36f171b101731d5d1ad960
parent3376db05c1e4dfb116bdc942ac18f2d14712008f (diff)
43. Updates to SGML and SGML-generated documentation (Jim Gettys, with
minor hacks by Keith Packard)
-rw-r--r--hw/xfree86/doc/README.DRI6
-rw-r--r--hw/xfree86/doc/README.fonts102
-rw-r--r--hw/xfree86/doc/devel/README.DRIcomp6
-rw-r--r--hw/xfree86/doc/sgml/DESIGN.sgml30
4 files changed, 71 insertions, 73 deletions
diff --git a/hw/xfree86/doc/README.DRI b/hw/xfree86/doc/README.DRI
index e3daac059..3962a0686 100644
--- a/hw/xfree86/doc/README.DRI
+++ b/hw/xfree86/doc/README.DRI
@@ -8,7 +8,7 @@
1.1 Copyright
-Copyright © 2000-2001 by VA Linux Systems, Inc. All Rights Reserved.
+Copyright 2000-2001 by VA Linux Systems, Inc. All Rights Reserved.
Permission is granted to make and distribute verbatim copies of this document
provided the copyright notice and this permission notice are preserved on all
@@ -1251,7 +1251,5 @@ demo programs is available from http://dri.sourceforge.net/res.phtml
o In the future there may be IHV and Linux vendor support resources for
the DRI.
- Generated from XFree86: xc/programs/Xserver/hw/xfree86/doc/sgml/DRI.sgml,v 1.29 dawes Exp $
+ Generated from XFree86: xc/programs/Xserver/hw/xfree86/doc/sgml/DRI.sgml,v 1.28 dawes Exp $
-
-$XFree86: $
diff --git a/hw/xfree86/doc/README.fonts b/hw/xfree86/doc/README.fonts
index ea9628a4b..749419219 100644
--- a/hw/xfree86/doc/README.fonts
+++ b/hw/xfree86/doc/README.fonts
@@ -1,14 +1,16 @@
- Fonts in XFree86
+ Fonts in X11R6.7
- Juliusz Chroboczek, <jch@xfree86.org>
+ Juliusz Chroboczek, <jch@pps.jussieu.fr>
+ Updated by Jim Gettys, <jg@freedesktop.org>
- 17 November 2003
+ 25 March 2004
1. Introduction
-This document describes the support for fonts in XFree86. Installing fonts
+This document describes the support for fonts in X11R6.7. Installing fonts
(section 2., page 1) is aimed at the casual user wishing to install fonts in
-XFree86; the rest of the document describes the font support in more detail.
+X11R6.7 or XFree86; the rest of the document describes the font support in
+more detail.
We assume some familiarity with digital fonts. If anything is not clear to
you, please consult Appendix: Background (section 5., page 1) at the end of
@@ -16,10 +18,10 @@ this document for background information.
1.1 Two font systems
-XFree86 includes two font systems: the core X11 fonts system, which is
-present in all implementations of X11, and the Xft fonts system, which is not
-currently distributed with implementations of X11 that are not based on
-XFree86 but will hopefully be included by them in the future
+X includes two font systems: the original core X11 fonts system, which is
+present in all implementations of X11, and the Xft fonts system, which may
+not be distributed with implementations of X11 that are not based on X116.7.0
+but will hopefully be included by them in the future
The core X11 fonts system is directly derived from the fonts system included
with X11R1 in 1987, which could only use monochrome bitmap fonts. Over the
@@ -36,7 +38,7 @@ ments with embedded fonts.
Xft is not compatible with the core fonts system: usage of Xft requires mak-
ing fairly extensive changes to toolkits (user-interface libraries). While
-XFree86 will continue to maintain the core fonts system, toolkit authors are
+X.org will continue to maintain the core fonts system, toolkit authors are
encouraged to switch to Xft as soon as possible.
2. Installing fonts
@@ -48,13 +50,13 @@ access newly-installed fonts.
Xft has no configuration mechanism itself, rather it relies upon the fontcon-
fig library to configure and customize fonts. That library is not specific
-to XFree86 or indeed on any particular font output mechanism. This discus-
+to X11R6.7.0 or indeed on any particular font output mechanism. This discus-
sion describes how fontconfig, rather than Xft, works.
2.1.1 Installing fonts in Xft
Fontconfig looks for fonts in a set of well-known directories that include
-all of XFree86's standard font directories (`/usr/X11R6/lib/X11/lib/fonts/*')
+all of X11R6.7's standard font directories (`/usr/X11R6/lib/X11/lib/fonts/*')
by default) as well as a directory called `.fonts/' in the user's home direc-
tory. Installing a font for use by Xft applications is as simple as copying
a font file into one of these directories.
@@ -114,9 +116,9 @@ Anti-aliasing can be disabled for all fonts by the following incantation:
</edit>
</match>
-Xft supports sub-pixel rasterisation on LCD displays. XFree86 should auto-
-matically enable this feature on laptops and when using an LCD monitor con-
-nected with a DVI cable; you can check whether this was done by typing
+Xft supports sub-pixel rasterisation on LCD displays. X11R67 should automat-
+ically enable this feature on laptops and when using an LCD monitor connected
+with a DVI cable; you can check whether this was done by typing
$ xdpyinfo -ext RENDER | grep sub-pixel
@@ -167,10 +169,10 @@ disabled by your Xft configuration file.
2.1.4 Troubleshooting
If some Xft-based applications don't seem to notice the changes you are mak-
-ing to your configuration files, they may be linked against the XFree86 4.2
-version of Xft. In order to fix the problem, you should relink them against
-a current version of Xft; on most systems, it is enough to install the cur-
-rent version of the Xft and Fontconfig libraries.
+ing to your configuration files, they may be linked against an old version of
+Xft. In order to fix the problem, you should relink them against a current
+version of Xft; on most systems, it is enough to install the current version
+of the Xft and Fontconfig libraries.
If, for some reason, you cannot upgrade the shared libraries, please check
the Xft(3) manual page included with XFree86 4.2 for the configuration mecha-
@@ -185,8 +187,8 @@ of this new directory by including it in the font path.
2.2.1 Installing bitmap fonts
-The XFree86 server can use bitmap fonts in both the cross-platform BDF format
-and the somewhat more efficient binary PCF format. (XFree86 also supports
+The X11R6.7 server can use bitmap fonts in both the cross-platform BDF format
+and the somewhat more efficient binary PCF format. (X11R6.7 also supports
the obsolete SNF format.)
Bitmap fonts are normally distributed in the BDF format. Before installing
@@ -215,7 +217,7 @@ directory; see Setting the server font path (section 2.2.4, page 1) below.
2.2.2 Installing scalable fonts
-The XFree86 server supports scalable fonts in four formats: Type 1, Speedo,
+The X11R6.7 server supports scalable fonts in four formats: Type 1, Speedo,
TrueType and CIDFont. This section only applies to the former three; for
information on CIDFonts, please see Installing CIDFonts (section 2.2.3, page
1) later in this document.
@@ -251,7 +253,7 @@ CMap `UniKS-UCS2-H' is called
Munhwa-Regular--UniKS-UCS2-H
-The CIDFont code in XFree86 requires a very rigid directory structure. The
+The CIDFont code in X11R6.7 requires a very rigid directory structure. The
main directory must be called `CID' (its location defaults to
`/usr/X11R6/lib/X11/fonts/CID' but it may be located anywhere), and it should
contain a subdirectory for every CID collection. Every subdirectory must
@@ -310,7 +312,7 @@ For best results, scalable fonts should appear in the font path before the
bitmap fonts; this way, the server will prefer bitmap fonts to scalable fonts
when an exact match is possible, but will avoid scaling bitmap fonts when a
scalable font can be used. (The `:unscaled' hack, while still supported,
-should no longer be necessary in XFree86 4.0 and later.)
+should no longer be necessary in X11R6.7.0.)
You may check the font path of the running server by typing the command
@@ -334,15 +336,15 @@ For more information, please consult the xset(1) manual page.
2.2.4.2 Permanent modification of the font path
The default font path (the one used just after server startup or after `xset
-fp default') is specified in the X server's `XF86Config' file. It is com-
-puted by appending all the directories mentioned in the `FontPath' entries of
-the `Files' section in the order in which they appear.
+fp default') is specified in the X server's `xorg.conf' file. It is computed
+by appending all the directories mentioned in the `FontPath' entries of the
+`Files' section in the order in which they appear.
FontPath "/usr/local/fonts/Type1"
...
FontPath "/usr/local/fonts/bitmap"
-For more information, please consult the XF86Config(5) manual page.
+For more information, please consult the xorg.conf(5) manual page.
2.2.5 Troubleshooting
@@ -353,19 +355,19 @@ mounted font directories). If this doesn't help, it is quite possible that
you are trying to use a font in a format that is not supported by your
server.
-XFree86 supports the BDF, PCF, SNF, Type 1, Speedo, TrueType, OpenType and
-CIDFont font formats. However, not all XFree86 servers come with all the
-font backends configured in.
+X11R6.7 supports the BDF, PCF, SNF, Type 1, Speedo, TrueType, OpenType and
+CIDFont font formats. However, not all X11R6.7 or XFree86 servers come with
+all the font backends configured in.
-On most platforms, the XFree86 servers are modular: the font backends are
+On most platforms, the X11R6.7 servers are modular: the font backends are
included in modules that are loaded at runtime. The modules to be loaded are
-specified in the `XF86Config' file using the `Load' directive:
+specified in the `xorg.conf' file using the `Load' directive:
Load "type1"
If you have trouble installing fonts in a specific format, you may want to
check the server's log file in order to see whether the relevant modules are
-properly loaded. The list of font modules distributed with XFree86 is as
+properly loaded. The list of font modules distributed with X11R6.7 is as
follows:
o "bitmap": bitmap fonts (`*.bdf', `*.pcf' and `*.snf');
@@ -382,7 +384,7 @@ follows:
Please note that the argument of the `Load' directive is case-sensitive.
-3. Fonts included with XFree86
+3. Fonts included with X11R6.7
3.1 Standard bitmap fonts
@@ -391,7 +393,7 @@ fonts, including the `fixed' family, and bitmap versions of Courier, Times,
Helvetica and some members of the Lucida family. In the SI, these fonts are
provided in the ISO 8859-1 encoding (ISO Latin Western-European).
-In XFree86, a number of these fonts are provided in Unicode-encoded font
+In X11R6.7, a number of these fonts are provided in Unicode-encoded font
files instead. At build time, these fonts are split into font files encoded
according to legacy encodings, a process which allows us to provide the stan-
dard fonts in a number of regional encodings with no duplication of work.
@@ -469,7 +471,7 @@ for improved presentation of text.
3.3 Standard scalable fonts
-XFree86 includes all the scalable fonts distributed with X11R6.
+X11R6.7 includes all the scalable fonts distributed with X11R6.
3.3.1 Standard Type 1 fonts
@@ -491,7 +493,7 @@ and reside in the font files
/usr/X11R6/lib/X11/fonts/Type1/UT*.pfa
-Finally, XFree86 also comes with Type 1 versions of Bitstream Courier and
+Finally, X11R6.7 also comes with Type 1 versions of Bitstream Courier and
Charter. These fonts have XLFD
-bitstream-courier-*-*-normal--0-0-0-0-m-0-iso8859-1
@@ -503,7 +505,7 @@ and reside in the font files
3.3.2 Standard Speedo fonts
-XFree86 includes Speedo versions of the Bitstream Courier and Charter fonts.
+X11R6.7 includes Speedo versions of the Bitstream Courier and Charter fonts.
In order to use these fonts, you should ensure that your X server is loading
the `Speedo' font backend; see Troubleshooting (section 2.2.5, page 1).
@@ -519,7 +521,7 @@ and reside in the font files
3.4 The Bigelow & Holmes Luxi family
-XFree86 includes the Luxi family of scalable fonts, in both TrueType and
+X11R6.7 includes the Luxi family of scalable fonts, in both TrueType and
Type 1 format. This family consists of the fonts Luxi Serif, with XLFD
-b&h-luxi serif-medium-*-normal--*-*-*-*-p-*-*-*
@@ -565,11 +567,11 @@ For more information, please contact <design@bigelowandholmes.com> or
An earlier version of the Luxi fonts was made available under the name
Lucidux. This name should no longer be used due to trademark uncertainties,
-and all traces of the Lucidux name have been removed from XFree86.
+and all traces of the Lucidux name have been removed from X11R6.7.
4. More about core fonts
-This section describes XFree86-specific enhancements to the core X11 fonts
+This section describes X11R6.7-specific enhancements to the core X11 fonts
system.
4.1 Core fonts and internationalisation
@@ -655,7 +657,7 @@ option followed by the name of a directory containing encoding files, can be
used to automatically build `encodings.dir' files. Please see the mkfont-
dir(1) manual page for more details.
-A number of encoding files for common encodings are included with XFree86.
+A number of encoding files for common encodings are included with X11R6.7.
Information on writing new encoding files can be found in Format of encodings
directory files (section 4.1.3, page 1) and Format of encoding files (section
4.1.4, page 1) later in this document.
@@ -991,7 +993,7 @@ ings, but instead uses its own database of encodings.
Since the functionalities for CJKV support introduced by X-TT have been
merged into the new FreeType backend, the X-TT backend will be removed from
-XFree86's tree near the future. Therefore, the use of FreeType backend is
+X11R6.7's tree near the future. Therefore, the use of FreeType backend is
preferred over the X-TT backend.
General information on X-TrueType may be found at the After X-TT Project page
@@ -1138,16 +1140,16 @@ last two fields of their XLFD set to `iso10646-1'.
6. References
-XFree86 comes with extensive documentation in the form of manual pages and
+X11R6.7 comes with extensive documentation in the form of manual pages and
typeset documents. Before installing fonts, you really should read the font-
config(3) and mkfontdir(1) manual pages; other manual pages of interest
include X(7), Xserver(1), xset(1), Xft(3), xlsfonts(1) and showfont(1). In
addition, you may want to read the X Logical Font Description document, by
Jim Flowers, which is provided in the file `xc/doc/xlfd.PS.Z'.
-The latest released version of the XFree86 documentation (including this doc-
-ument and all manual pages) is available as current XFree86 documentation
-<URL:http://www.xfree86.org/current/>.
+The latest released version of the X11R6.7 documentation (including this doc-
+ument and all manual pages) can be found from current X11R6.7 documentation
+<URL:http://wiki.x.org/>.
The comp.fonts FAQ <URL:http://www.netmeg.net/faq/computers/fonts/>, which is
unfortunately no longer being maintained, contains a wealth of information
@@ -1181,7 +1183,5 @@ The IANA RFC documents, available from a number of sites throughout the
world, often provide interesting information about character set issues; see
for example RFC 373.
- Generated from XFree86: xc/programs/Xserver/hw/xfree86/doc/sgml/fonts.sgml,v 1.24 dawes Exp $
+ Based on Generated from XFree86: xc/programs/Xserver/hw/xfree86/doc/sgml/fonts.sgml,v 1.23 dawes Exp $. Updated by Jim Gettys.
-
-$XFree86: $
diff --git a/hw/xfree86/doc/devel/README.DRIcomp b/hw/xfree86/doc/devel/README.DRIcomp
index 7dab2b108..aafbd4237 100644
--- a/hw/xfree86/doc/devel/README.DRIcomp
+++ b/hw/xfree86/doc/devel/README.DRIcomp
@@ -8,7 +8,7 @@
1.1 Copyright
-Copyright © 2000-2001 by VA Linux Systems, Inc. All Rights Reserved.
+Copyright 2000-2001 by VA Linux Systems, Inc. All Rights Reserved.
Permission is granted to make and distribute verbatim copies of this document
provided the copyright notice and this permission notice are preserved on all
@@ -551,7 +551,5 @@ At this point your X server should be up and running with hardware-acceler-
ated direct rendering. Please read the DRI User Guide for information about
trouble shooting and how to use the DRI-enabled X server for 3D applications.
- Generated from XFree86: xc/programs/Xserver/hw/xfree86/doc/sgml/DRIcomp.sgml,v 1.20 dawes Exp $
+ Generated from XFree86: xc/programs/Xserver/hw/xfree86/doc/sgml/DRIcomp.sgml,v 1.19 dawes Exp $
-
-$XFree86: $
diff --git a/hw/xfree86/doc/sgml/DESIGN.sgml b/hw/xfree86/doc/sgml/DESIGN.sgml
index 0478a0598..84e4fad21 100644
--- a/hw/xfree86/doc/sgml/DESIGN.sgml
+++ b/hw/xfree86/doc/sgml/DESIGN.sgml
@@ -1,4 +1,5 @@
-<!DOCTYPE linuxdoc PUBLIC "-//XFree86//DTD linuxdoc//EN" [
+<!DOCTYPE linuxdoc PUBLIC "-//Xorg//DTD linuxdoc//EN" [
+ <!ENTITY % defs SYSTEM "defs.ent"> %defs;
<!-- config file keyword markup -->
<!ENTITY s.key STARTTAG "bf">
<!ENTITY e.key ENDTAG "bf">
@@ -27,6 +28,7 @@
<title>XFree86 server 4.x Design (DRAFT)
<author>The XFree86 Project, Inc
+<and>Updates for X11R&relvers; by Jim Gettys
<date>19 December 2003
@@ -79,10 +81,10 @@ The broad design principles are:
Unless we find major deficiencies in the DIX layer, we should avoid
making changes there.
-<sect>The XF86Config File
+<sect>The xorg.conf File
<p>
-The XF86Config file format is similar to the old format, with the following
+The xorg.conf file format is similar to the old format, with the following
changes:
<sect1>&k.device; section
@@ -315,7 +317,7 @@ the XFree86 common layer:
<tag>PreInit</tag>
- Process information from the XF86Config file, determine the
+ Process information from the xorg.conf file, determine the
full characteristics of the hardware, and determine if a valid
configuration is present.
</descrip>
@@ -426,12 +428,12 @@ control. &s.code;InitOutput()&e.code; is expected to fill in the global
&s.code;screenInfo.screen[]&e.code; entry for each screen present. Here
is what &s.code;InitOutput()&e.code; does:
-<sect1>Parse the XF86Config file
+<sect1>Parse the xorg.conf file
<p>
This is done at the start of the first server generation only.
- The XF86Config file is read in full, and the resulting information
+ The xorg.conf file is read in full, and the resulting information
stored in data structures. None of the parsed information is
processed at this point. The parser data structures are opaque to
the video drivers and to most of the common layer code.
@@ -595,7 +597,7 @@ is what &s.code;InitOutput()&e.code; does:
&s.code;PROBE_DETECT&e.code; is used if "-configure" or "-probe"
command line arguments are given and indicates to the
&s.code;Probe()&e.code; function that it should not configure the
- bus entities and that no XF86Config information is available.
+ bus entities and that no xorg.conf information is available.
The probe must find the active device sections that match the
driver by calling &s.code;xf86MatchDevice()&e.code;. The number
@@ -746,7 +748,7 @@ is what &s.code;InitOutput()&e.code; does:
After the Probe phase is finished, there will be some number of
&s.code;ScrnInfoRecs&e.code;. These are then matched with the active
- &k.screen; sections in the XF86Config, and those not having an active
+ &k.screen; sections in the xorg.conf, and those not having an active
&k.screen; section are deleted. If the number of remaining screens
is 0, &s.code;InitOutput()&e.code; sets
&s.code;screenInfo.numScreens&e.code; to &s.code;0&e.code; and
@@ -1294,10 +1296,10 @@ The function should not modify any other mode field, unless it wants to modify
the mode timings reported to the user by &s.code;xf86PrintModes()&e.code;.
<p>
-The function is called once for every mode in the XF86Config Monitor section
+The function is called once for every mode in the xorg.conf Monitor section
assigned to the screen, with &s.code;flags&e.code; set to
&s.code;MODECHECK_INITIAL&e.code;. It is subsequently called for every mode
-in the XF86Config Display subsection assigned to the screen, with
+in the xorg.conf Display subsection assigned to the screen, with
&s.code;flags&e.code; set to &s.code;MODECHECK_FINAL&e.code;. In the second
case, the mode will have successfully passed all other tests. In addition,
the &s.code;ScrnInfoRec&e.code;'s &s.code;virtualX&e.code;,
@@ -1866,7 +1868,7 @@ creates an entity record for each of them, registers non-relocatable
resources and allocates screens and adds the resources to screens.
Two helper functions are provided for matching device sections in the
-XF86Config file to the devices:
+xorg.conf file to the devices:
<quote><p>
&s.code;int xf86MatchPciInstances(const char *driverName, int vendorID,
@@ -5271,7 +5273,7 @@ be catered for the by the helpers.
<quote>Allow halved clocks</quote>
&s.code;LOOKUP_OPTIONAL_TOLERANCES&e.code;
<quote>Allow missing horizontal sync and/or vertical refresh
- ranges in the XF86Config Monitor section</quote>
+ ranges in the xorg.conf Monitor section</quote>
&s.code;LOOKUP_OPTIONAL_TOLERANCES&e.code; should only be
specified when the driver can ensure all modes it generates
@@ -5291,7 +5293,7 @@ be catered for the by the helpers.
&s.code;progClock&e.code;
<quote>Whether the clock is programmable or not</quote>
&s.code;monitor&e.code;
- <quote>Pointer to the applicable XF86Config monitor section</quote>
+ <quote>Pointer to the applicable xorg.conf monitor section</quote>
&s.code;fdFormat&e.code;
<quote>Format of the screen buffer</quote>
&s.code;videoRam&e.code;
@@ -6731,7 +6733,7 @@ ZZZProbe(DriverPtr drv, int flags)
Define the &s.code;AvailableOptions()&e.code; function. The purpose
of this is to return the available driver options back to the
- -configure option, so that an XF86Config file can be built and the
+ -configure option, so that an xorg.conf file can be built and the
user can see which options are available for them to use.
<sect2>PreInit