<?xml version="1.0" encoding="UTF-8" ?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % defs SYSTEM "defs.ent"> %defs;
]>
-<article id="fsproto">
+<book id="fsproto">
-<articleinfo>
+<bookinfo>
<title>The X Font Service Protocol</title>
<subtitle>X Consortium Standard</subtitle>
<releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo>
notice appear in all copies. Network Computing Devices, Inc.
makes no representations about the suitability for any purpose
of the information in this document. This documentation is
-provided "as is" without express or implied warranty.
+provided “as is” without express or implied warranty.
</para>
</legalnotice>
<para role="multiLicensing">Copyright © 1994 X Consortium</para>
<para>
Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
+of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
in this Software without prior written authorization from the X Consortium.
</para>
</legalnotice>
-</articleinfo>
+</bookinfo>
-<sect1 id='Introduction'>
+<chapter id='Introduction'>
<title>Introduction</title>
<para>
The management of fonts in large, heterogeneous environments is one of the
hardest aspects of using the X Window System
-<footnote><para>
-<emphasis remap='I'>X Window System</emphasis>
+<footnote
id='footnote1'><para>
+<firstterm><trademark>X Window System</trademark></firstterm>
is a trademark of The Open Group.
</para></footnote>
. Multiple formats and the lack of
reached on new features (particularly outline font support).
</para>
<para>
-Currently, most X displays use network file protocols such as NFS and TFTP to
+Currently, most X displays use network file protocols such as
+<acronym>NFS</acronym> and <acronym>TFTP</acronym> to
obtain raw font data which they parse directly. Since a common binary format
for this data doesn't exist, displays must be able to interpret a variety of
formats if they are to be used with different application hosts. This leads to
designed to allow subsets of the font data to be requested, displays may easily
implement a variety of strategies for fine-grained demand-loading of glyphs.
</para>
-</sect1>
+</chapter>
-<sect1 id='Architectural_Model'>
+<chapter id='Architectural_Model'>
<title>Architectural Model</title>
<!-- .XS -->
<!-- (SN Architectural Model -->
<!-- .XE -->
<para>
-<!-- .LP -->
-In this document, the words "client" and "server" refer to the consumer and
+In this document, the words <firstterm>client</firstterm> and
+<firstterm>server</firstterm> refer to the consumer and
provider of a font, respectively, unless otherwise indicated. It is important
to note that in this context, the X server is also a font client.
</para>
as printer drivers).
</para>
+<figure id="figure2.1" label="2.1"><title>Connecting to a Font Server</title>
<literallayout class="monospaced">
┌────────┐ ┌───────────────┐
│ X1 ├──────────────┤ │
│ clients ├──────┘
└─────────┘
</literallayout>
+</figure>
<para>
-Figure 2.1: Connecting to a Font Server
-</para>
-
-<para>
-<!-- .LP -->
Clients communicate with the font server using the request/reply/event model
-over any mutually-understood virtual stream connection (such as TCP/IP, DECnet,
-<footnote><para>
-DECnet is a trademark of Digital Equipment Corporation.
+over any mutually-understood virtual stream connection (such as
+<acronym>TCP/IP</acronym>, DECnet,
+<footnote id='footnote2'><para>
+<firstterm><trademark>DECnet</trademark></firstterm> is a trademark
+of Digital Equipment Corporation.
</para></footnote>
etc.). Font servers are responsible for providing data in the bit and byte
orders requested by the client. The set of requests and events provided in the
as new needs evolve.
</para>
<para>
-<!-- .LP -->
A font server reads raw font data from a variety of sources (possibly
including other font servers) and converts it into a common format that is
-transmitted to the client using the protocol described in Section 4. New font
+transmitted to the client using the protocol described in
+<link linkend='Protocol'>Section 4</link>. New font
formats are handled by adding new converters to a font server, as shown in
Figure 2.2.
</para>
+<figure id="figure2.2" label="2.2"><title>Where Font Data Comes From</title>
<literallayout class="monospaced">
┌────────────┐
│ client │
│ server 2 │
└──────────┘
</literallayout>
+</figure>
<para>
-Figure 2.2: Where Font Data Comes From
-</para>
-
-<para>
-The server may choose to provide named sets of fonts called "catalogues."
+The server may choose to provide named sets of fonts called
+<firstterm>catalogues</firstterm>.
Clients may specify which of the sets should be used in listing or opening a
font.
</para>
</para>
<para>
-<!-- .LP -->
Clients may provide authorization data for the server to be used in determining
(according to the server's licensing policy) whether or not access should be
granted to particular fonts. This is particularly useful for clients whose
identity of the user).
</para>
<para>
-<!-- .LP -->
Implementations that wish to provide additional requests or events may use the
extension mechanism. Adding to the core font service protocol (with the
accompanying change in the major or minor version numbers) is reserved to the X
Consortium.
</para>
-</sect1>
+</chapter>
-<sect1 id='Font_Server_Naming'>
+<chapter id='Font_Server_Naming'>
<title>Font Server Naming</title>
<!-- .XS -->
<!-- (SN Font Server Naming -->
X Consortium.
</para>
-<sect2 id='TCPIP_Names'>
+<section id='TCPIP_Names'>
<title>TCP/IP Names</title>
<!-- .XS -->
<!-- (SN TCP/IP Names -->
<!-- .XE -->
<para>
The following syntax should be used for TCP/IP names:
-</para>
<literallayout class="monospaced">
- <TCP name> ::= "tcp/" <hostname>":" <ipportnumber> ["/" <cataloguelist>]
+ <replaceable>TCP name</replaceable> ::= <literal>tcp/</literal> <replaceable>hostname</replaceable> <literal>:</literal> <replaceable>ipportnumber</replaceable> <optional><literal>/</literal> <replaceable>cataloguelist</replaceable></optional>
</literallayout>
-<para>
-where <hostname> is either symbolic (such as expo.lcs.mit.edu) or numeric
-decimal (such as 18.30.0.212). The <ipportnumber> is the port on
-which the
-font server is listening for connections. The <cataloguelist> string at
+where <replaceable>hostname</replaceable> is either symbolic (such as
+<systemitem class="systemname">expo.lcs.mit.edu</systemitem>) or numeric
+decimal (such as <systemitem class="ipaddress">18.30.0.212</systemitem>).
+The <replaceable>ipportnumber</replaceable> is the port on which the
+font server is listening for connections.
+The <replaceable>cataloguelist</replaceable> string at
the end is optional and specifies a plus-separated list of catalogues
that may be requested. For example:
-</para>
<literallayout class="monospaced">
tcp/expo.lcs.mit.edu:8012/available+special
tcp/18.30.0.212:7890
</literallayout>
-</sect2>
+</para>
+</section>
-<sect2 id='DECnet_Names'>
+<section id='DECnet_Names'>
<title>DECnet Names</title>
<!-- .XS -->
<!-- (SN DECnet Names -->
<!-- .XE -->
<para>
-<!-- .LP -->
The following syntax should be used for DECnet names:
-</para>
+
<literallayout class="monospaced">
- <DECnet name> ::= "decnet/" <nodename> "::font$" <objname>
- ["/" <cataloguelist>]
+ <replaceable>DECnet name</replaceable> ::= <literal>decnet/</literal> <replaceable>nodename</replaceable> <literal>::font$</literal> <replaceable>objname</replaceable> <optional><literal>/</literal> <replaceable>cataloguelist</replaceable></optional>
</literallayout>
-<para>
-where <nodename> is either symbolic (such as SRVNOD) or the
-numeric decimal
-form of the DECnet address (such as 44.70). The <objname> is normal,
-case-insensitive DECnet object name. The <cataloguelist> string
+
+where <replaceable>nodename</replaceable> is either symbolic (such as
+<systemitem class="systemname">SRVNOD</systemitem>) or the
+numeric decimal form of the DECnet address (such as
+<systemitem class="ipaddress">44.70</systemitem>).
+The <replaceable>objname</replaceable> is normal, case-insensitive DECnet
+object name. The <replaceable>cataloguelist</replaceable> string
at the end is
optional and specifies a plus-separated list of catalogues that may be
requested. For example:
-</para>
<literallayout class="monospaced">
DECNET/SRVNOD::FONT$DEFAULT/AVAILABLE
decnet/44.70::font$other
</literallayout>
-</sect2>
-</sect1>
+</para>
+</section>
+</chapter>
-<sect1 id='Protocol'>
+<chapter id='Protocol'>
<title>Protocol</title>
<!-- .XS -->
<!-- (SN Protocol -->
<!-- .XE -->
<para>
-<!-- .LP -->
The protocol described below uses the request/reply/error model and is
-specified using the same conventions outlined in Section 2 of the core X Window
-System protocol [1]:
+specified using the same conventions outlined in
+<olink targetdoc='x11protocol' targetptr='Syntactic_Conventions'>Section 2
+of the core X Window System protocol</olink>
+<xref linkend="References:x11proto"/>:
</para>
<itemizedlist>
<listitem>
<para>
<!-- .IP \(bu 5 -->
Data type names are spelled in upper case with no word separators,
-as in: FONTID
+as in: <link linkend="Data_Types:FONTID"><type>FONTID</type></link>
</para>
</listitem>
<listitem>
<para>
<!-- .IP \(bu 5 -->
Alternate values are capitalized with no word separators,
-as in: MaxWidth
+as in: <constant>MaxWidth</constant>
</para>
</listitem>
<listitem>
<para>
<!-- .IP \(bu 5 -->
Structure element declarations are in lower case with hyphens
-as word separators, as in: byte-order-msb
+as word separators, as in: <structfield>byte-order-msb</structfield>
</para>
<note>
<para>
Structure element names are referred to in
-upper case (e.g. BYTE-ORDER-MSB) when used in
+upper case (e.g. <structfield>BYTE-ORDER-MSB</structfield>) when used in
descriptions to set them off from the surrounding
text. When this document is typeset they will be
printed in lower case in a distinct font.
</listitem>
<listitem>
<para>
-Type declarations have the form "name: type",
-as in: CARD8: 8-bit byte
+Type declarations have the form <quote><type>name</type>: type</quote>,
+as in: <type>CARD8</type>: 8-bit byte
</para>
</listitem>
<listitem>
<para>
Comma-separated lists of alternate values are enclosed in
-braces, as in: { Min, MaxWidth, Max }
+braces, as in: { <constant>Min</constant>, <constant>MaxWidth</constant>,
+<constant>Max</constant> }
</para>
</listitem>
<listitem>
<para>
Comma-separated lists of structure elements are enclosed in
-brackets, as in: [ byte1: CARD8, byte2: CARD8 ]
+brackets, as in: [ <structfield>byte1</structfield>: <type>CARD8</type>,
+<structfield>byte2</structfield>: <type>CARD8</type> ]
</para>
</listitem>
</itemizedlist>
<para>
-<!-- .LP -->
-A type with a prefix "LISTof" represents a counted list of
-elements of that type, as in: LISTofCARD8
+A type with a prefix <quote>LISTof</quote> represents a counted list of
+elements of that type, as in: <type>LISTofCARD8</type>
</para>
-<sect2 id='Data_Types'>
+<section id='Data_Types'>
<title>Data Types</title>
<!-- .XS -->
<!-- (SN Data Types -->
The following data types are used in the core X Font Server protocol:
</para>
-<literallayout class="monospaced">
-ACCESSCONTEXT: ID
-</literallayout>
-<blockquote>
+<section id="Data_Types:ACCESSCONTEXT">
+ <title><type>ACCESSCONTEXT</type></title>
+ <indexterm zone="Data_Types:ACCESSCONTEXT" significance="preferred"><primary>ACCESSCONTEXT</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>ACCESSCONTEXT</type>:</entry><entry><link linkend="Data_Types:ID"><type>ID</type></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This value is specified in the CreateAC request as the identifier
to be used when referring to a particular AccessContext resource
the client should be granted access to particular font data.
</para>
<para>
-<!-- .sp -->
In order to preserve the integrity of font licensing being performed by
the font server, care must be taken by a client to properly represent the
identity of the true user of the font. Some font clients will in fact
users over time (for example, print spoolers).
</para>
<para>
-<!-- .sp -->
-<function>AccessContexts </function>
+<type>AccessContext</type>s
must be created (with
-<function>CreateAC ) </function>
+<link linkend="Requests:CreateAC"><function>CreateAC</function></link>)
and switched among (with
-<function>SetAuthorization )</function>
-to represent all of these "font users" properly.
- </para>
-</blockquote>
-
-<literallayout class="monospaced">
-ALTERNATESERVER: [ name: STRING8,
- subset: BOOL ]
-</literallayout>
-
-<blockquote>
- <para>
-This structure specifies the NAME, encoded in ISO 8859-1 according
-to Section 3, of another font server that may be useful as a
-substitute for this font server. The SUBSET field indicates
+<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link>)
+to represent all of these <quote>font users</quote> properly.
+ </para>
+</section>
+
+<section id="Data_Types:ALTERNATESERVER">
+ <title><type>ALTERNATESERVER</type></title>
+ <indexterm zone="Data_Types:ALTERNATESERVER" significance="preferred"><primary>ALTERNATESERVER</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry morerows="1"><type>ALTERNATESERVER</type>:</entry>
+ <entry> [ <structfield>name</structfield>:</entry><entry> <link linkend="Data_Types:STRING8"><type>STRING8</type></link>,</entry></row>
+ <row><entry> <structfield>subset</structfield>:</entry><entry> <link linkend="Data_Types:BOOL"><type>BOOL</type></link> ]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <para>
+This structure specifies the <structfield>NAME</structfield>,
+encoded in <acronym>ISO</acronym> 8859-1 according
+to <link linkend='Font_Server_Naming'>Section 3</link>,
+of another font server that may be useful as a
+substitute for this font server.
+The <structfield>SUBSET</structfield> field indicates
whether or not the alternate server is likely to only contain a
subset of the fonts available from this font server. This
information is returned during the initial connection setup and
may be used by the client to find a backup server in case of
failure.
</para>
-</blockquote>
+</section>
+
+<section id="Data_Types:AUTH">
+ <title><type>AUTH</type></title>
+ <indexterm zone="Data_Types:AUTH" significance="preferred"><primary>AUTH</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry morerows="1"><type>AUTH</type>:</entry><entry>[ <structfield>name</structfield>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link>,</entry></row>
+ <row><entry> <structfield>data</structfield>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link> ]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<literallayout class="monospaced">
-AUTH: [ name: STRING8,
- data: LISTofBYTE ]
-</literallayout>
-
-<blockquote>
<para>
This structure specifies the name of an authorization protocol and
initial data for that protocol. It is used in the authorization
negotiation in the initial connection setup and in the CreateAC
request.
</para>
-</blockquote>
-
-<literallayout class="monospaced">
-BITMAPFORMAT:
-</literallayout>
-
-<literallayout class="monospaced">
- CARD32 containing the following fields defined by the
+</section>
+
+<section id="Data_Types:BITMAPFORMAT">
+ <title><type>BITMAPFORMAT</type></title>
+ <indexterm zone="Data_Types:BITMAPFORMAT" significance="preferred"><primary>BITMAPFORMAT</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>BITMAPFORMAT</type>:</entry><entry><type>CARD32</type></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <para>
+ <type>CARD32</type> containing the following fields defined by the
sets of values given further below
- [
- byte-order-msb: 1 bit,
- bit-order-msb: 1 bit,
- image-rect: 2 bits { Min,
- MaxWidth,
- Max },
- zero-pad: 4 bits,
- scanline-pad: 2 bits { ScanlinePad8,
- ScanlinePad16,
- ScanlinePad32,
- ScanlinePad64 },
- zero-pad: 2 bits,
- scanline-unit: 2 bits { ScanlineUnit8,
- ScanlineUnit16,
- ScanlineUnit32,
- ScanlineUnit64 },
- zero-pad: 2 bits,
- zero-pad: 16 bits,
- ]
-</literallayout>
+ </para>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry>[</entry></row>
+ <row><entry> <structfield>byte-order-msb</structfield>:</entry><entry> 1 bit,</entry></row>
+ <row><entry> <structfield>bit-order-msb</structfield>:</entry><entry> 1 bit,</entry></row>
+ <row><entry> <structfield>image-rect</structfield>:</entry><entry> 2 bits</entry><entry>{ <constant>Min</constant>,
+ <constant>MaxWidth</constant>,
+ <constant>Max</constant> },</entry></row>
+ <row><entry> <structfield>zero-pad</structfield>:</entry><entry> 4 bits,</entry></row>
+ <row><entry> <structfield>scanline-pad</structfield>:</entry><entry> 2 bits</entry><entry>{ <constant>ScanlinePad8</constant>,
+ <constant>ScanlinePad16</constant>,
+ <constant>ScanlinePad32</constant>,
+ <constant>ScanlinePad64</constant> },</entry></row>
+ <row><entry> <structfield>zero-pad</structfield>:</entry><entry> 2 bits,</entry></row>
+ <row><entry> <structfield>scanline-unit</structfield>:</entry><entry> 2 bits</entry><entry>{ <constant>ScanlineUnit8</constant>,
+ <constant>ScanlineUnit16</constant>,
+ <constant>ScanlineUnit32</constant>,
+ <constant>ScanlineUnit64</constant> },</entry></row>
+ <row><entry> <structfield>zero-pad</structfield>:</entry><entry> 2 bits,</entry></row>
+ <row><entry> <structfield>zero-pad</structfield>:</entry><entry> 16 bits,</entry></row>
+ <row><entry>]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
This structure specifies how glyph images are transmitted in
response to
-<function>QueryXBitmaps8 </function>
+<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link>
and
-<function>QueryXBitmaps16 </function>
+<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link>
requests.
</para>
<para>
-<!-- .sp -->
-If the BYTE-ORDER-MSB bit (1 << 0) is set, the Most Significant
+If the <structfield>BYTE-ORDER-MSB</structfield> bit
+<literal>(1 << 0)</literal> is set, the Most Significant
Byte of each scanline unit is returned first. Otherwise, the
Least Significant Byte is returned first.
</para>
<para>
-<!-- .sp -->
-If the BIT-ORDER-MSB bit (1 << 1) is set, the left-most bit in
+If the <structfield>BIT-ORDER-MSB</structfield> bit
+<literal>(1 << 1)</literal> is set, the left-most bit in
each glyph scanline unit is stored in the Most Significant Bit of
each transmitted scanline unit. Otherwise, the left-most bit is
stored in the Least Significant Bit.
</para>
<para>
-<!-- .sp -->
-The IMAGE-RECT field specifies a rectangle of pixels within the
+The <structfield>IMAGE-RECT</structfield> field specifies a rectangle of
+pixels within the
glyph image. It contains one of the following alternate values:
-</para>
-<literallayout class="monospaced">
- ImageRectMin (0 << 2)
- ImageRectMaxWidth (1 << 2)
- ImageRectMax (2 << 2)
-</literallayout>
-<para>
-For a glyph with extents XCHARINFO in a font with header information
-XFONTINFO, the IMAGE-RECT values have the following meanings:
-</para>
-<para>
-<function>ImageRectMin -</function>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><constant>ImageRectMin</constant></entry><entry><literal>(0 << 2)</literal></entry></row>
+ <row><entry><constant>ImageRectMaxWidth</constant></entry><entry><literal>(1 << 2)</literal></entry></row>
+ <row><entry><constant>ImageRectMax</constant></entry><entry><literal>(2 << 2)</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
+<para>
+For a glyph with extents <link linkend="Data_Types:XCHARINFO"><type>XCHARINFO</type></link> in a font with header
+information <link linkend="Data_Types:XFONTINFO"><type>XFONTINFO</type></link>, the <structfield>IMAGE-RECT</structfield>
+values have the following meanings:
+<variablelist>
+ <varlistentry id="Constant:ImageRectMin">
+ <term><constant>ImageRectMin</constant></term>
+ <listitem>
+ <indexterm zone="Constant:ImageRectMin" significance="preferred"><primary>ImageRectMin</primary></indexterm>
+ <para>
This refers to the minimal bounding rectangle
surrounding the inked pixels in the glyph. This is the
most compact representation. The edges of the rectangle
are:
-</para>
<literallayout class="monospaced">
- left: XCHARINFO.LBEARING
- right: XCHARINFO.RBEARING
- top: XCHARINFO.ASCENT
- bottom: XCHARINFO.DESCENT
+ left: <structfield>XCHARINFO.LBEARING</structfield>
+ right: <structfield>XCHARINFO.RBEARING</structfield>
+ top: <structfield>XCHARINFO.ASCENT</structfield>
+ bottom: <structfield>XCHARINFO.DESCENT</structfield>
</literallayout>
-<para>
-
-<function>ImageRectMaxWidth - </function>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="Constant:ImageRectMaxWidth">
+ <term><constant>ImageRectMaxWidth</constant></term>
+ <listitem>
+ <indexterm zone="Constant:ImageRectMaxWidth" significance="preferred"><primary>ImageRectMaxWidth</primary></indexterm>
+ <para>
This refers to the scanlines between the
glyph's ascent and descent, padded on the left to the minimum
left-bearing (or 0, whichever is less) and on the right to
the maximum right-bearing (or logical-width, whichever is
greater). All glyph images share a common horizontal
-origin. This is a combination of ImageRectMax in the
-horizontal direction and ImageRectMin in the vertical
+origin. This is a combination of <constant>ImageRectMax</constant> in the
+horizontal direction and <constant>ImageRectMin</constant> in the vertical
direction. The edges of the rectangle are:
-</para>
<literallayout class="monospaced">
-left: min (XFONTINFO.MIN-BOUNDS.LBEARING, 0)
-right: max (XFONTINFO.MAX-BOUNDS.RBEARING,
- XFONTINFO.MAX-BOUNDS.WIDTH)
-top: XCHARINFO.ASCENT
-bottom: XCHARINFO.DESCENT
+left: min (<structfield>XFONTINFO.MIN-BOUNDS.LBEARING</structfield>, 0)
+right: max (<structfield>XFONTINFO.MAX-BOUNDS.RBEARING</structfield>,
+ <structfield>XFONTINFO.MAX-BOUNDS.WIDTH</structfield>)
+top: <structfield>XCHARINFO.ASCENT</structfield>
+bottom: <structfield>XCHARINFO.DESCENT</structfield>
</literallayout>
-
-<para>
-ImageRectMax - This refers to all scanlines, from the maximum
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="Constant:ImageRectMax">
+ <term><constant>ImageRectMax</constant></term>
+ <listitem>
+ <indexterm zone="Constant:ImageRectMax" significance="preferred"><primary>ImageRectMax</primary></indexterm>
+ <para>
+This refers to all scanlines, from the maximum
ascent (or the font ascent, whichever is greater) to the
maximum descent (or the font descent, whichever is greater),
-padded to the same horizontal extents as MaxWidth.
+padded to the same horizontal extents as <constant>MaxWidth</constant>.
All glyph images have the same sized bitmap and share a
common origin. This is the least compact representation,
but may be the easiest or most efficient (particularly for
character cell fonts) for some clients to use. The edges of
the rectangle are:
-</para>
<literallayout class="monospaced">
-left: min (XFONTINFO.MIN-BOUNDS.LBEARING, 0)
-right: max (XFONTINFO.MAX-BOUNDS.RBEARING,
- XFONTINFO.MAX-BOUNDS.WIDTH)
-top: max (XFONTINFO.FONT-ASCENT,
- XFONTINFO.MAX-BOUNDS.ASCENT)
-bottom: max (XFONTINFO.FONT-DESCENT,
- XFONTINFO.MAX-BOUNDS.DESCENT)
+left: min (<structfield>XFONTINFO.MIN-BOUNDS.LBEARING</structfield>, 0)
+right: max (<structfield>XFONTINFO.MAX-BOUNDS.RBEARING</structfield>,
+ <structfield>XFONTINFO.MAX-BOUNDS.WIDTH</structfield>)
+top: max (<structfield>XFONTINFO.FONT-ASCENT</structfield>,
+ <structfield>XFONTINFO.MAX-BOUNDS.ASCENT</structfield>)
+bottom: max (<structfield>XFONTINFO.FONT-DESCENT</structfield>,
+ <structfield>XFONTINFO.MAX-BOUNDS.DESCENT</structfield>)
</literallayout>
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+</para>
<para>
-The SCANLINE-PAD field specifies the number of bits (8, 16, 32,
+The <structfield>SCANLINE-PAD</structfield> field specifies the number of
+bits (8, 16, 32,
or 64) to which each glyph scanline is padded before transmitting.
It contains one of the following alternate values:
-</para>
-<literallayout class="monospaced">
- ScanlinePad8 (0 << 8)
- ScanlinePad16 (1 << 8)
- ScanlinePad32 (2 << 8)
- ScanlinePad64 (3 << 8)
-</literallayout>
-<para>
-The SCANLINE-UNIT field specifies the number of bits (8, 16, 32,
-or 64) that should be treated as a unit for swapping. This value
-must be less than or equal to the number of bits specified by the
-SCANLINE-PAD. It contains one of the following alternate values:
-</para>
-
-<literallayout class="monospaced">
- ScanlineUnit8 (0 << 12)
- ScanlineUnit16 (1 << 12)
- ScanlineUnit32 (2 << 12)
- ScanlineUnit64 (3 << 12)
-</literallayout>
-<para>
-BITMAPFORMATs are byte-swapped as CARD32s. All unspecified bits
-must be zero.
-</para>
-<para>
-Use of an invalid BITMAPFORMAT causes a Format error to
-be returned.
-</para>
-</blockquote>
-<para>
-BITMAPFORMATMASK: CARD32 mask
-</para>
-<blockquote>
-<para>
-This is a mask of bits representing the fields in a BITMAPFORMAT:
-</para>
-</blockquote>
-<literallayout class="monospaced">
- ByteOrderMask (1 << 0)
- BitOrderMask (1 << 1)
- ImageRectMask (1 << 2)
- ScanlinePadMask (1 << 3)
- ScanlineUnitMask (1 << 4)
-</literallayout>
-<para>
-Unspecified bits are required to be zero or else a Format error
-is returned.
-</para>
-<para>
-BOOL: CARD8
-</para>
-<blockquote>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><constant>ScanlinePad8</constant></entry><entry><literal>(0 << 8)</literal></entry></row>
+ <row><entry><constant>ScanlinePad16</constant></entry><entry><literal>(1 << 8)</literal></entry></row>
+ <row><entry><constant>ScanlinePad32</constant></entry><entry><literal>(2 << 8)</literal></entry></row>
+ <row><entry><constant>ScanlinePad64</constant></entry><entry><literal>(3 << 8)</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
+<para>
+The <structfield>SCANLINE-UNIT</structfield> field specifies the number of
+bits (8, 16, 32, or 64) that should be treated as a unit for swapping.
+This value must be less than or equal to the number of bits specified by the
+<structfield>SCANLINE-PAD</structfield>. It contains one of the following
+alternate values:
+
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><constant>ScanlineUnit8</constant></entry><entry><literal>(0 << 12)</literal></entry></row>
+ <row><entry><constant>ScanlineUnit16</constant></entry><entry><literal>(1 << 12)</literal></entry></row>
+ <row><entry><constant>ScanlineUnit32</constant></entry><entry><literal>(2 << 12)</literal></entry></row>
+ <row><entry><constant>ScanlineUnit64</constant></entry><entry><literal>(3 << 12)</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
+<para>
+<link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link>s are byte-swapped as <type>CARD32</type>s.
+All unspecified bits must be zero.
+</para>
+<para>
+Use of an invalid <link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link> causes a
+<link linkend="Errors:Format"><errorname>Format</errorname></link> error to be returned.
+</para>
+</section>
+
+<section id="Data_Types:BITMAPFORMATMASK">
+ <title><type>BITMAPFORMATMASK</type></title>
+ <indexterm zone="Data_Types:BITMAPFORMATMASK" significance="preferred"><primary>BITMAPFORMATMASK</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>BITMAPFORMATMASK</type>:</entry><entry> <type>CARD32</type> mask</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+<para>
+This is a mask of bits representing the fields in a <link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link>:
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><constant>ByteOrderMask</constant></entry><entry><literal>(1 << 0)</literal></entry></row>
+ <row><entry><constant>BitOrderMask</constant></entry><entry><literal>(1 << 1)</literal></entry></row>
+ <row><entry><constant>ImageRectMask</constant></entry><entry><literal>(1 << 2)</literal></entry></row>
+ <row><entry><constant>ScanlinePadMask</constant></entry><entry><literal>(1 << 3)</literal></entry></row>
+ <row><entry><constant>ScanlineUnitMask</constant></entry><entry><literal>(1 << 4)</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
+<para>
+Unspecified bits are required to be zero or else a
+<link linkend="Errors:Format"><errorname>Format</errorname></link> error is returned.
+</para>
+</section>
+
+<section id="Data_Types:BOOL">
+ <title><type>BOOL</type></title>
+ <indexterm zone="Data_Types:BOOL" significance="preferred"><primary>BOOL</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>BOOL</type>:</entry><entry> <type>CARD8</type></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This is a boolean value containing one of the following alternate
values:
-</para>
-
-<literallayout class="monospaced">
- False 0
- True 1
-</literallayout>
-</blockquote>
-
-<para>
-BYTE: 8-bit value
-</para>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><constant>False</constant></entry><entry><literal>0</literal></entry></row>
+ <row><entry><constant>True</constant></entry><entry><literal>1</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
+</section>
+
+<section id="Data_Types:BYTE">
+ <title><type>BYTE</type></title>
+ <indexterm zone="Data_Types:BYTE" significance="preferred"><primary>BYTE</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>BYTE</type>:</entry><entry> 8-bit value</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
This is an unsigned byte of data whose encoding
is determined by the context in which it is used.
</para>
-</blockquote>
-
-<para>
-CARD8: 8-bit unsigned integer
-</para>
-
-<para>
-CARD16: 16-bit unsigned integer
-</para>
-<para>
-CARD32: 32-bit unsigned integer
-</para>
+</section>
+
+<section id="Data_Types:CARDn">
+ <title><type>CARD8</type>, <type>CARD16</type>, <type>CARD32</type></title>
+ <indexterm zone="Data_Types:CARDn" significance="preferred"><primary>CARD8</primary></indexterm>
+ <indexterm zone="Data_Types:CARDn" significance="preferred"><primary>CARD16</primary></indexterm>
+ <indexterm zone="Data_Types:CARDn" significance="preferred"><primary>CARD32</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>CARD8</type>:</entry><entry> 8-bit unsigned integer</entry></row>
+ <row><entry><type>CARD16</type>:</entry><entry> 16-bit unsigned integer</entry></row>
+ <row><entry><type>CARD32</type>:</entry><entry> 32-bit unsigned integer</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
These are unsigned numbers. The latter two are byte-swapped when
the server and client have different byte orders.
</para>
-</blockquote>
-<para>
-CHAR2B: [ byte1, byte2: CARD8 ]
-</para>
-<blockquote>
-<para>
-This structure specifies an individual character code within
-either a 2-dimensional matrix (using BYTE1 and BYTE2 as the row
-and column indices, respectively) or a vector (using BYTE1 and
-BYTE2 as most- and least-significant bytes, respectively). This
-data type is treated as a pair of 8-bit values and is never
-byte-swapped. Therefore, the client should always transmit BYTE1
-first.
-</para>
-</blockquote>
+</section>
+<section id="Data_Types:CHAR2B">
+ <title><type>CHAR2B</type></title>
+ <indexterm zone="Data_Types:CHAR2B" significance="preferred"><primary>CHAR2B</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>CHAR2B</type>:</entry><entry>[ <structfield>byte1</structfield>, <structfield>byte2</structfield>:</entry><entry><type>CARD8</type> ]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
-EVENTMASK: CARD32 mask
-</para>
+This structure specifies an individual character code within
+either a 2-dimensional matrix (using <structfield>BYTE1</structfield>
+and <structfield>BYTE2</structfield> as the row and column indices,
+respectively) or a vector (using <structfield>BYTE1</structfield> and
+<structfield>BYTE2</structfield> as most- and least-significant bytes,
+respectively). This data type is treated as a pair of 8-bit values and
+is never byte-swapped. Therefore, the client should always transmit
+<structfield>BYTE1</structfield> first.
+</para>
+
+</section>
+
+<section id="Data_Types:EVENTMASK">
+ <title><type>EVENTMASK</type></title>
+ <indexterm zone="Data_Types:EVENTMASK" significance="preferred"><primary>EVENTMASK</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>EVENTMASK</type>:</entry><entry> <type>CARD32</type> mask</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
This is a mask of bits indicating which of an extension's (or the
core's) maskable events the client would like to receive. Each
bit indicates one or more events, and a bit value of one indicates
interest in a corresponding set of events. The following bits are
defined for event masks specified for the core protocol (i.e. an
-EXTENSION-OPCODE of zero in
-<function>SetEventMask </function>
+<parameter>EXTENSION-OPCODE</parameter> of zero in
+<link linkend="Requests:SetEventMask"><function>SetEventMask</function></link>
and
-<function>GetEventMask </function>
+<link linkend="Requests:GetEventMask"><function>GetEventMask</function></link>
requests):
-</para>
-<literallayout class="monospaced">
- CatalogueListChangeMask (1 << 0)
- FontListChangeMask (1 << 1)
-</literallayout>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><constant>CatalogueListChangeMask</constant></entry><entry><literal>(1 << 0)</literal></entry></row>
+ <row><entry><constant>FontListChangeMask</constant></entry><entry><literal>(1 << 1)</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
<para>
If
-<function>CatalogueListChangeMask </function>
+<constant>CatalogueListChangeMask</constant>
is set, client is interested in
receiving
-<function>CatalogueListNotify </function>
+<link linkend="Events:CatalogueListNotify"><function>CatalogueListNotify</function></link>
events. If
-<function>FontListChangeMask </function>
+<constant>FontListChangeMask</constant>
is set, the client is interested in
receiving
-<function>FontListNotify </function>
+<link linkend="Events:FontListNotify"><function>FontListNotify</function></link>
events.
</para>
<para>
-<!-- .sp -->
Extensions that provide additional events may define their own
event masks. These event masks have their own scope and may use
the same bit values as the core or other extensions.
-<!-- .sp -->
+ </para>
+ <para>
All unused bits must be set to zero. In
-<function>SetEventMask </function>
+<link linkend="Requests:SetEventMask"><function>SetEventMask</function></link>
requests, if
any bits are set that are not defined for the extension (or core)
-for which this EVENTMASK is intended (according to the EXTENSION-
-OPCODE given in the
-<function>SetEventMask </function>
+for which this <type>EVENTMASK</type> is intended (according to the
+<parameter>EXTENSION-OPCODE</parameter> given in the
+<link linkend="Requests:SetEventMask"><function>SetEventMask</function></link>
request), an
-<function>EventMask </function>
+<link linkend="Errors:EventMask"><errorname>EventMask</errorname></link>
error is generated.
-<!-- .sp -->
-This value is swapped as a CARD32.
</para>
-</blockquote>
+ <para>
+This value is swapped as a <type>CARD32</type>.
+ </para>
-<para>
-FONTID: ID
-</para>
+</section>
+
+<section id="Data_Types:FONTID">
+ <title><type>FONTID</type></title>
+ <indexterm zone="Data_Types:FONTID" significance="preferred"><primary>FONTID</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>FONTID</type>:</entry><entry> <link linkend="Data_Types:ID"><type>ID</type></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
This is specified by the client in the request
-<function>OpenBitmapFont </function>
+<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>
as the identifier to be used when referring to a particular open
font.
</para>
-</blockquote>
-<para>
-ID: CARD32
-</para>
+</section>
+
+<section id="Data_Types:ID">
+ <title><type>ID</type></title>
+ <indexterm zone="Data_Types:ID" significance="preferred"><primary>ID</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>ID</type>:</entry><entry> <type>CARD32</type></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
This is a 32-bit value in which the top 3 bits must be clear, and
at least 1 other bit must be set (yielding a range of 1 through
-2^29-1). It is specified by the client to represent objects in
+2<superscript>29</superscript>-1).
+It is specified by the client to represent objects in
the server. Identifiers are scoped according to their type are
private to the client; thus, the same identifier may be used for
-both a FONTID and an ACCESSCONTEXT as well as by multiple clients.
-</para>
-<para>
-An ID of zero is referred to as None.
-</para>
-</blockquote>
-
-<para>
-INT8: 8-bit signed integer
-</para>
-
-<para>
-INT16: 16-bit signed integer
-</para>
-
-<para>
-INT32: 32-bit signed integer
-</para>
+both a <link linkend="Data_Types:FONTID"><type>FONTID</type></link> and an <link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link>
+as well as by multiple clients.
+</para>
+<para>
+An <type>ID</type> of zero is referred to as <constant>None</constant>.
+</para>
+</section>
+
+<section id="Data_Types:INTn">
+ <title><type>INT8</type>, <type>INT16</type>, <type>INT32</type></title>
+ <indexterm zone="Data_Types:INTn" significance="preferred"><primary>INT8</primary></indexterm>
+ <indexterm zone="Data_Types:INTn" significance="preferred"><primary>INT16</primary></indexterm>
+ <indexterm zone="Data_Types:INTn" significance="preferred"><primary>INT32</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>INT8</type>:</entry><entry> 8-bit signed integer</entry></row>
+ <row><entry><type>INT16</type>:</entry><entry> 16-bit signed integer</entry></row>
+ <row><entry><type>INT32</type>:</entry><entry> 32-bit signed integer</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
These are signed numbers. The latter two are byte-swapped when
the client and server have different byte orders.
</para>
-</blockquote>
-
-<literallayout class="monospaced">
-OFFSET32: [ position: CARD32,
- length: CARD32 ]
-</literallayout>
-
-<blockquote>
+</section>
+
+<section id="Data_Types:OFFSET32">
+ <title><type>OFFSET32</type></title>
+ <indexterm zone="Data_Types:OFFSET32" significance="preferred"><primary>OFFSET32</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry morerows='1'><type>OFFSET32</type>:</entry>
+ <entry>[ <structfield>position</structfield>:</entry><entry><type>CARD32</type>,</entry></row>
+ <row><entry> <structfield>length</structfield>:</entry><entry><type>CARD32</type> ]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This structure indicates a position and length within a block of
data.
</para>
-</blockquote>
-
-<literallayout class="monospaced">
-PROPINFO: [ offsets: LISTofPROPOFFSET,
- data: LISTofBYTE ]
-</literallayout>
+</section>
+
+<section id="Data_Types:PROPINFO">
+ <title><type>PROPINFO</type></title>
+ <indexterm zone="Data_Types:PROPINFO" significance="preferred"><primary>PROPINFO</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry morerows='1'><type>PROPINFO</type>:</entry>
+ <entry>[ <structfield>offsets</structfield>:</entry><entry><link linkend="Data_Types:PROPOFFSET"><type>LISTofPROPOFFSET</type></link>,</entry></row>
+ <row><entry> <structfield>data</structfield>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link> ]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
This structure describes the list of properties provided by a
font. Strings for all of the properties names and values are
<para>
This structure is padded to 32-bit alignment.
</para>
-</blockquote>
-<literallayout class="monospaced">
-PROPOFFSET: [ name: OFFSET32,
- value: OFFSET32,
- type: CARD8,
- zero-pad3: BYTE, BYTE, BYTE ]
-</literallayout>
+</section>
+
+<section id="Data_Types:PROPOFFSET">
+ <title><type>PROPOFFSET</type></title>
+ <indexterm zone="Data_Types:PROPOFFSET" significance="preferred"><primary>PROPOFFSET</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry morerows='3'><type>PROPOFFSET</type>:</entry>
+ <entry>[ <structfield>name</structfield>:</entry><entry><link linkend="Data_Types:OFFSET32"><type>OFFSET32</type></link>,</entry></row>
+ <row><entry> <structfield>value</structfield>:</entry><entry><link linkend="Data_Types:OFFSET32"><type>OFFSET32</type></link>,</entry></row>
+ <row><entry> <structfield>type</structfield>:</entry><entry><type>CARD8</type>,</entry></row>
+ <row><entry> <structfield>zero-pad3</structfield>:</entry><entry><link linkend="Data_Types:BYTE"><type>BYTE</type></link>, <link linkend="Data_Types:BYTE"><type>BYTE</type></link>, <link linkend="Data_Types:BYTE"><type>BYTE</type></link> ]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
This structure specifies the position, length, and type of
of data for a property.
</para>
<para>
-The NAME field specifies the position and length (which must be
+The <structfield>NAME</structfield> field specifies the position and length
+(which must be
greater than zero) of the property name relative to the beginning
-of the PROPINFO.DATA block for this font. The interpretation of
-the position and length of the VALUE field is determined by the
-TYPE field, which contains one of the following alternate values:
- </para>
-</blockquote>
-
-<literallayout class="monospaced">
- String 0
- Unsigned 1
- Signed 2
-</literallayout>
-
-<blockquote>
- <para>
+of the <structfield>PROPINFO.DATA</structfield> block for this font.
+The interpretation of
+the position and length of the <structfield>VALUE</structfield> field is
+determined by the <structfield>TYPE</structfield> field, which contains
+one of the following alternate values:
+
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><constant>String</constant></entry><entry><literal>0</literal></entry></row>
+ <row><entry><constant>Unsigned</constant></entry><entry><literal>1</literal></entry></row>
+ <row><entry><constant>Signed</constant></entry><entry><literal>2</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
which have the following meanings:
- </para>
- <blockquote>
+<variablelist>
+ <varlistentry id="Constant:String">
+ <term><constant>String</constant></term>
+ <listitem>
+ <indexterm zone="Constant:String" significance="preferred"><primary>String</primary></indexterm>
<para>
This property contains a counted string of bytes. The
-data is stored in the PROPINFO.DATA block beginning at
+data is stored in the <structfield>PROPINFO.DATA</structfield>
+block beginning at
relative byte VALUE.POSITION (beginning with zero), extending
for VALUE.LENGTH (at least zero) bytes.
</para>
- </blockquote>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="Constant:Unsigned">
+ <term><constant>Unsigned</constant></term>
+ <listitem>
+ <indexterm zone="Constant:Unsigned" significance="preferred"><primary>Unsigned</primary></indexterm>
<para>
This property contains a unsigned, 32-bit number stored
-as a CARD32 in VALUE.POSITION (VALUE.LENGTH is zero).
- </para>
- <blockquote>
+as a <type>CARD32</type> in VALUE.POSITION (VALUE.LENGTH is zero).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="Constant:Signed">
+ <term><constant>Signed</constant></term>
+ <listitem>
+ <indexterm zone="Constant:Signed" significance="preferred"><primary>Signed</primary></indexterm>
<para>
This property contains a signed, 32-bit number stored as
-an INT32 in VALUE.POSITION (VALUE.LENGTH is zero).
-This structure is zero-padded to 32-bit alignment.
+an <type>INT32</type> in VALUE.POSITION (VALUE.LENGTH is zero).
</para>
- </blockquote>
-</blockquote>
-
-<para>
-RANGE: [ min-char, max-char: CHAR2B ]
+ </listitem>
+ </varlistentry>
+</variablelist>
+This structure is zero-padded to 32-bit alignment.
</para>
-<blockquote>
+</section>
+
+<section id="Data_Types:RANGE">
+ <title><type>RANGE</type></title>
+ <indexterm zone="Data_Types:RANGE" significance="preferred"><primary>RANGE</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>RANGE</type>:</entry>
+ <entry>[ <structfield>min-char</structfield>, <structfield>max-char</structfield>:</entry><entry><link linkend="Data_Types:CHAR2B"><type>CHAR2B</type></link> ]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
<para>
This structure specifies a range of character codes. A single
-character is represented by MIN-CHAR equals MAX-CHAR. If the
-linear interpretation of MAX-CHAR is less than that of MIN-CHAR,
-or if MIN-CHAR is less than the font's
-XFONTINFO.CHAR-RANGE.MIN-CHAR, or if MAX-CHAR is greater than the
-font's XFONTINFO.CHAR-RANGE.MAX-CHAR, the range is invalid.
+character is represented by <structfield>MIN-CHAR</structfield> equals
+<structfield>MAX-CHAR</structfield>. If the linear interpretation of
+<structfield>MAX-CHAR</structfield> is less than that of
+<structfield>MIN-CHAR</structfield>, or if
+<structfield>MIN-CHAR</structfield> is less than the font's
+<structfield>XFONTINFO.CHAR-RANGE.MIN-CHAR</structfield>, or if
+<structfield>MAX-CHAR</structfield> is greater than the
+font's <structfield>XFONTINFO.CHAR-RANGE.MAX-CHAR</structfield>,
+the range is invalid.
</para>
-</blockquote>
-<literallayout class="monospaced">
-RESOLUTION: [ x-resolution: CARD16,
- y-resolution: CARD16,
- decipoint-size: CARD16 ]
-</literallayout>
+</section>
+
+<section id="Data_Types:RESOLUTION">
+ <title><type>RESOLUTION</type></title>
+ <indexterm zone="Data_Types:RESOLUTION" significance="preferred"><primary>RESOLUTION</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry morerows='2'><type>RESOLUTION</type>:</entry>
+ <entry>[ <structfield>x-resolution</structfield>:</entry><entry><type>CARD16</type>,</entry></row>
+ <row><entry> <structfield>y-resolution</structfield>:</entry><entry><type>CARD16</type>,</entry></row>
+ <row><entry> <structfield>decipoint-size</structfield>:</entry><entry><type>CARD16</type> ]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
This structure specifies resolution and point size to be used in
-resolving partially-specified scaled font names. The X-RESOLUTION
-and Y-RESOLUTION are measured in pixels-per-inch and must be
-greater than zero. The DECIPOINT-SIZE is the preferred font
+resolving partially-specified scaled font names. The
+<structfield>X-RESOLUTION</structfield> and
+<structfield>Y-RESOLUTION</structfield> are measured in
+pixels-per-inch and must be greater than zero.
+The <structfield>DECIPOINT-SIZE</structfield> is the preferred font
size, measured in tenths of a point, and must be greater than zero.
</para>
-</blockquote>
-<para>
-STRING8: LISTofCARD8
-</para>
+</section>
+
+<section id="Data_Types:STRING8">
+ <title><type>STRING8</type></title>
+ <indexterm zone="Data_Types:STRING8" significance="preferred"><primary>STRING8</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>STRING8</type>:</entry><entry> <type>LISTofCARD8</type></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
This is a counted list of 1-byte character codes, typically
-encoded in ISO 8859-1. A character code "c" is equivalent to a
-CHAR2B structure whose BYTE1 is zero and whose BYTE2 is "c".
+encoded in <acronym>ISO</acronym> 8859-1. A character code
+<quote><literal>c</literal></quote> is equivalent to a
+<link linkend="Data_Types:CHAR2B"><type>CHAR2B</type></link> structure whose <structfield>BYTE1</structfield>
+is zero and whose <structfield>BYTE2</structfield> is
+<quote><literal>c</literal></quote>.
</para>
-</blockquote>
-<para>
-TIMESTAMP: CARD32
-</para>
+</section>
+
+<section id="Data_Types:TIMESTAMP">
+ <title><type>TIMESTAMP</type></title>
+ <indexterm zone="Data_Types:TIMESTAMP" significance="preferred"><primary>TIMESTAMP</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><type>TIMESTAMP</type>:</entry><entry> <type>CARD32</type></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
-This is the number of milliseconds that have passed since a server-
-dependent origin. It is provided in errors and events and is
+This is the number of milliseconds that have passed since a
+server-dependent origin. It is provided in errors and events and is
permitted to wrap.
</para>
-</blockquote>
-
-<para>
-XCHARINFO: [ lbearing, rbearing: INT16,
- width: INT16,
- ascent, descent: INT16,
- attributes: CARD16 ]
-</para>
+</section>
+
+<section id="Data_Types:XCHARINFO">
+ <title><type>XCHARINFO</type></title>
+ <indexterm zone="Data_Types:XCHARINFO" significance="preferred"><primary>XCHARINFO</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry morerows='3'><type>XCHARINFO</type>:</entry>
+ <entry>[ <structfield>lbearing</structfield>, <structfield>rbearing</structfield>:</entry><entry><type>INT16</type>,</entry></row>
+ <row><entry> <structfield>width</structfield>:</entry><entry><type>INT16</type>,</entry></row>
+ <row><entry> <structfield>ascent</structfield>, <structfield>descent</structfield>:</entry><entry><type>INT16</type>,</entry></row>
+ <row><entry> <structfield>attributes</structfield>:</entry><entry><type>CARD16</type> ]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
This structure specifies the ink extents and horizontal escapement
(also known as the set- or logical width) of an individual
a coordinate system whose origin is aligned with the lower-left
edge of the left-most pixel of the glyph baseline (i.e. the
baseline falls between two pixels as shown in Figure 3-1 of the
-"Bitmap Distribution Format 2.1" Consortium standard [2]).
+<citetitle>Bitmap Distribution Format 2.1</citetitle> Consortium standard
+<xref linkend="References:bdf-spec"/>).
</para>
-<!-- .sp -->
<para>
-The LBEARING field specifies the directed distance measured to the
+The <structfield>LBEARING</structfield> field specifies the
+directed distance measured to the
right from the origin to the left edge of the left-most inked
pixel in the glyph.
-<!-- .sp -->
</para>
<para>
-The RBEARING field specifies the directed distance (measured to
+The <structfield>RBEARING</structfield> field specifies the
+directed distance (measured to
the right) from the origin to the right edge of the right-most
inked pixel in the glyph.
-<!-- .sp -->
</para>
<para>
-The WIDTH field specifies the directed distance (measured to the
+The <structfield>WIDTH</structfield> field specifies the
+directed distance (measured to the
right) from the origin to the position where the next character
-should appear (called the "escapement point"). This distance
-includes any whitespace used for intercharacter padding and is
-also referred to as the "logical width" or "horizontal
-escapement."
-<!-- .sp -->
+should appear (called the <firstterm>escapement point</firstterm>). This
+distance includes any whitespace used for intercharacter padding and is
+also referred to as the <firstterm>logical width</firstterm> or
+<firstterm>horizontal escapement</firstterm>.
+<indexterm zone="Data_Types:XCHARINFO" significance="preferred"><primary>horizontal escapement</primary></indexterm>
</para>
<para>
-The ASCENT field specifies the directed distance (measured up)
+The <structfield>ASCENT</structfield> field specifies the
+directed distance (measured up)
from the baseline to the top edge of the top-most inked pixel
in the glyph.
-<!-- .sp -->
</para>
<para>
-The DESCENT field specifies the directed distance (measured
+The <structfield>DESCENT</structfield> field specifies the
+directed distance (measured
down) from the baseline to the bottom edge of the bottom-most
inked pixel.
-<!-- .sp -->
</para>
<para>
-The ATTRIBUTES field specifies glyph-specific information that
+The <structfield>ATTRIBUTES</structfield> field specifies
+glyph-specific information that
is passed through the application. If this value is not being
used, it should be zero.
</para>
<para>
The ink bounding box of a glyph is defined to be the smallest
rectangle that encloses all of the inked pixels. This box has
-a width of RBEARING - LBEARING pixels and a height of
-ASCENT + DESCENT pixels.
+a width of
+<structfield>RBEARING</structfield> − <structfield>LBEARING</structfield>
+pixels and a height of
+<structfield>ASCENT</structfield> + <structfield>DESCENT</structfield> pixels.
</para>
-</blockquote>
-
-<literallayout class="monospaced">
-XFONTINFO: [ flags: CARD32,
- drawing-direction: { LeftToRight, RightToLeft }
- char-range: RANGE,
- default-char: CHAR2B,
- min-bounds: XCHARINFO,
- max-bounds: XCHARINFO,
- font-ascent: INT16,
- font-descent: INT16,
- properties: PROPINFO ]
-</literallayout>
-
-<blockquote>
+</section>
+
+<section id="Data_Types:XFONTINFO">
+ <title><type>XFONTINFO</type></title>
+ <indexterm zone="Data_Types:XFONTINFO" significance="preferred"><primary>XFONTINFO</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry morerows='8'><type>XFONTINFO</type>:</entry>
+ <entry>[ <structfield>flags</structfield>:</entry><entry><type>CARD32</type>,</entry></row>
+ <row><entry> <structfield>drawing-direction</structfield>:</entry><entry>{ <constant>LeftToRight</constant>, <constant>RightToLeft</constant> }</entry></row>
+ <row><entry> <structfield>char-range</structfield>:</entry><entry><link linkend="Data_Types:RANGE"><type>RANGE</type></link>,</entry></row>
+ <row><entry> <structfield>default-char</structfield>:</entry><entry><link linkend="Data_Types:CHAR2B"><type>CHAR2B</type></link>,</entry></row>
+ <row><entry> <structfield>min-bounds</structfield>:</entry><entry><link linkend="Data_Types:XCHARINFO"><type>XCHARINFO</type></link>,</entry></row>
+ <row><entry> <structfield>max-bounds</structfield>:</entry><entry><link linkend="Data_Types:XCHARINFO"><type>XCHARINFO</type></link>,</entry></row>
+ <row><entry> <structfield>font-ascent</structfield>:</entry><entry><type>INT16</type>,</entry></row>
+ <row><entry> <structfield>font-descent</structfield>:</entry><entry><type>INT16</type>,</entry></row>
+ <row><entry> <structfield>properties</structfield>:</entry><entry><link linkend="Data_Types:PROPINFO"><type>PROPINFO</type></link> ]</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This structure specifies attributes related to the font as a
whole.
</para>
<para>
-The FLAGS field is a bit mask containing zero or more of the
-following boolean values (unspecified bits must be zero):
- </para>
-
-<literallayout class="monospaced">
- AllCharactersExist (1 << 0)
- InkInside (1 << 1)
- HorizontalOverlap (1 << 2)
-</literallayout>
+The <structfield>FLAGS</structfield> field is a bit mask containing zero
+or more of the following boolean values (unspecified bits must be zero):
+
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><constant>AllCharactersExist</constant></entry><entry><literal>(1 << 0)</literal></entry></row>
+ <row><entry><constant>InkInside</constant></entry><entry><literal>(1 << 1)</literal></entry></row>
+ <row><entry><constant>HorizontalOverlap</constant></entry><entry><literal>(1 << 2)</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <para>
which have the following meanings:
- </para>
- <para>
-AllCharactersExist
- </para>
-
-<blockquote>
- <para>
-If this bit is set, all of the characters
-in the range given by CHAR-RANGE have glyphs encoded in
+<variablelist>
+ <varlistentry id="Constant:AllCharactersExist">
+ <term><constant>AllCharactersExist</constant></term>
+ <listitem>
+ <indexterm zone="Constant:AllCharactersExist" significance="preferred"><primary>AllCharactersExist</primary></indexterm>
+ <para>
+If this bit is set, all of the characters in the range given by
+<structfield>CHAR-RANGE</structfield> have glyphs encoded in
the font. If this bit is clear, some of the characters
may not have encoded glyphs.
</para>
-</blockquote>
-
-<para>
-InkInside
-</para>
-<blockquote>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="Constant:InkInside">
+ <term><constant>InkInside</constant></term>
+ <listitem>
+ <indexterm zone="Constant:InkInside" significance="preferred"><primary>InkInside</primary></indexterm>
<para>
If this bit is set, the inked pixels of each glyph
fall within the rectangle described by the font's ascent,
this bit is clear, there may be glyphs whose ink extends
outside this rectangle.
</para>
-</blockquote>
-<para>
-HorizontalOverlap
-</para>
-<blockquote>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="Constant:HorizontalOverlap">
+ <term><constant>HorizontalOverlap</constant></term>
+ <listitem>
+ <indexterm zone="Constant:HorizontalOverlap" significance="preferred"><primary>HorizontalOverlap</primary></indexterm>
<para>
If this bit is set, the two ink bounding
boxes (smallest rectangle enclosing the inked pixels) of
this bit is clear, there are no pairs of glyphs whose ink
bounding boxes overlap.
</para>
-</blockquote>
-<para>
-The DRAWING-DIRECTION field contains a hint indicating whether
-most of the character metrics have a positive (or "LeftToRight")
-logical width or a negative ("RightToLeft") logical width. It
+ </listitem>
+ </varlistentry>
+</variablelist>
+</para>
+<para id="Data_Types:XFONTINFO.DRAWING-DIRECTION">
+ <indexterm zone="Data_Types:XFONTINFO.DRAWING-DIRECTION" significance="preferred"><primary>LeftToRight</primary></indexterm>
+ <indexterm zone="Data_Types:XFONTINFO.DRAWING-DIRECTION" significance="preferred"><primary>RightToLeft</primary></indexterm>
+The <structfield>DRAWING-DIRECTION</structfield> field contains a hint
+indicating whether most of the character metrics have a positive (or
+<quote><constant>LeftToRight</constant></quote>) logical width or a
+negative (<quote><constant>RightToLeft</constant></quote>) logical width. It
contains the following alternate values:
-</para>
-<literallayout class="monospaced">
- LeftToRight 0
- RightToLeft 1
-</literallayout>
-<para>
-The CHAR-RANGE.MIN-CHAR and CHAR-RANGE.MAX-CHAR fields specify the
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><constant>LeftToRight</constant></entry><entry><literal>0</literal></entry></row>
+ <row><entry><constant>RightToLeft</constant></entry><entry><literal>1</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
+<para>
+The <structfield>CHAR-RANGE.MIN-CHAR</structfield>
+and <structfield>CHAR-RANGE.MAX-CHAR</structfield> fields specify the
first and last character codes that have glyphs encoded in this font.
All fonts must have at least one encoded glyph (in which case the
-MIN-CHAR and MAX-CHAR are equal), but are not required to have glyphs
+<structfield>MIN-CHAR</structfield> and <structfield>MAX-CHAR</structfield>
+are equal), but are not required to have glyphs
encoded at all positions between the first and last characters.
</para>
<para>
-The DEFAULT-CHAR field specifies the character code of the glyph
+The <structfield>DEFAULT-CHAR</structfield> field specifies
+the character code of the glyph
that the client should substitute for unencoded characters. Requests
for extents or bitmaps for an unencoded character generate zero-filled
metrics and a zero-length glyph bitmap, respectively.
</para>
<para>
-The MIN-BOUNDS and MAX-BOUNDS fields contain the minimum and maximum
+The <structfield>MIN-BOUNDS</structfield> and
+<structfield>MAX-BOUNDS</structfield> fields contain the minimum and maximum
values of each of the extents field of all encoded characters in the
font (i.e. non-existent characters are ignored).
</para>
<para>
-The FONT-ASCENT and FONT-DESCENT fields specify the font designer's
+The <structfield>FONT-ASCENT</structfield> and
+<structfield>FONT-DESCENT</structfield> fields specify the font designer's
logical height of the font, above and below the baseline,
respectively. The sum of the two values is often used as the
vertical line spacing of the font. Individual glyphs are permitted
to have ascents and descents that are greater than these values.
</para>
<para>
-The PROPERTIES field contains the property data associated with
-this font.
+The <structfield>PROPERTIES</structfield> field contains the
+property data associated with this font.
</para>
<para>
This structure is padded to 32-bit alignment.
</para>
-</blockquote>
-</sect2>
+</section>
+</section>
-<sect2 id='Requests'>
+<section id='Requests'>
<title>Requests</title>
<!-- .XS -->
<!-- (SN Requests -->
<!-- .XE -->
<para>
-<!-- .LP -->
This section describes the requests that may be sent by the client and the
replies or errors that are generated in response. Versions of the protocol
with the same major version are required to be upward-compatible.
</para>
<para>
-<!-- .LP -->
Every request on a given connection is implicitly assigned a sequence number,
starting with 1, that is used in replies, error, and events. Servers are
required to generate replies and errors in the order in which the corresponding
list visible to the client between any two requests, but requests must be
processed atomically. Each request packet is at least 4 bytes long and
contains the following fields:
-</para>
-<!-- .RS -->
-<literallayout class="monospaced">
- major-opcode: CARD8
- minor-opcode: CARD8
- length: CARD16
-</literallayout>
-<para>
-<!-- .RE -->
-The MAJOR-OPCODE specifies which core request or extension package this packet
-represents. If the MAJOR-OPCODE corresponds to a core request, the
-MINOR-OPCODE contains 8 bits of request-specific data. Otherwise, the
-MINOR-OPCODE specifies which extension request this packet represents. The
-LENGTH field specifies the number of 4-byte units contained within the packet
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>major-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>minor-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>length</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
+<para>
+
+The <parameter>MAJOR-OPCODE</parameter> specifies which core request or
+extension package this packet represents. If the
+<parameter>MAJOR-OPCODE</parameter> corresponds to a core request, the
+<parameter>MINOR-OPCODE</parameter> contains 8 bits of request-specific data.
+Otherwise, the <parameter>MINOR-OPCODE</parameter> specifies which extension
+request this packet represents. The <parameter>LENGTH</parameter> field
+specifies the number of 4-byte units contained within the packet
and must be at least one. If this field contains a value greater than one it
-is followed by (LENGTH - 1) * 4 bytes of request-specific data. Unless
+is followed by (<parameter>LENGTH</parameter> - 1) * 4 bytes
+of request-specific data. Unless
otherwise specified, unused bytes are not required to be zero.
</para>
<para>
-<!-- .LP -->
If a request packet contains too little or too much data, the server returns
-a Length error. If the server runs out of internal resources (such as
-memory) while processing a request, it returns an Alloc error. If a server is
-deficient (and therefore non-compliant) and is unable to process a request, it
-may return an Implementation error. If a client uses an extension request
-without previously having issued a
-<function>QueryExtension </function>
+a <link linkend="Errors:Length"><errorname>Length</errorname></link> error.
+If the server runs out of internal
+resources (such as memory) while processing a request, it returns an
+<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link> error.
+If a server is deficient (and therefore non-compliant) and is unable to
+process a request, it may return an
+<link linkend="Errors:Implementation"><errorname>Implementation</errorname></link> error.
+If a client uses an extension request without previously having issued a
+<link linkend="Requests:QueryExtension"><function>QueryExtension</function></link>
request for that extension, the server responds with a
-<function>Request </function>
-error. If the server encounters a request
-with an unknown MAJOR-OPCODE or MINOR-OPCODE, it responds with a
-<function>Request </function>
+<link linkend="Errors:Request"><errorname>Request</errorname></link>
+error. If the server encounters a request with an unknown
+<parameter>MAJOR-OPCODE</parameter> or <parameter>MINOR-OPCODE</parameter>,
+it responds with a
+<link linkend="Errors:Request"><errorname>Request</errorname></link>
error.
At most one error is generated per request. If more than one error condition
is encountered in processing a requests, the choice of which error is returned
is server-dependent.
</para>
<para>
-<!-- .LP -->
-Core requests have MAJOR-OPCODE values between 0 and 127, inclusive. Extension
-requests have MAJOR-OPCODE values between 128 and 255, inclusive, that are
-assigned by by the server. All MINOR-OPCODE values in extension requests are
+Core requests have <parameter>MAJOR-OPCODE</parameter> values between 0 and
+127, inclusive. Extension requests have <parameter>MAJOR-OPCODE</parameter>
+values between 128 and 255, inclusive, that are assigned by by the server.
+All <parameter>MINOR-OPCODE</parameter> values in extension requests are
between 0 and 255, inclusive.
</para>
<para>
-<!-- .LP -->
Each reply is at least 8 bytes long and contains the following fields:
-</para>
-<!-- .RS -->
-<literallayout class="monospaced">
- type: CARD8 value of 0
- data-or-unused: CARD8
- sequence-number: CARD16
- length: CARD32
-</literallayout>
-<para>
-<!-- .RE -->
-The TYPE field has a value of zero. The DATA-OR-UNUSED field may be used to
-encode one byte of reply-specific data (see Section 5.2 on request encoding).
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>type</parameter>:</entry><entry><type>CARD8</type></entry><entry>value of 0</entry></row>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>sequence-number</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ <row><entry><parameter>length</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
+<para>
+The <parameter>TYPE</parameter> field has a value of zero.
+The <parameter>DATA-OR-UNUSED</parameter> field may be used to
+encode one byte of reply-specific data (see
+<link linkend="Encoding::Requests">Section 5.2 on request encoding</link>).
The least-significant 16 bits of the sequence number of the request that
-generated the reply are stored in the SEQUENCE-NUMBER field. The LENGTH field
-specifies the number of 4-byte units in this reply packet, including the fields
-described above, and must be at least two. If LENGTH is greater than two, the
-fields described above are followed by (LENGTH - 2) * 4 bytes of additional
-data.
+generated the reply are stored in the <parameter>SEQUENCE-NUMBER</parameter>
+field. The <parameter>LENGTH</parameter> field specifies the number of
+4-byte units in this reply packet, including the fields described above,
+and must be at least two. If <parameter>LENGTH</parameter> is greater
+than two, the fields described above are followed by
+(<parameter>LENGTH</parameter> - 2) * 4 bytes of additional data.
</para>
<para>
-<!-- .LP -->
Requests that have replies are described using the following syntax:
-</para>
-<!-- .RS -->
-<literallayout class="monospaced">
- RequestName
- <emphasis remap='I'>arg1</emphasis>: type1
- <emphasis remap='I'>arg2</emphasis>: type2
- ...
- <emphasis remap='I'>argN</emphasis>: typeN
- =>
- <emphasis remap='I'>result1</emphasis>: type1
- <emphasis remap='I'>result2</emphasis>: type2
- ...
- <emphasis remap='I'>resultM</emphasis>: typeM
-
- Errors: <emphasis remap='I'>kind1</emphasis>, <emphasis remap='I'>kind2</emphasis> ..., <emphasis remap='I'>kindK</emphasis>
-
- Description
-</literallayout>
-<para>
-<!-- .RE -->
-If a request does not generate a reply, the"=>" and result lines are
-omitted. If a request may generate multiple replies, the "=>" is replaced by
-a "=>+". In the authorization data exchanges in the initial connection setup
-and the CreateAC request, "->" indicates data sent by the client in response
+ <blockquote><para>
+ <emphasis role="bold"><function>RequestName</function></emphasis>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>arg1</parameter>:</entry><entry><type>type1</type></entry></row>
+ <row><entry><parameter>arg2</parameter>:</entry><entry><type>type2</type></entry></row>
+ <row><entry> ...</entry></row>
+ <row><entry><parameter>argN</parameter>:</entry><entry><type>typeN</type></entry></row>
+ <row><entry> ▶</entry></row>
+ <row><entry><parameter>result1</parameter>:</entry><entry><type>type1</type></entry></row>
+ <row><entry><parameter>result2</parameter>:</entry><entry><type>type2</type></entry></row>
+ <row><entry> ...</entry></row>
+ <row rowsep="1"><entry><parameter>resultM</parameter>:</entry><entry><type>typeM</type></entry></row>
+ <row><entry>Errors:</entry><entry><errorname>kind1</errorname>, <errorname>kind2</errorname> ..., <errorname>kindK</errorname></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ Description
+ </para></blockquote>
+</para>
+<para>
+If a request does not generate a reply, the ▶ and result lines are
+omitted. If a request may generate multiple replies, the ▶ is replaced by
+a ▶+. In the authorization data exchanges in the initial connection setup
+and the CreateAC request, ◀ indicates data sent by the client in response
to data sent by the server.
</para>
<para>
-<!-- .LP -->
The protocol begins with the establishment of a connection over a
mutually-understood virtual stream:
</para>
-<literallayout class="monospaced">
-
- open connection
- byte-order: BYTE
- client-major-protocol-version: CARD16
- client-minor-protocol-version: CARD16
- authorization-protocols: LISTofAUTH
-</literallayout>
-<para>
-The initial byte of the connection specifies the BYTE-ORDER in
+<section id="Requests:open_connection">
+ <title>open connection</title>
+ <indexterm zone="Requests:open_connection" significance="preferred"><primary>open connection</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='2.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>byte-order</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>BYTE</type></link></entry></row>
+ <row><entry><parameter>client-major-protocol-version</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ <row><entry><parameter>client-minor-protocol-version</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ <row><entry><parameter>authorization-protocols</parameter>:</entry><entry><link linkend="Data_Types:AUTH"><type>LISTofAUTH</type></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+<para>
+The initial byte of the connection specifies the
+<parameter>BYTE-ORDER</parameter> in
which subsequent 16-bit and 32-bit numeric values are to be
-transmitted. The octal value 102 (ASCII uppercase `B')
+transmitted. The octal value <literal>102</literal>
+(<acronym>ASCII</acronym> uppercase <quote><literal>B</literal></quote>)
indicates that the most-significant byte is to be transmitted
-first; the octal value 154 (ASCII lowercase `l') indicates
-that the least-significant byte is to be transmitted first.
+first; the octal value <literal>154</literal>
+(<acronym>ASCII</acronym> lowercase <quote><literal>l</literal></quote>)
+indicates that the least-significant byte is to be transmitted first.
If any other value is encountered the server closes the
connection without any response.
</para>
-
-<blockquote>
<para>
-The CLIENT-MAJOR-PROTOCOL-VERSION and
-CLIENT-MINOR-PROTOCOL-VERSION specify which version of the
+The <parameter>CLIENT-MAJOR-PROTOCOL-VERSION</parameter> and
+<parameter>CLIENT-MINOR-PROTOCOL-VERSION</parameter> specify
+which version of the
font service protocol the client would like to use. If the
client can support multiple versions, the highest version
should be given. This version of the protocol has a
major version of 2 and a minor version of 0.
</para>
<para>
-The AUTHORIZATION-PROTOCOLS contains a list of protocol names and
+The <parameter>AUTHORIZATION-PROTOCOLS</parameter>
+contains a list of protocol names and
optional initial data for which the client can provide
information. The server may use this to determine which
protocol to use or as part of the initial exchange of
authorization data.
</para>
-<literallayout class="monospaced">
-=>
-status: { Success, Continue,
- Busy, Denied }
-server-major-protocol-version: CARD16
-server-minor-protocol-version: CARD16
-alternate-servers-hint: LISTofALTERNATESERVER
-authorization-index: CARD8
-authorization-data: LISTofBYTE
-</literallayout>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='2.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry>▶</entry></row>
+ <row><entry><parameter>status</parameter>:</entry><entry>{ <constant>Success</constant>, <constant>Continue</constant>,
+ <constant>Busy</constant>, <constant>Denied</constant> }</entry></row>
+ <row><entry><parameter>server-major-protocol-version</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ <row><entry><parameter>server-minor-protocol-version</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ <row><entry><parameter>alternate-servers-hint</parameter>:</entry><entry><link linkend="Data_Types:ALTERNATESERVER"><type>LISTofALTERNATESERVER</type></link></entry></row>
+ <row><entry><parameter>authorization-index</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>authorization-data</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
-<!-- .RE -->
-The SERVER-MAJOR-PROTOCOL-VERSION and
-SERVER-MINOR-PROTOCOL-VERSION specify the version of the font
+The <parameter>SERVER-MAJOR-PROTOCOL-VERSION</parameter> and
+<parameter>SERVER-MINOR-PROTOCOL-VERSION</parameter> specify
+the version of the font
service protocol that the server expects from the client. If
the server supports the version specified by the client, this
version number should be returned. If the client has
can match this version of the protocol.
</para>
<para>
-The ALTERNATE-SERVERS-HINT is a list of other font servers
+The <parameter>ALTERNATE-SERVERS-HINT</parameter>
+is a list of other font servers
that may have related sets of fonts (determined by means
outside this protocol, typically by the system administrator).
Clients may choose to contact these font servers if the
connection is rejected or lost.
</para>
<para>
-The STATUS field indicates whether the server accepted,
+The <parameter>STATUS</parameter> field indicates whether the server accepted,
rejected, or would like more information about the connection.
It has one of the following alternate values:
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='2.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><constant>Success</constant></entry><entry><literal>0</literal></entry></row>
+ <row><entry><constant>Continue</constant></entry><entry><literal>1</literal></entry></row>
+ <row><entry><constant>Busy</constant></entry><entry><literal>2</literal></entry></row>
+ <row><entry><constant>Denied</constant></entry><entry><literal>3</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</para>
-<literallayout class="monospaced">
-
- Success 0
- Continue 1
- Busy 2
- Denied 3
-</literallayout>
<para>
-<!-- .RE -->
-If STATUS is Denied, the server has rejected the client's
-authorization information. If STATUS is Busy, the server has
+If <parameter>STATUS</parameter> is <constant>Denied</constant>,
+the server has rejected the client's authorization information.
+If <parameter>STATUS</parameter> is <constant>Busy</constant>, the server has
simply decided that it cannot provide fonts to this client at
this time (it may be able to at a later time). In both cases,
-AUTHORIZATION-INDEX is set to zero, no authorization-data is
+<parameter>AUTHORIZATION-INDEX</parameter> is set to zero,
+no authorization-data is
returned, and the server closes the connection after sending
the data described so far.
</para>
<para>
-Otherwise the AUTHORIZATION-INDEX is set to the index
-(beginning with 1) into the AUTHORIZATION-PROTOCOLS list of
-the protocol that the server will use for this connection. If
+Otherwise the <parameter>AUTHORIZATION-INDEX</parameter> is set to the index
+(beginning with 1) into the <parameter>AUTHORIZATION-PROTOCOLS</parameter>
+list of the protocol that the server will use for this connection. If
the server does not want to use any of the given protocols,
-this value is set to zero. The AUTHORIZATION-DATA field is
-used to send back authorization protocol-dependent data to the
+this value is set to zero. The <parameter>AUTHORIZATION-DATA</parameter>
+field is used to send back authorization protocol-dependent data to the
client (such as a challenge, authentication of the server,
etc.).
</para>
-</blockquote>
-
<para>
-<!-- .LP -->
-If STATUS is Success, the following section of protocol is
-omitted. Otherwise, if STATUS is Continue, the server expects
+If <parameter>STATUS</parameter> is <constant>Success</constant>,
+the following section of protocol is omitted. Otherwise, if
+<parameter>STATUS</parameter> is <constant>Continue</constant>,
+the server expects
more authorization data from the client (i.e. the connection
setup is not finished, so no requests or events may be sent):
-</para>
-
-<literallayout class="monospaced">
-->
-more-authorization-data: STRING8
-=>
-status: { Success, Continue,
- Busy, Denied }
-more-authorization-data: LISTofBYTE
-</literallayout>
-
-<!-- .RE -->
-<para>
-The values in STATUS have the same meanings as described
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry>◀</entry></row>
+ <row><entry><parameter>more-authorization-data</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry>▶</entry></row>
+ <row><entry><parameter>status</parameter>:</entry><entry>{ <constant>Success</constant>, <constant>Continue</constant>, <constant>Busy</constant>, <constant>Denied</constant> }</entry></row>
+ <row><entry><parameter>more-authorization-data</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
+<para>
+The values in <parameter>STATUS</parameter> have the same meanings as described
above. This section of protocol is repeated until the server
-either accepts (sets STATUS to Success) or rejects (sets
-STATUS to Denied or Busy) the connection.
+either accepts (sets <parameter>STATUS</parameter> to
+<constant>Success</constant>) or rejects (sets <parameter>STATUS</parameter>
+to <constant>Denied</constant> or <constant>Busy</constant>) the connection.
</para>
<para>
-<!-- .LP -->
-Once the connection has been accepted and STATUS is Success,
+Once the connection has been accepted and <parameter>STATUS</parameter>
+is <constant>Success</constant>,
an implicit AccessContext is created for the authorization
data and the protocol continues with the following data sent
from the server:
-</para>
-<!-- .RS -->
-<literallayout class="monospaced">
-=>
-remaining-length: CARD32
-maximum-request-length: CARD16
-release-number: CARD32
-vendor: STRING8
-</literallayout>
-<para>
-The REMAINING-LENGTH specifies the length in 4-byte units of
-the remaining data to be transmitted to the client. The
-MAXIMUM-REQUEST-LENGTH specifies the largest request size in
-4-byte units that is accepted by the server and must have a
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry>▶</entry></row>
+ <row><entry><parameter>remaining-length</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row><entry><parameter>maximum-request-length</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ <row><entry><parameter>release-number</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row><entry><parameter>vendor</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</para>
+<para>
+The <parameter>REMAINING-LENGTH</parameter> specifies the length in 4-byte
+units of the remaining data to be transmitted to the client. The
+<parameter>MAXIMUM-REQUEST-LENGTH</parameter> specifies the largest request
+size in 4-byte units that is accepted by the server and must have a
value of at least 4096. Requests with a length field larger
-than this value are ignored and a Length error is returned.
-The VENDOR string specifies the name of the manufacturer of
-the font server. The RELEASE-NUMBER specifies the particular
+than this value are ignored and a
+<link linkend="Errors:Length"><errorname>Length</errorname></link>
+error is returned.
+The <parameter>VENDOR</parameter> string specifies the name of the
+manufacturer of the font server. The
+<parameter>RELEASE-NUMBER</parameter> specifies the particular
release of the server in a manufacturer-dependent manner.
</para>
+</section>
+<section><title />
<para>
-<!-- .LP -->
After the connection is established and the setup information has been
exchanged, the client may issue any of requests described below:
</para>
-<blockquote>
-<para>
-<!-- .LP -->
-<!-- .IN "NoOp" "" "@DEF@" -->
-<function>NoOp</function>
-</para>
- <para>
-Errors: Alloc
- </para>
+</section>
+<section id="Requests:NoOp">
+ <title><function>NoOp</function></title>
+ <indexterm zone="Requests:NoOp" significance="preferred"><primary>NoOp</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request does nothing. It is typically used in response
to a
-<function>KeepAlive </function>
+<link linkend="Events:KeepAlive"><function>KeepAlive</function></link>
event.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "ListExtensions" "" "@DEF@" -->
-<function>ListExtensions</function>
-</para>
-<para>
-=>
-</para>
+</section>
+
+<section id="Requests:ListExtensions">
+ <title><function>ListExtensions</function></title>
+ <indexterm zone="Requests:ListExtensions" significance="preferred"><primary>ListExtensions</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry>▶</entry></row>
+ <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>LISTofSTRING8</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
-<blockquote>
<para>
-<emphasis remap='I'>names</emphasis>: LISTofSTRING8
+This request returns the names of the extension packages
+that are supported by the server. Extension names are
+case-sensitive and are encoded in <acronym>ISO</acronym> 8859-1.
</para>
+
+</section>
+
+<section id="Requests:QueryExtension">
+ <title><function>QueryExtension</function></title>
+ <indexterm zone="Requests:QueryExtension" significance="preferred"><primary>QueryExtension</primary></indexterm>
+
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>name</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry>▶</entry></row>
+ <row><entry><parameter>present</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ <row><entry><parameter>major-version</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ <row><entry><parameter>minor-version</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ <row><entry><parameter>major-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>first-event</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>number-events</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>first-error</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row rowsep='1'><entry><parameter>number-errors</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
-Errors: Alloc
+This request determines whether or not the extension package specified by
+<parameter>NAME</parameter> (encoded in <acronym>ISO</acronym> 8859-1) is
+supported by the server and that there is sufficient number of major opcode,
+event, and error codes available. If so, then <parameter>PRESENT</parameter>
+is set to <constant>True</constant>, <parameter>MAJOR-VERSION</parameter>
+and <parameter>MINOR-VERSION</parameter> are set to the
+respective major and minor version numbers of the protocol
+that the server would prefer; <parameter>MAJOR-OPCODE</parameter> is set to
+the value to use in extension requests; <parameter>FIRST-EVENT</parameter>
+is set to the value of the first extension-specific event code or zero if the
+extension does not have any events; <parameter>NUMBER-EVENTS</parameter> is
+set to the number of new events that the event defines;
+<parameter>FIRST-ERROR</parameter>
+is set to the value of the first extension-specific error code
+or zero if the extension does not define any new errors; and
+<parameter>NUMBER-ERRORS</parameter> is set to the number of
+new errors the extension defines.
</para>
<para>
-This request returns the names of the extension packages
-that are supported by the server. Extension names are
-case-sensitive and are encoded in ISO 8859-1.
+Otherwise, <parameter>PRESENT</parameter> is set to
+<constant>False</constant> and the remaining fields are
+set to zero.
</para>
-</blockquote>
-
-<para>
-<!-- .IN "QueryExtension" "" "@DEF@" -->
-<function>QueryExtension</function>
-</para>
-
-<blockquote>
-<para>
-<emphasis remap='I'>name</emphasis>: STRING8
-</para>
-</blockquote>
-<para>
-=>
-</para>
-
-<blockquote>
<para>
-<emphasis remap='I'>present</emphasis>: BOOL
- </para>
- <para>
-<emphasis remap='I'>major-version</emphasis>: CARD16
- </para>
- <para>
-<emphasis remap='I'>minor-version</emphasis>: CARD16
- </para>
- <para>
-<emphasis remap='I'>major-opcode</emphasis>: CARD8
- </para>
- <para>
-<emphasis remap='I'>first-event</emphasis>: CARD8
- </para>
- <para>
-<emphasis remap='I'>number-events</emphasis>: CARD8
- </para>
- <para>
-<emphasis remap='I'>first-error</emphasis>: CARD8
- </para>
- <para>
-<emphasis remap='I'>number-errors</emphasis>: CARD8
- </para>
- <para>
-Errors:
-<function>Alloc</function>
- </para>
- <para>
-This request determines whether or not the extension package
-specified by NAME (encoded in ISO 8859-1) is supported by the
-server and that there is sufficient number of major opcode,
-event, and error codes available. If so, then PRESENT is set
-to True, MAJOR-VERSION and MINOR-VERSION are set to the
-respective major and minor version numbers of the protocol
-that the server would prefer; MAJOR-OPCODE is set to the value
-to use in extension requests; FIRST-EVENT is set to the value
-of the first extension-specific event code or zero if the
-extension does not have any events; NUMBER-EVENTS is set to
-the number of new events that the event defines; FIRST-ERROR
-is set to the value of the first extension-specific error code
-or zero if the extension does not define any new errors; and
-NUMBER-ERRORS is set to the number of new errors the extension
-defines.
- </para>
- <para>
-<!-- .sp -->
-Otherwise, PRESENT is set to False and the remaining fields are
-set to zero.
- </para>
- <para>
-<!-- .sp -->
The server is free to return different values to different
clients. Therefore, clients must use this request before
issuing any of the requests in the named extension package or
using the
-<function>SetEventMask request to express interest in any of</function>
+<link linkend="Requests:SetEventMask"><function>SetEventMask</function></link> request to express interest in any of
this extension's events. Otherwise, a
-<function>Request </function>
+<link linkend="Errors:Request"><errorname>Request</errorname></link>
error is returned.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "ListCatalogues" "" "@DEF@" -->
-<function>ListCatalogues</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>pattern</emphasis>: STRING8
- </para>
- <para>
-<emphasis remap='I'>max-names</emphasis>: CARD32
- </para>
-</blockquote>
-<para>
-<!-- .LP -->
-=>+
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>replies-following-hint</emphasis>: CARD32
- </para>
- <para>
-<emphasis remap='I'>names</emphasis>: LISTofSTRING8
- </para>
- <para>
-Errors:
-<function>Alloc</function>
- </para>
- <para>
-This request returns a list of at most MAX-NAMES names
+</section>
+
+<section id="Requests:ListCatalogues">
+ <title><function>ListCatalogues</function></title>
+ <indexterm zone="Requests:ListCatalogues" significance="preferred"><primary>ListCatalogues</primary></indexterm>
+
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry><parameter>max-names</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row><entry>▶+</entry></row>
+ <row><entry><parameter>replies-following-hint</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>LISTofSTRING8</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This request returns a list of at most <parameter>MAX-NAMES</parameter> names
of collections (called catalogues) of fonts that match
-the specified PATTERN. In the pattern (which is encoded
-in ISO 8859-1), the `?' character (octal 77) matches any
-single character; the `*' character (octal 52) matches
-any series of zero or more characters; and alphabetic
+the specified <parameter>PATTERN</parameter>. In the pattern (which is encoded
+in <acronym>ISO</acronym> 8859-1), the
+<quote><literal>?</literal></quote> character (octal <literal>77</literal>)
+matches any single character; the
+<quote><literal>*</literal></quote> character (octal <literal>52</literal>)
+matches any series of zero or more characters; and alphabetic
characters match either upper- or lowercase. The
-returned NAMES are encoded in ISO 8859-1 and may contain
+returned <parameter>NAMES</parameter> are encoded in
+<acronym>ISO</acronym> 8859-1 and may contain
mixed character cases.
</para>
<para>
-If PATTERN is of zero length or MAX-NAMES is equal to zero,
+If <parameter>PATTERN</parameter> is of zero length or
+<parameter>MAX-NAMES</parameter> is equal to zero,
one reply containing a zero-length list of names is returned.
This may be used to synchronize the client with the server.
</para>
list of names may be split across several reply packets, so
long as the names arrive in the same order that they would
have appeared had they been in a single packet. The
-REPLIES-FOLLOWING-HINT field in all but the last reply
+<parameter>REPLIES-FOLLOWING-HINT</parameter> field in all but the last reply
contains a positive value that specifies the number of
replies that are likely, but not required, to follow. In the
last reply, which may contain zero or more names, this field
is set to zero.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "SetCatalogues" "" "@DEF@" -->
-<function>SetCatalogues</function>
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>names</emphasis>: LISTofSTRING8
- </para>
- <para>
-Errors:
-<function>Alloc , </function>
-<function>Name</function>
- </para>
+</section>
+
+<section id="Requests:SetCatalogues">
+ <title><function>SetCatalogues</function></title>
+ <indexterm zone="Requests:SetCatalogues" significance="preferred"><primary>SetCatalogues</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>LISTofSTRING8</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link>,
+<link linkend="Errors:Name"><errorname>Name</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request sets the list of catalogues whose fonts should be
visible to the client. The union of the fonts provided by
each of the named catalogues forms the set of fonts whose
names match patterns in
-<function>ListFonts , </function>
-<function>ListFontsWithXInfo , </function>
+<link linkend="Requests:ListFonts"><function>ListFonts</function></link>,
+<link linkend="Requests:ListFontsWithXInfo"><function>ListFontsWithXInfo</function></link>,
and
-<function>OpenBitmapFont </function>
+<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>
requests. The catalogue names are
-case-insensitive and are encoded in ISO 8859-1. A zero-length
+case-insensitive and are encoded in <acronym>ISO</acronym> 8859-1. A zero-length
list resets the client's catalogue list to the
server-dependent default.
-<!-- .sp -->
</para>
<para>
If any of the catalogue names are invalid, a
-<function>Name </function>
+<link linkend="Errors:Name"><errorname>Name</errorname></link>
error is returned and the request is ignored.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "GetCatalogues" "" "@DEF@" -->
-<function>GetCatalogues</function>
-</para>
-
-<para>
-=>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>names</emphasis>: LISTofSTRING8
- </para>
- <para>
-Errors:
-<function>Alloc</function>
- </para>
+</section>
+
+<section id="Requests:GetCatalogues">
+ <title><function>GetCatalogues</function></title>
+ <indexterm zone="Requests:GetCatalogues" significance="preferred"><primary>GetCatalogues</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry>▶</entry></row>
+ <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>LISTofSTRING8</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request returns the current list of catalogue names
-(encoded in ISO 8859-1) associated with the client. These
+(encoded in <acronym>ISO</acronym> 8859-1) associated with the client. These
catalogues determine the set of fonts that are visible
to
-<function>ListFonts</function>,
-<function>ListFontsWithXInfo</function>,
+<link linkend="Requests:ListFonts"><function>ListFonts</function></link>,
+<link linkend="Requests:ListFontsWithXInfo"><function>ListFontsWithXInfo</function></link>,
and
-<function>OpenBitmapFont</function>.
+<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>.
A zero-length list indicates the server's default set of
fonts. Catalogue names are case-insensitive and may be
returned in mixed case.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "SetEventMask" "" "@DEF@" -->
-<function>SetEventMask</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>extension-opcode</emphasis>: CARD8
- </para>
- <para>
-<emphasis remap='I'>event-mask</emphasis>: EVENTMASK
- </para>
- <para>
-Errors:
-<function>EventMask ,</function>
-<function>Request</function>
- </para>
+</section>
+
+<section id="Requests:SetEventMask">
+ <title><function>SetEventMask</function></title>
+ <indexterm zone="Requests:SetEventMask" significance="preferred"><primary>SetEventMask</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>extension-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row rowsep='1'><entry><parameter>event-mask</parameter>:</entry><entry><link linkend="Data_Types:EVENTMASK"><type>EVENTMASK</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:EventMask"><errorname>EventMask</errorname></link>,
+<link linkend="Errors:Request"><errorname>Request</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request specifies the set of maskable events that the
-extension indicated by EXTENSION-OPCODE (or zero for the core)
+extension indicated by <parameter>EXTENSION-OPCODE</parameter>
+(or zero for the core)
should generate for the client. Event masks are limited in
scope to the extension (or core) for which they are defined,
so expressing interest in events from one or more extensions
requires multiple uses of this request.
-<!-- .sp -->
</para>
<para>
The default event mask if
-<function>SetEventMask </function>
+<function>SetEventMask</function>
has not been called
is zero, indicating no interest in any maskable events.
Some events are not maskable and cannot be blocked.
-<!-- .sp -->
</para>
<para>
-If EXTENSION-OPCODE is not a valid extension opcode previously
-returned by
-<function>QueryExtension </function>
+If <parameter>EXTENSION-OPCODE</parameter> is not a valid extension
+opcode previously returned by
+<link linkend="Requests:QueryExtension"><function>QueryExtension</function></link>
or zero, a
-<function>Request </function>
+<link linkend="Errors:Request"><errorname>Request</errorname></link>
error is
-returned. If EVENT-MASK contains any bits that do not
+returned. If <parameter>EVENT-MASK</parameter> contains any bits that do not
correspond to valid events for the specified extension (or
core), an
-<function>EventMask</function>
+<link linkend="Errors:EventMask"><errorname>EventMask</errorname></link>
error is returned and the request is
ignored.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "GetEventMask" "" "@DEF@" -->
-<function>GetEventMask</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>extension-opcode</emphasis>: CARD8
- </para>
-</blockquote>
-<para>
-=>
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>event-mask</emphasis>: EVENTMASK
- </para>
- <para>
-Errors:
-<function>Request</function>
- </para>
+</section>
+
+<section id="Requests:GetEventMask">
+ <title><function>GetEventMask</function></title>
+ <indexterm zone="Requests:GetEventMask" significance="preferred"><primary>GetEventMask</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>extension-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry>▶</entry></row>
+ <row rowsep='1'><entry><parameter>event-mask</parameter>:</entry><entry><link linkend="Data_Types:EVENTMASK"><type>EVENTMASK</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Request"><errorname>Request</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request returns the set of maskable core events the
-extension indicated by EXTENSION-OPCODE (or the core if zero)
+extension indicated by <parameter>EXTENSION-OPCODE</parameter>
+(or the core if zero)
should generate for the client. Non-maskable events are
always sent to the client.
</para>
<para>
-If EXTENSION-OPCODE is not a valid extension opcode
+If <parameter>EXTENSION-OPCODE</parameter> is not a valid extension opcode
previously returned by
-<function>QueryExtension </function>
+<link linkend="Requests:QueryExtension"><function>QueryExtension</function></link>
or zero, a
-<function>Request</function>
+<link linkend="Errors:Request"><errorname>Request</errorname></link>
error is returned.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "CreateAC" "" "@DEF@" -->
-<function>CreateAC</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>ac</emphasis>: ACCESSCONTEXT
- </para>
- <para>
-<emphasis remap='I'>authorization-protocols</emphasis>: LISTofAUTH
- </para>
-</blockquote>
-<para>
-=>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>status</emphasis>: { Success, Continue, Denied }
- </para>
- <para>
-<emphasis remap='I'>authorization-index</emphasis>: CARD8
- </para>
- <para>
-<emphasis remap='I'>authorization-data</emphasis>: LISTofBYTE
- </para>
- <para>
-Errors:
-<function>IDChoice</function>
- </para>
+</section>
+
+<section id="Requests:CreateAC">
+ <title><function>CreateAC</function></title>
+ <indexterm zone="Requests:CreateAC" significance="preferred"><primary>CreateAC</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>ac</parameter>:</entry><entry><link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link></entry></row>
+ <row><entry><parameter>authorization-protocols</parameter>:</entry><entry><link linkend="Data_Types:AUTH"><type>LISTofAUTH</type></link></entry></row>
+ <row><entry>▶</entry></row>
+ <row><entry><parameter>status</parameter>:</entry><entry>{ <constant>Success</constant>, <constant>Continue</constant>, <constant>Denied</constant> }</entry></row>
+ <row><entry><parameter>authorization-index</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row rowsep='1'><entry><parameter>authorization-data</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:IDChoice"><errorname>IDChoice</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request creates a new
-<function>AccessContext </function>
+<type>AccessContext</type>
object within the
server containing the specified authorization data. When
this
-<function>AccessContext</function>
+<type>AccessContext</type>
is selected by the client using the
-<function>SetAuthorization </function>
+<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link>
request, the data may be used by the server
to determine whether or not the client should be granted
access to particular font information.
</para>
<para>
-<!-- .sp -->
-If STATUS is Denied, the server rejects the client's
-authorization information and does not associate AC with any
-valid
-<function>AccessContext . </function>
-In this case, AUTHORIZATION-INDEX is set
-to zero, and zero bytes of AUTHORIZATION-DATA is returned.
+If <parameter>STATUS</parameter> is <constant>Denied</constant>, the server
+rejects the client's authorization information and does not associate
+<parameter>AC</parameter> with any valid <type>AccessContext</type>.
+In this case, <parameter>AUTHORIZATION-INDEX</parameter> is set
+to zero, and zero bytes of <parameter>AUTHORIZATION-DATA</parameter>
+is returned.
</para>
<para>
-<!-- .sp -->
-Otherwise, AUTHORIZATION-INDEX is set to the index (beginning
-with 1) into the AUTHORIZATION-PROTOCOLS list of the protocol
+Otherwise, <parameter>AUTHORIZATION-INDEX</parameter> is set to the index
+(beginning with 1) into the <parameter>AUTHORIZATION-PROTOCOLS</parameter>
+list of the protocol
that the server will use for this connection. If the server
does not want to use any of the given protocols, this value is
-set to zero. The AUTHORIZATION-DATA field is used to send
-back authorization protocol-dependent data to the client (such
+set to zero. The <parameter>AUTHORIZATION-DATA</parameter> field is used
+to send back authorization protocol-dependent data to the client (such
as a challenge, authentication of the server, etc.).
</para>
<para>
-<!-- .sp -->
-If STATUS is Continue, the client is expected to continue
+If <parameter>STATUS</parameter> is <constant>Continue</constant>,
+the client is expected to continue
the request by sending the following protocol and receiving
the indicated response from the server. This continues
-until STATUS is set to either Success or Denied.
- </para>
-<literallayout class="monospaced">
- ->
- more-authorization-data: STRING8
- =>
- status: { Success, Continue, Denied }
- more-authorization-data: LISTofBYTE
-</literallayout>
- <para>
-Once the connection has been accepted and STATUS is Success,
-the request is complete.
- </para>
- <para>
-If AC is not in the range [1..2^29-1] or is already associated
-with an access context, an IDChoice error is returned.
- </para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "FreeAC" "" "@DEF@" -->
-<function>FreeAC</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>ac</emphasis>: ACCESSCONTEXT
- </para>
- <para>
-Errors:
-<function>AccessContext , </function>
-<function>Alloc</function>
- </para>
- <para>
-This request indicates that the specified AC should no longer
-be associated with a valid access context. If AC is also the
-current
-<function>AccessContext</function>
+until <parameter>STATUS</parameter> is set to either
+<constant>Success</constant> or <constant>Denied</constant>.
+ </para>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry> ◀</entry></row>
+ <row><entry><parameter> more-authorization-data</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry> ▶</entry></row>
+ <row><entry><parameter>status</parameter>:</entry><entry>{ <constant>Success</constant>, <constant>Continue</constant>, <constant>Denied</constant> }</entry></row>
+ <row><entry><parameter> more-authorization-data</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+Once the connection has been accepted and <parameter>STATUS</parameter>
+is <constant>Success</constant>, the request is complete.
+ </para>
+ <para>
+If <parameter>AC</parameter> is not in the range
+[1..2<superscript>29</superscript>-1] or is already associated
+with an access context, an <link linkend="Errors:IDChoice"><errorname>IDChoice</errorname></link> error is returned.
+ </para>
+</section>
+
+<section id="Requests:FreeAC">
+ <title><function>FreeAC</function></title>
+ <indexterm zone="Requests:FreeAC" significance="preferred"><primary>FreeAC</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>ac</parameter>:</entry><entry><link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link></entry></row>
+ <row rowsep='1'><entry>Errors:</entry><entry><link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link>,
+<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This request indicates that the specified <parameter>AC</parameter> should
+no longer be associated with a valid access context.
+If <parameter>AC</parameter> is also the current
+<type>AccessContext</type>
(as set by the
-<function>SetAuthorization</function>
+<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link>
request), an implicit
-<function>SetAuthorization</function>
-of None is done to
+<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link>
+of <constant>None</constant> is done to
restore the
-<function>AccessContext</function>
+<type>AccessContext</type>
established for the initial
connection setup. Operations on fonts that were opened under
-AC are not affected. The client may reuse the value of AC in
-a subsequent
-<function>CreateAC </function>
+<parameter>AC</parameter> are not affected. The client may reuse the
+value of <parameter>AC</parameter> in a subsequent
+<link linkend="Requests:CreateAC"><function>CreateAC</function></link>
request.
</para>
<para>
-If AC isn't associated with any valid authorization previously
-created by
-<function>CreateAC , an </function>
-<function>AccessContext </function>
+If <parameter>AC</parameter> isn't associated with any valid authorization
+previously created by
+<link linkend="Requests:CreateAC"><function>CreateAC</function></link>, an
+<link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link>
error is returned.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "SetAuthorization" "" "@DEF@" -->
-<function>SetAuthorization</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>ac</emphasis>: ACCESSCONTEXT
- </para>
- <para>
-Errors:
-<function>AccessContext</function>
- </para>
+</section>
+
+<section id="Requests:SetAuthorization">
+ <title><function>SetAuthorization</function></title>
+ <indexterm zone="Requests:SetAuthorization" significance="preferred"><primary>SetAuthorization</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>ac</parameter>:</entry><entry><link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link></entry></row>
+ <row rowsep='1'><entry>Errors:</entry><entry><link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request sets the
-<function>AccessContext </function>
+<type>AccessContext</type>
to be used for subsequent
requests (except for
-<function>QueryXInfo</function>,
-<function>QueryXExtents8</function>,
-<function>QueryXExtents16</function>,
-<function>QueryXBitmaps8</function>,
-<function>QueryXBitmaps16</function>
+<link linkend="Requests:QueryXInfo"><function>QueryXInfo</function></link>,
+<link linkend="Requests:QueryXExtents8"><function>QueryXExtents8</function></link>,
+<link linkend="Requests:QueryXExtents16"><function>QueryXExtents16</function></link>,
+<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link>,
+<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link>
and
-<function>CloseFont </function>
+<link linkend="Requests:CloseFont"><function>CloseFont</function></link>
which are done under the
-<function>AccessContext </function>
+<type>AccessContext</type>
of the
corresponding
-<function>OpenBitmapFont</function>
-")."
-An AC of None restores the
-<function>AccessContext</function>
+<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>
+).
+An <parameter>AC</parameter> of <constant>None</constant> restores the
+<type>AccessContext</type>
established for the initial connection setup.
</para>
<para>
-<!-- .sp -->
-If AC is neither None nor a value associated with a valid
-<function>AccessContext</function>
+If <parameter>AC</parameter> is neither <constant>None</constant>
+nor a value associated with a valid <type>AccessContext</type>
previously created by
-<function>CreateAC</function>,
+<link linkend="Requests:CreateAC"><function>CreateAC</function></link>,
an
-<function>AccessContext</function>
+<link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link>
error is returned.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "SetResolution" "" "@DEF@" -->
-<function>SetResolution</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>resolutions</emphasis>: LISTofRESOLUTION
- </para>
- <para>
-Errors:
-<function>Resolution</function>,
-<function>Alloc</function>
- </para>
+</section>
+
+<section id="Requests:SetResolution">
+ <title><function>SetResolution</function></title>
+ <indexterm zone="Requests:SetResolution" significance="preferred"><primary>SetResolution</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row rowsep='1'><entry><parameter>resolutions</parameter>:</entry><entry><link linkend="Data_Types:RESOLUTION"><type>LISTofRESOLUTION</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Resolution"><errorname>Resolution</errorname></link>,
+<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request provides a hint as to the resolution and
preferred point size of the drawing surfaces for which the
client will be requesting fonts. The server may use this
information to set the RESOLUTION_X and RESOLUTION_Y fields
-of scalable XLFD font names, to order sets of names based on
+of scalable <acronym>XLFD</acronym> font names, to order sets of names based on
their resolutions, and to choose the server-dependent
instance that is used when a partially-specified scalable
fontname is opened.
</para>
<para>
-If a zero-length list of RESOLUTIONS is given, the
+If a zero-length list of <link linkend="Data_Types:RESOLUTION"><type>RESOLUTION</type></link>s is given, the
server-dependent default value is restored. Otherwise, if
-elements of all of the specified RESOLUTIONS are non-zero, the
+elements of all of the specified <link linkend="Data_Types:RESOLUTION"><type>RESOLUTION</type></link>s are non-zero, the
default resolutions for this client are changed.
</para>
<para>
-If a RESOLUTION entry contains a zero, a Resolution error is
+If a <link linkend="Data_Types:RESOLUTION"><type>RESOLUTION</type></link> entry contains a zero,
+a <link linkend="Errors:Resolution"><errorname>Resolution</errorname></link> error is
returned and the default resolutions are not changed.
</para>
-</blockquote>
-<para>
-<!-- .LP -->
-<!-- .IN "GetResolution" "" "@DEF@" -->
-<function>GetResolution</function>
-</para>
-<para>
-=>
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>resolutions</emphasis>: LISTofRESOLUTION
- </para>
- <para>
-Errors:
-<function>Alloc</function>
- </para>
+</section>
+
+<section id="Requests:GetResolution">
+ <title><function>GetResolution</function></title>
+ <indexterm zone="Requests:GetResolution" significance="preferred"><primary>GetResolution</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry>▶</entry></row>
+ <row rowsep='1'><entry><parameter>resolutions</parameter>:</entry><entry><link linkend="Data_Types:RESOLUTION"><type>LISTofRESOLUTION</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request returns the current list of default resolutions.
If a client has not performed a
-<function>SetResolution</function>,
+<link linkend="Requests:SetResolution"><function>SetResolution</function></link>,
a server-dependent default value is returned.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "ListFonts" "" "@DEF@" -->
-<function>ListFonts</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>pattern</emphasis>: STRING8
- </para>
- <para>
-<emphasis remap='I'>max-names</emphasis>: CARD32
- </para>
-</blockquote>
-<para>
-=>+
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>replies-following-hint</emphasis>: CARD32
- </para>
- <para>
-<emphasis remap='I'>names</emphasis>: LISTofSTRING8
- </para>
- <para>
-Errors:
-<function>Alloc</function>
- </para>
- <para>
-This request returns a list of at most MAX-NAMES font names
-that match the specified PATTERN, according to matching rules
-of the X Logical Font Description Conventions [3]. In the
-pattern (which is encoded in ISO 8859-1) the `?' character
-(octal 77) matches any single character; the `*' character
-(octal 52) matches any series of zero or more characters; and
+</section>
+
+<section id="Requests:ListFonts">
+ <title><function>ListFonts</function></title>
+ <indexterm zone="Requests:ListFonts" significance="preferred"><primary>ListFonts</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry><parameter>max-names</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row><entry>▶+</entry></row>
+ <row><entry><parameter>replies-following-hint</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>LISTofSTRING8</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This request returns a list of at most <parameter>MAX-NAMES</parameter>
+font names that match the specified <parameter>PATTERN</parameter>,
+according to matching rules
+of the <olink targetdoc='xlfd' targetptr='xlfd'><citetitle>X Logical
+Font Description Conventions</citetitle></olink>
+<xref linkend="References:xlfd-spec"/>.
+In the pattern (which is encoded in <acronym>ISO</acronym> 8859-1) the
+<quote><literal>?</literal></quote> character (octal <literal>77</literal>)
+matches any single character; the
+<quote><literal>*</literal></quote> character (octal <literal>52</literal>)
+matches any series of zero or more characters; and
alphabetic characters match either upper- or lowercase. The
-returned NAMES are encoded in ISO 8859-1 and may contain mixed
-character cases. Font names are not required to be in XLFD
+returned <parameter>NAMES</parameter> are encoded in
+<acronym>ISO</acronym> 8859-1 and may contain mixed
+character cases. Font names are not required to be in <acronym>XLFD</acronym>
format.
</para>
<para>
-If PATTERN is of zero length or MAX-NAMES is equal to zero,
+If <parameter>PATTERN</parameter> is of zero length or
+<parameter>MAX-NAMES</parameter> is equal to zero,
one reply containing a zero-length list of names is returned.
This may be used to synchronize the client with the server.
</para>
<para>
Servers are free to add or remove fonts to the set returned by
-<function>ListFonts </function>
+<function>ListFonts</function>
between any two requests. This request is not
cumulative; repeated uses are processed in isolation and do
result in an iteration through the list.
list of names may be split across several reply packets, so
long as the names arrive in the same order that they would
have appeared had they been in a single packet. The
-REPLIES-FOLLOWING-HINT field in all but the last reply
+<parameter>REPLIES-FOLLOWING-HINT</parameter> field in all but the last reply
contains a positive value that specifies the number of
replies that are likely, but not required, to follow. In the
last reply, which may contain zero or more names, this field
is set to zero.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "ListFontsWithXInfo" "" "@DEF@" -->
-<function>ListFontsWithXInfo</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>pattern</emphasis>: STRING8
- </para>
- <para>
-<emphasis remap='I'>pattern</emphasis>: STRING8
- </para>
- <para>
-<emphasis remap='I'>pattern</emphasis>: STRING8
- </para>
- <para>
-<emphasis remap='I'>max-names</emphasis>: CARD32
- </para>
-</blockquote>
-
-<para>
-=>+
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>replies-following-hint</emphasis>: CARD32
- </para>
- <para>
-<emphasis remap='I'>info</emphasis>: XFONTINFO
- </para>
- <para>
-<emphasis remap='I'>name</emphasis>: STRING8
- </para>
- <para>
-Errors:
-<function>Alloc</function>
- </para>
+</section>
+
+<section id="Requests:ListFontsWithXInfo">
+ <title><function>ListFontsWithXInfo</function></title>
+ <indexterm zone="Requests:ListFontsWithXInfo" significance="preferred"><primary>ListFontsWithXInfo</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry><parameter>max-names</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row><entry>▶+</entry></row>
+ <row><entry><parameter>replies-following-hint</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row><entry><parameter>info</parameter>:</entry><entry><link linkend="Data_Types:XFONTINFO"><type>XFONTINFO</type></link></entry></row>
+ <row rowsep='1'><entry><parameter>name</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request is similar to
-<function>ListFonts </function>
+<link linkend="Requests:ListFonts"><function>ListFonts</function></link>
except that a separate
reply containing the name, header, and property data is
generated for each matching font name. Following these
-replies, if any, a final reply containing a zero-length NAME
-and no INFO is sent.
+replies, if any, a final reply containing a zero-length
+<parameter>NAME</parameter> and no <parameter>INFO</parameter> is sent.
</para>
<para>
-<!-- .sp -->
-The REPLIES-FOLLOWING-HINT field in all but the last reply
-contains a positive value that specifies the number of replies
+The <parameter>REPLIES-FOLLOWING-HINT</parameter> field in all but the
+last reply contains a positive value that specifies the number of replies
that are likely, but not required, to follow. In the last
reply, this field is set to zero.
</para>
<para>
-<!-- .sp -->
-If PATTERN is of zero length or if MAX-NAMES is equal to
-zero, only the final reply containing a zero-length NAME and
-no INFO is returned. This may be used to synchronize the
+If <parameter>PATTERN</parameter> is of zero length or if
+<parameter>MAX-NAMES</parameter> is equal to zero, only the final reply
+containing a zero-length <parameter>NAME</parameter> and no
+<parameter>INFO</parameter> is returned. This may be used to synchronize the
client with the server.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "OpenBitmapFont" "" "@DEF@" -->
-<function>OpenBitmapFont</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>fontid</emphasis>: FONTID
- </para>
- <para>
-<emphasis remap='I'>pattern</emphasis>: STRING8
- </para>
- <para>
-<emphasis remap='I'>format-mask</emphasis>: BITMAPFORMATMASK
- </para>
- <para>
-<emphasis remap='I'>format-hint</emphasis>: BITMAPFORMAT
- </para>
-</blockquote>
-
-<para>
-=>
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>otherid</emphasis>: FONTID or None
- </para>
- <para>
-<emphasis remap='I'>otherid-valid</emphasis>: BOOL
- </para>
- <para>
-<emphasis remap='I'>cachable</emphasis>: BOOL
- </para>
- <para>
-Errors:
-<function>IDChoice</function>,
-<function>Name</function>,
-<function>Format</function>,
-<function>AccessContext</function>,
-<function>Alloc</function>
- </para>
+</section>
+
+<section id="Requests:OpenBitmapFont">
+ <title><function>OpenBitmapFont</function></title>
+ <indexterm zone="Requests:OpenBitmapFont" significance="preferred"><primary>OpenBitmapFont</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row>
+ <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry><parameter>format-mask</parameter>:</entry><entry><link linkend="Data_Types:BITMAPFORMATMASK"><type>BITMAPFORMATMASK</type></link></entry></row>
+ <row><entry><parameter>format-hint</parameter>:</entry><entry><link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link></entry></row>
+ <row><entry>▶</entry></row>
+ <row><entry><parameter>otherid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link> or <constant>None</constant></entry></row>
+ <row><entry><parameter>otherid-valid</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ <row rowsep='1'><entry><parameter>cachable</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ <row><entry>Errors:</entry><entry>
+<link linkend="Errors:IDChoice"><errorname>IDChoice</errorname></link>,
+<link linkend="Errors:Name"><errorname>Name</errorname></link>,
+<link linkend="Errors:Format"><errorname>Format</errorname></link>,
+<link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link>,
+<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request looks for a server-dependent choice of the
-font names that match the specified PATTERN according to the
-rules described for
-<function>ListFonts . </function>
+font names that match the specified <parameter>PATTERN</parameter>
+according to the rules described for
+<link linkend="Requests:ListFonts"><function>ListFonts</function></link>.
If no matches are found, a
-<function>Name </function>
+<link linkend="Errors:Name"><errorname>Name</errorname></link>
error is returned. Otherwise, the server attempts to
open the font associated with the chosen name.
</para>
Permission to access the font is determined by the server
according the licensing policy used for this font. The server
may use the client's current
-<function>AccessContext</function>
+<type>AccessContext</type>
(as set by the most
recent
-<function>SetAuthorization </function>
+<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link>
request or the original connection
setup) to determine any client-specific sets of permissions.
After the font has been opened, the client is allowed to
specify a new
-<function>AccessContext</function>
+<type>AccessContext</type>
with
-<function>SetAuthorization</function>
+<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link>
or release
the
-<function>AccessContext</function>
+<type>AccessContext</type>
using
-<function>FreeAC</function>
+<link linkend="Requests:FreeAC"><function>FreeAC</function></link>
. Subsequent
-<function>QueryXInfo</function>,
-<function>QueryXExtents8</function>,
-<function>QueryXExtents16</function>,
-<function>QueryXBitmaps8</function>,
-<function>QueryXBitmaps16</function>
+<link linkend="Requests:QueryXInfo"><function>QueryXInfo</function></link>,
+<link linkend="Requests:QueryXExtents8"><function>QueryXExtents8</function></link>,
+<link linkend="Requests:QueryXExtents16"><function>QueryXExtents16</function></link>,
+<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link>,
+<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link>
and
-<function>CloseFont</function>
-requests on this FONTID are
+<link linkend="Requests:CloseFont"><function>CloseFont</function></link>
+requests on this <link linkend="Data_Types:FONTID"><type>FONTID</type></link> are
performed according to permissions granted at the time of the
<function>OpenBitmapFont</function>
request.
<para>
If the server is willing and able to detect that the client
has already opened the font successfully (possibly under a
-different name), the OTHERID field may be set to one of the
+different name), the <parameter>OTHERID</parameter> field
+may be set to one of the
identifiers previously used to open the font. The
-OTHERID-VALID field indicates whether or not OTHERID is
-still associated with an open font: if it is True, the
-client may use OTHERID as an alternative to FONTID.
-Otherwise, if OTHERID-VALID is False, OTHERID is no longer
+<parameter>OTHERID-VALID</parameter> field indicates whether or not
+<parameter>OTHERID</parameter> is still associated with an open font:
+if it is <constant>True</constant>, the client may use
+<parameter>OTHERID</parameter> as an alternative to
+<parameter>FONTID</parameter>. Otherwise, if
+<parameter>OTHERID-VALID</parameter> is <constant>False</constant>,
+<parameter>OTHERID</parameter> is no longer
open but has not been reused by a subsequent
<function>OpenBitmapFont</function>
request.
-<!-- .sp -->
- </para>
- <para>
-If OTHERID is set to None, then OTHERID-VALID should be set
-to False.
-<!-- .sp -->
- </para>
- <para>
-The FORMAT-MASK indicates which fields in FORMAT-HINT
-the client is likely to use in subsequent
-<function>GetXBitmaps8</function>
-and
-<function>GetXBitmaps16 </function>
-requests. Servers may wish to use
-this information to precompute certain values.
-<!-- .sp -->
</para>
<para>
-If CACHABLE is set to True, the client may cache the font
-(so that redundant opens of the same font may be avoided)
-and use it with all
-<function>AccessContexts </function>
-during the life of the
-client without violating the font's licensing policy. This
-flag is typically set whenever a font is unlicensed or is
-licensed on a per-display basis. If CACHABLE is False, the
-client should reopen the font for each
-<function>AccessContext .</function>
-<!-- .sp -->
- </para>
- <para>
-The server is permitted to add to or remove from the set of
-fonts returned by
-<function>ListFonts </function>
-between any two requests, though
-mechanisms outside the protocol. Therefore, it is possible
-for this request (which is atomic) to return a different font
-than would result from separate a
-<function> ListFonts </function>
-followed by an
-<function>OpenBitmapFont </function>
-with a non-wildcarded font name.
-<!-- .sp -->
- </para>
- <para>
-If FONTID is not in the range [1..2^29-1] or if it is already
-associated with an open font, an
-<function>IDChoice </function>
-error is returned.
-If no font is available that matches the specified PATTERN, a
-<function>Name </function>
-error is returned. If the font is present but the client
-is not permitted access, an
-<function>AccessContext </function>
-error is returned.
-If FORMAT-MASK has any unspecified bits set or if any of the
-fields in FORMAT-HINT indicated by FORMAT-MASK are invalid, a
-<function>Format </function>
-error is returned.
- </para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "QueryXInfo" "" "@DEF@" -->
-<function>QueryXInfo</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>fontid</emphasis>: FONTID
- </para>
-</blockquote>
-<para>
-=>
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>info</emphasis>: XFONTINFO
- </para>
- <para>
-Errors:
-<function>Font</function>,
-<function>Alloc</function>
- </para>
- <para>
-This request returns the font header and property information
-for the open font associated with FONTID.
- </para>
- <para>
-<!-- .sp -->
-If FONTID is not associated with any open fonts, a
-<function> Font </function>
-error
-is returned.
- </para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "QueryXExtents8" "" "@DEF@" -->
-<function>QueryXExtents8</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>fontid</emphasis>: FONTID
- </para>
- <para>
-<emphasis remap='I'>range</emphasis>: BOOL
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>chars</emphasis>: STRING8
- </para>
-</blockquote>
-<para>
-=>
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>extents</emphasis>: LISTofXCHARINFO
+If <parameter>OTHERID</parameter> is set to <constant>None</constant>,
+then <parameter>OTHERID-VALID</parameter> should be set
+to <constant>False</constant>.
</para>
<para>
-Errors:
-<function>Font</function>,
-<function>Range</function>,
-<function>Alloc</function>
+The <parameter>FORMAT-MASK</parameter> indicates which fields in
+<parameter>FORMAT-HINT</parameter>
+the client is likely to use in subsequent
+<function>GetXBitmaps8</function>
+and
+<function>GetXBitmaps16</function>
+requests. Servers may wish to use
+this information to precompute certain values.
</para>
<para>
-This request is equivalent to
-<function>QueryXExtents16 </function>
-except that it
-uses 1-byte character codes.
+If <parameter>CACHABLE</parameter> is set to <constant>True</constant>,
+the client may cache the font
+(so that redundant opens of the same font may be avoided)
+and use it with all
+<type>AccessContext</type>s
+during the life of the
+client without violating the font's licensing policy. This
+flag is typically set whenever a font is unlicensed or is
+licensed on a per-display basis. If <parameter>CACHABLE</parameter>
+is <constant>False</constant>, the
+client should reopen the font for each
+<type>AccessContext</type>.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "QueryXExtents16" "" "@DEF@" -->
-<function>QueryXExtents16</function>
-</para>
-<blockquote>
<para>
-<emphasis remap='I'>fontid</emphasis>: FONTID
+The server is permitted to add to or remove from the set of
+fonts returned by
+<link linkend="Requests:ListFonts"><function>ListFonts</function></link>
+between any two requests, though
+mechanisms outside the protocol. Therefore, it is possible
+for this request (which is atomic) to return a different font
+than would result from separate a
+<link linkend="Requests:ListFonts"><function>ListFonts</function></link>
+followed by an
+<function>OpenBitmapFont</function>
+with a non-wildcarded font name.
</para>
<para>
-<!-- .br -->
-<emphasis remap='I'>range</emphasis>: BOOL
+If <parameter>FONTID</parameter> is not in the range
+[1..2<superscript>29</superscript>-1] or if it is already
+associated with an open font, an
+<link linkend="Errors:IDChoice"><errorname>IDChoice</errorname></link>
+error is returned.
+If no font is available that matches the specified
+<parameter>PATTERN</parameter>, a
+<link linkend="Errors:Name"><errorname>Name</errorname></link>
+error is returned. If the font is present but the client
+is not permitted access, an
+<link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link>
+error is returned.
+If <parameter>FORMAT-MASK</parameter> has any unspecified bits set or if any
+of the fields in <parameter>FORMAT-HINT</parameter> indicated by
+<parameter>FORMAT-MASK</parameter> are invalid, a
+<link linkend="Errors:Format"><errorname>Format</errorname></link>
+error is returned.
</para>
+</section>
+
+<section id="Requests:QueryXInfo">
+ <title><function>QueryXInfo</function></title>
+ <indexterm zone="Requests:QueryXInfo" significance="preferred"><primary>QueryXInfo</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row>
+ <row><entry>▶</entry></row>
+ <row rowsep='1'><entry><parameter>info</parameter>:</entry><entry><link linkend="Data_Types:XFONTINFO"><type>XFONTINFO</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>,
+<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
-<!-- .br -->
-<emphasis remap='I'>chars</emphasis>: LISTofCHAR2B
+This request returns the font header and property information
+for the open font associated with <parameter>FONTID</parameter>.
</para>
-</blockquote>
-<para>
-=>
-</para>
-<blockquote>
<para>
-<emphasis remap='I'>extents</emphasis>: LISTofXCHARINFO
+If <parameter>FONTID</parameter> is not associated with any open fonts, a
+<link linkend="Errors:Font"><errorname>Font</errorname></link>
+error
+is returned.
</para>
+</section>
+
+<section id="Requests:QueryXExtents8">
+ <title><function>QueryXExtents8</function></title>
+ <indexterm zone="Requests:QueryXExtents8" significance="preferred"><primary>QueryXExtents8</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row>
+ <row><entry><parameter>range</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ <row><entry><parameter>chars</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry>▶</entry></row>
+ <row rowsep='1'><entry><parameter>extents</parameter>:</entry><entry><link linkend="Data_Types:XCHARINFO"><type>LISTofXCHARINFO</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>,
+<link linkend="Errors:Range"><errorname>Range</errorname></link>,
+<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
-Errors:
-<function>Font</function>,
-<function>Range</function>,
-<function>Alloc</function>
+This request is equivalent to
+<link linkend="Requests:QueryXExtents16"><function>QueryXExtents16</function></link>
+except that it
+uses 1-byte character codes.
</para>
+</section>
+
+<section id="Requests:QueryXExtents16">
+ <title><function>QueryXExtents16</function></title>
+ <indexterm zone="Requests:QueryXExtents16" significance="preferred"><primary>QueryXExtents16</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row>
+ <row><entry><parameter>range</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ <row><entry><parameter>chars</parameter>:</entry><entry><link linkend="Data_Types:CHAR2B"><type>LISTofCHAR2B</type></link></entry></row>
+ <row><entry>▶</entry></row>
+ <row rowsep='1'><entry><parameter>extents</parameter>:</entry><entry><link linkend="Data_Types:XCHARINFO"><type>LISTofXCHARINFO</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>,
+<link linkend="Errors:Range"><errorname>Range</errorname></link>,
+<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request returns a list of glyph extents from the open
font associated with FONTID for the series of characters
-specified by RANGE and CHARS.
+specified by <parameter>RANGE</parameter> and <parameter>CHARS</parameter>.
</para>
<para>
-<!-- .sp -->
-If RANGE is True, each succeeding pair of elements in CHARS is
+If <parameter>RANGE</parameter> is <constant>True</constant>,
+each succeeding pair of elements in <parameter>CHARS</parameter> is
treated as a range of characters for which extents should be
-returned. If CHARS contains an odd number of elements, the
-font's XFONTINFO.CHAR-RANGE.MAX-CHAR is implicitly appended to
-the list. If CHARS contains no elements, the list is
-implicitly replaced with the font's XFONTINFO.CHAR-RANGE. If
-any of the resulting character ranges are invalid, a Range
+returned. If <parameter>CHARS</parameter> contains an odd number of elements,
+the font's <structfield>XFONTINFO.CHAR-RANGE.MAX-CHAR</structfield>
+is implicitly appended to
+the list. If <parameter>CHARS</parameter> contains no elements, the list is
+implicitly replaced with the font's
+<structfield>XFONTINFO.CHAR-RANGE.</structfield> If
+any of the resulting character ranges are invalid, a
+<link linkend="Errors:Range"><errorname>Range</errorname></link>
error is returned. Otherwise, the character ranges are
-concatenated in the order given by CHARS to produce a set of
-character codes for which extents are returned.
+concatenated in the order given by <parameter>CHARS</parameter> to produce
+a set of character codes for which extents are returned.
</para>
<para>
-<!-- .sp -->
-If RANGE is False, then CHARS specifies the set of character
-codes for which extents are returned. If CHARS is of
+If <parameter>RANGE</parameter> is <constant>False</constant>,
+then <parameter>CHARS</parameter> specifies the set of character
+codes for which extents are returned. If <parameter>CHARS</parameter> is of
zero length, then a zero-length list of extents is returned.
</para>
<para>
-<!-- .sp -->
The extents for each character code in the resulting set (which
may contain duplicates) are returned in the order in
which the character codes appear in the set.
with non-zero but equal left and right bearings.
</para>
<para>
-<!-- .sp -->
-If FONTID is not associated with any open fonts, a
-<function>Font</function>
+If <parameter>FONTID</parameter> is not associated with any open fonts, a
+<link linkend="Errors:Font"><errorname>Font</errorname></link>
error is
-returned. If RANGE is True and CHARS contains any invalid
-ranges, a
-<function>Range</function>
+returned. If <parameter>RANGE</parameter> is <constant>True</constant>
+and <parameter>CHARS</parameter> contains any invalid ranges, a
+<link linkend="Errors:Range"><errorname>Range</errorname></link>
error is returned.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "QueryXBitmaps8" "" "@DEF@" -->
-<function>QueryXBitmaps8</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>fontid</emphasis>: FONTID
- </para>
- <para>
-<emphasis remap='I'>range</emphasis>: BOOL
- </para>
- <para>
-<emphasis remap='I'>chars</emphasis>: STRING8
- </para>
- <para>
-<emphasis remap='I'>format</emphasis>: BITMAPFORMAT
- </para>
-</blockquote>
-<para>
-=>+
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>replies-following-hint</emphasis>: CARD32
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>offsets</emphasis>: LISTofOFFSET32
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>bitmaps</emphasis>: LISTofBYTE
- </para>
- <para>
-Errors:
-<function>Font</function>,
-<function>Range</function>,
-<function>Format</function>,
-<function>Alloc</function>
- </para>
+</section>
+
+<section id="Requests:QueryXBitmaps8">
+ <title><function>QueryXBitmaps8</function></title>
+ <indexterm zone="Requests:QueryXBitmaps8" significance="preferred"><primary>QueryXBitmaps8</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row>
+ <row><entry><parameter>range</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ <row><entry><parameter>chars</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row>
+ <row><entry><parameter>format</parameter>:</entry><entry><link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link></entry></row>
+ <row><entry>▶+</entry></row>
+ <row><entry><parameter>replies-following-hint</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row><entry><parameter>offsets</parameter>:</entry><entry><link linkend="Data_Types:OFFSET32"><type>LISTofOFFSET32</type></link></entry></row>
+ <row><entry><parameter>bitmaps</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row>
+ <row rowsep='1'><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>,
+<link linkend="Errors:Range"><errorname>Range</errorname></link>,
+<link linkend="Errors:Format"><errorname>Format</errorname></link>,
+<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This request is equivalent to
-<function>QueryXBitmaps16 </function>
+<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link>
except that it
uses 1-byte character codes.
</para>
-</blockquote>
-<para>
-<!-- .LP -->
-<!-- .IN "QueryXBitmaps16" "" "@DEF@" -->
-<function>QueryXBitmaps16</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>fontid</emphasis>: FONTID
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>range</emphasis>: BOOL
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>chars</emphasis>: LISTofCHAR2B
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>format</emphasis>: BITMAPFORMAT
- </para>
-</blockquote>
-<para>
-=>+
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>replies-following-hint</emphasis>: CARD32
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>offsets</emphasis>: LISTofOFFSET32
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>bitmaps</emphasis>: LISTofBYTE
- </para>
- <para>
-Errors:
-<function>Font</function>,
-<function>Range</function>,
-<function>Format</function>,
-<function>Alloc</function>
- </para>
- <para>
-This request returns a list of glyph bitmaps from the open
-font associated with FONTID for the series of characters
-specified by RANGE and CHARS.
- </para>
- <para>
-<!-- .sp -->
-If RANGE is True, each succeeding pair of elements in CHARS is
+</section>
+
+<section id="Requests:QueryXBitmaps16">
+ <title><function>QueryXBitmaps16</function></title>
+ <indexterm zone="Requests:QueryXBitmaps16" significance="preferred"><primary>QueryXBitmaps16</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row>
+ <row><entry><parameter>range</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ <row><entry><parameter>chars</parameter>:</entry><entry><link linkend="Data_Types:CHAR2B"><type>LISTofCHAR2B</type></link></entry></row>
+ <row><entry><parameter>format</parameter>:</entry><entry><link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link></entry></row>
+ <row><entry>▶+</entry></row>
+ <row><entry><parameter>replies-following-hint</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row><entry><parameter>offsets</parameter>:</entry><entry><link linkend="Data_Types:OFFSET32"><type>LISTofOFFSET32</type></link></entry></row>
+ <row rowsep='1'><entry><parameter>bitmaps</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>,
+ <link linkend="Errors:Range"><errorname>Range</errorname></link>,
+ <link linkend="Errors:Format"><errorname>Format</errorname></link>,
+ <link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This request returns a list of glyph bitmaps from the open font associated
+with <parameter>FONTID</parameter> for the series of characters
+specified by <parameter>RANGE</parameter> and <parameter>CHARS</parameter>.
+ </para>
+ <para>
+If <parameter>RANGE</parameter> is <constant>True</constant>, each succeeding
+pair of elements in <parameter>CHARS</parameter> is
treated as a range of characters for which bitmaps should be
-returned. If CHARS contains an odd number of elements, the
-font's XFONTINFO.CHAR-RANGE.MAX-CHAR is implicitly appended to
-the list. If CHARS contains no elements, the list is
-implicitly replaced with the font's XFONTINFO.CHAR-RANGE. If
-any of the resulting character ranges are invalid, a Range
+returned. If <parameter>CHARS</parameter> contains an odd number of elements,
+the font's <structfield>XFONTINFO.CHAR-RANGE.MAX-CHAR</structfield>
+is implicitly appended to
+the list. If <parameter>CHARS</parameter> contains no elements, the list is
+implicitly replaced with the font's
+<structfield>XFONTINFO.CHAR-RANGE.</structfield> If
+any of the resulting character ranges are invalid, a <link linkend="Errors:Range"><errorname>Range</errorname></link>
error is returned. Otherwise, the character ranges are
-concatenated in the order given by CHARS to produce a set of
-character codes for which bitmaps are returned.
+concatenated in the order given by <parameter>CHARS</parameter> to produce
+a set of character codes for which bitmaps are returned.
</para>
<para>
-<!-- .sp -->
-If RANGE is False, then CHARS specifies the set of character
-codes for which bitmaps are returned. If CHARS is of zero
-length, then a single reply containing a zero-length list of
+If <parameter>RANGE</parameter> is <constant>False</constant>,
+then <parameter>CHARS</parameter> specifies the set of character
+codes for which bitmaps are returned. If <parameter>CHARS</parameter>
+is of zero length, then a single reply containing a zero-length list of
offsets and bitmaps is returned.
</para>
<para>
-<!-- .sp -->
-If any of the resulting character ranges are invalid, a Range
+If any of the resulting character ranges are invalid, a
+<link linkend="Errors:Range"><errorname>Range</errorname></link>
error is returned. Otherwise, the resulting character ranges
-are concatenated in the order given by CHARS to produce a set
-of character codes for which bitmaps are returned.
+are concatenated in the order given by <parameter>CHARS</parameter>
+to produce a set of character codes for which bitmaps are returned.
</para>
<para>
-<!-- .sp -->
The server is free to return the glyph bitmaps in multiple
replies to reduce the amount of buffering that is necessary.
In this situation, the set of characters obtained above is
it was produced.
</para>
<para>
-<!-- .sp -->
For each character in a subset, an image of that character's
glyph is described by a rectangle of bits corresponding to the
pixels specified by FORMAT.IMAGE-RECT. Within the image, set
respectively.
</para>
<para>
-<!-- .sp -->
Each scanline of a glyph image, from top to bottom, is zero-padded
on the right to a multiple of the number of bits specified by
FORMAT.SCANLINE-PAD. The scanline is then divided from left
transmitted first and the right-most is transmitted last.
</para>
<para>
-<!-- .sp -->
The individual images within a subset are then concatenated in
-a server-dependent order to form the BITMAPS data of the
-reply. If a glyph image is duplicated within a reply, the
+a server-dependent order to form the <parameter>BITMAPS</parameter> data
+of the reply. If a glyph image is duplicated within a reply, the
server is free to return fewer (but at least one) copies of
the image. If a character is not encoded within the font, a
zero-length bitmap is substituted for this character. Each
the FORMAT.SCANLINE-UNIT.
</para>
<para>
-<!-- .sp -->
-The OFFSETS array in a reply contains one entry for each
-character in the subset being returned, in the order that the
+The <parameter>OFFSETS</parameter> array in a reply contains one entry
+for each character in the subset being returned, in the order that the
characters appear in the subset. Each entry specifies the
starting location in bytes and size in bytes of the
-corresponding glyph image in the BITMAPS data of that reply
-(i.e. an offset may not refer to data in another reply).
+corresponding glyph image in the <parameter>BITMAPS</parameter> data of that
+reply (i.e. an offset may not refer to data in another reply).
</para>
<para>
-<!-- .sp -->
-The REPLIES-FOLLOWING-HINT field in all but the last reply
-contains a positive value that specifies the number of replies
+The <parameter>REPLIES-FOLLOWING-HINT</parameter> field in all but the
+last reply contains a positive value that specifies the number of replies
that are likely, but not required, to follow. In the last
reply, which may contain data for zero or more characters,
this field is set to zero.
</para>
<para>
-<!-- .sp -->
-If FONTID is not associated with any open fonts, a Font error
-is returned. If RANGE is True and CHARS contains any invalid
-ranges, a Range error is returned. If FORMAT is invalid, a
-Format error is returned.
- </para>
-</blockquote>
-<para>
-<!-- .LP -->
-<!-- .IN "CloseFont" "" "@DEF@" -->
-<function>CloseFont</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>fontid</emphasis>: FONTID
- </para>
- <para>
-Errors:
-<function>Font</function>,
-<function>Alloc</function>
+If <parameter>FONTID</parameter> is not associated with any open fonts,
+a <link linkend="Errors:Font"><errorname>Font</errorname></link>
+error is returned. If <parameter>RANGE</parameter> is
+<constant>True</constant> and <parameter>CHARS</parameter> contains any
+invalid ranges, a
+<link linkend="Errors:Range"><errorname>Range</errorname></link> error
+is returned. If <parameter>FORMAT</parameter> is invalid, a
+<link linkend="Errors:Format"><errorname>Format</errorname></link> error
+is returned.
</para>
- <para>
-This request indicates that the specified FONTID should no
-longer be associated with an open font. The server is free to
+</section>
+
+<section id="Requests:CloseFont">
+ <title><function>CloseFont</function></title>
+ <indexterm zone="Requests:CloseFont" significance="preferred"><primary>CloseFont</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row rowsep='1'><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row>
+ <row><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>, <link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This request indicates that the specified <parameter>FONTID</parameter>
+should no longer be associated with an open font. The server is free to
release any client-specific storage or licenses allocated for
-the font. The client may reuse the value of FONTID in a
-subsequent
-<function>OpenBitmapFont </function>
+the font. The client may reuse the value of <parameter>FONTID</parameter>
+in a subsequent
+<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>
request.
</para>
<para>
-<!-- .sp -->
-If FONTID is not associated with any open fonts, a
-<function> Font </function>
+If <parameter>FONTID</parameter> is not associated with any open fonts, a
+<link linkend="Errors:Font"><errorname>Font</errorname></link>
error is returned.
</para>
-</blockquote>
+</section>
-<para>
-<!-- .LP -->
-<function>"close connection"</function>
-<!-- .IN "close connection" "" "@DEF@" -->
-</para>
+<section id="Requests:close_connection">
+ <title>close connection</title>
+ <indexterm zone="Requests:close_connection" significance="preferred"><primary>close connection</primary></indexterm>
-<blockquote>
<para>
When a connection is closed, a
-<function>CloseFont </function>
+<link linkend="Requests:CloseFont"><function>CloseFont</function></link>
is done on all fonts
that are open on the connection. In addition, the server is
free to release any storage or licenses allocated on behalf of
the client that made the connection.
</para>
-</blockquote>
-</sect2>
+</section>
+</section>
-<sect2 id='Errors'>
+<section id='Errors'>
<title>Errors</title>
<!-- .XS -->
<!-- (SN Errors -->
<para>
All errors are at least 16 bytes long and contain the following fields:
</para>
-<blockquote>
- <para>
-<emphasis remap='I'>type</emphasis>: CARD8 value of 1
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>error-code</emphasis>: CARD8
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>sequence-number</emphasis>: CARD16
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>length</emphasis>: CARD32
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>timestamp</emphasis>: TIMESTAMP
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>major-opcode</emphasis>: CARD8
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>minor-opcode</emphasis>: CARD8
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16
- </para>
-</blockquote>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>type</parameter>:</entry><entry><type>CARD8</type></entry><entry>value of 1</entry></row>
+ <row><entry><parameter>error-code</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>sequence-number</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ <row><entry><parameter>length</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row><entry><parameter>timestamp</parameter>:</entry><entry><link linkend="Data_Types:TIMESTAMP"><type>TIMESTAMP</type></link></entry></row>
+ <row><entry><parameter>major-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>minor-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
-<!-- .LP -->
The TYPE field has a value of one. The ERROR-CODE field specifies which error
occurred. Core errors codes are in the range 0 through 127, extension error
codes are in the range 128 through 255. The SEQUENCE-NUMBER field contains the
bytes of extra data.
</para>
<para>
-<!-- .LP -->
The following errors are defined for the core protocol:
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "Request" "@DEF@" -->
-<function>Request</function>
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
+<section id="Errors:Request">
+ <title><errorname>Request</errorname></title>
+ <indexterm zone="Errors:Request" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Request</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This error is generated by any request that has an unknown
combination of major and minor request numbers, or by any
extension request that is issued before a
-<function>QueryExtension </function>
+<link linkend="Requests:QueryExtension"><function>QueryExtension</function></link>
of that extension.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "Format" "@DEF@" -->
-<function>Format</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
- <para>
-<emphasis remap='I'>format</emphasis>: BITMAPFORMAT bad format value
- </para>
- <para>
-This error is generated by the use of an invalid BITMAPFORMAT
+</section>
+
+<section id="Errors:Format">
+ <title><errorname>Format</errorname></title>
+ <indexterm zone="Errors:Format" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Format</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ <row><entry><parameter>format</parameter>:</entry><entry><link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link></entry><entry>bad format value</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This error is generated by the use of an invalid <link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link>
in the
-<function>OpenBitmapFont</function>,
-<function>QueryXBitmaps8</function>, and
-<function>QueryXBitmaps16</function>
+<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>,
+<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link>, and
+<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link>
requests.
The value that caused the error is included as extra data.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "Font" "@DEF@" -->
-<function>Font</function>
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
- <para>
-<emphasis remap='I'>fontid</emphasis>: FONTID bad font identifier
- </para>
- <para>
-This error is generated by an invalid FONTID in the
-<function>QueryXInfo</function>,
-<function>QueryXExtents8</function>,
-<function>QueryXExtents16</function>,
-<function>QueryXBitmaps8</function>,
-<function>QueryXBitmaps16</function>
+</section>
+
+<section id="Errors:Font">
+ <title><errorname>Font</errorname></title>
+ <indexterm zone="Errors:Font" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Font</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry><entry>bad font identifier</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This error is generated by an invalid <link linkend="Data_Types:FONTID"><type>FONTID</type></link> in the
+<link linkend="Requests:QueryXInfo"><function>QueryXInfo</function></link>,
+<link linkend="Requests:QueryXExtents8"><function>QueryXExtents8</function></link>,
+<link linkend="Requests:QueryXExtents16"><function>QueryXExtents16</function></link>,
+<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link>,
+<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link>
and
-<function>CloseFont </function>
+<link linkend="Requests:CloseFont"><function>CloseFont</function></link>
requests. The value that caused
the error is included as extra data.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "Range" "@DEF@" -->
-<function>Range</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
- <para>
-<emphasis remap='I'>range</emphasis>: RANGE bad range
- </para>
- <para>
-This error is generated by an invalid RANGE in the
-<function> QueryXExtents8</function>,
-<function>QueryXExtents16</function>,
-<function>QueryXBitmaps8</function>
+</section>
+
+<section id="Errors:Range">
+ <title><errorname>Range</errorname></title>
+ <indexterm zone="Errors:Range" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Range</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ <row><entry><parameter>range</parameter>:</entry><entry><link linkend="Data_Types:RANGE"><type>RANGE</type></link></entry><entry>bad range</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This error is generated by an invalid <link linkend="Data_Types:RANGE"><type>RANGE</type></link> in the
+<link linkend="Requests:QueryXExtents8"><function>QueryXExtents8</function></link>,
+<link linkend="Requests:QueryXExtents16"><function>QueryXExtents16</function></link>,
+<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link>
and
-<function>QueryXBitmaps16 </function>
+<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link>
requests. The
value that caused the error is included as extra data.
</para>
-</blockquote>
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "EventMask" "@DEF@" -->
-<function>EventMask</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>event-mask</emphasis>: EVENTMASK bad event mask
- </para>
- <para>
-This error is generated by an invalid EVENTMASK in the
-<function>SetEventMask </function>
+</section>
+
+<section id="Errors:EventMask">
+ <title><errorname>EventMask</errorname></title>
+ <indexterm zone="Errors:EventMask" significance="preferred"><primary>Error Codes</primary><secondary><errorname>EventMask</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ <row><entry><parameter>event-mask</parameter>:</entry><entry><link linkend="Data_Types:EVENTMASK"><type>EVENTMASK</type></link></entry><entry>bad event mask</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This error is generated by an invalid <link linkend="Data_Types:EVENTMASK"><type>EVENTMASK</type></link> in the
+<link linkend="Requests:SetEventMask"><function>SetEventMask</function></link>
request. The value that caused the error is
included as extra data.
</para>
-</blockquote>
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "AccessContext" "@DEF@" -->
-<function>AccessContext</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
- <para>
-<emphasis remap='I'>ac</emphasis>: ACCESSCONTEXT unaccepted
-<function>AccessContext</function>
- </para>
- <para>
-This error is generated by an invalid ACCESSCONTEXT in the
-<function>FreeAC </function>
+</section>
+
+<section id="Errors:AccessContext">
+ <title><errorname>AccessContext</errorname></title>
+ <indexterm zone="Errors:AccessContext" significance="preferred"><primary>Error Codes</primary><secondary><errorname>AccessContext</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ <row><entry><parameter>ac</parameter>:</entry><entry><link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link></entry><entry>unaccepted <type>AccessContext</type></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This error is generated by an invalid <link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link> in the
+<link linkend="Requests:FreeAC"><function>FreeAC</function></link>
or
-<function>SetAuthorization </function>
+<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link>
request or by an
-<function>OpenBitmapFont</function>
+<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>
request performed without sufficient authorization. In the
-first two cases, the ACCESSCONTEXT of the errant request is
+first two cases, the <link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link> of the errant request is
returned as extra data. In the third case, the current
-ACCESSCONTEXT is returned as extra data.
- </para>
-</blockquote>
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "IDChoice" "@DEF@" -->
-<function>IDChoice</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
- <para>
-<emphasis remap='I'>id</emphasis>: ID bad identifier
- </para>
+<link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link> is returned as extra data.
+ </para>
+</section>
+
+<section id="Errors:IDChoice">
+ <title><errorname>IDChoice</errorname></title>
+ <indexterm zone="Errors:IDChoice" significance="preferred"><primary>Error Codes</primary><secondary><errorname>IDChoice</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ <row><entry><parameter>id</parameter>:</entry><entry><link linkend="Data_Types:ID"><type>ID</type></link></entry><entry>bad identifier</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This error is generated by an invalid or already associated
-ACCESSCONTEXT identifier in a
-<function>CreateAC </function>
-request or FONTID identifier
+<link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link> identifier in a
+<link linkend="Requests:CreateAC"><function>CreateAC</function></link>
+request or <link linkend="Data_Types:FONTID"><type>FONTID</type></link> identifier
in an
-<function>OpenBitmapFont </function>
+<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>
request. The value that caused the error
is included as extra data.
</para>
-</blockquote>
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "Name" "@DEF@" -->
-<function>Name</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
+</section>
+
+<section id="Errors:Name">
+ <title><errorname>Name</errorname></title>
+ <indexterm zone="Errors:Name" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Name</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This error is generated by a font name pattern that matches
no fonts in an
-<function>OpenBitmapFont </function>
+<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>
request or no catalogue names in a
-<function>SetCatalogues </function>
+<link linkend="Requests:SetCatalogues"><function>SetCatalogues</function></link>
request.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "Resolution" "@DEF@" -->
-<function>Resolution</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 X value of errant resolution
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>y-resolution</emphasis>: CARD16 Y value of errant resolution
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>point-size</emphasis>: CARD16 point size of errant resolution
- </para>
- <para>
-This error is generated in response to an invalid RESOLUTION
+</section>
+
+<section id="Errors:Resolution">
+ <title><errorname>Resolution</errorname></title>
+ <indexterm zone="Errors:Resolution" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Resolution</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>X value of errant resolution</entry></row>
+ <row><entry><parameter>y-resolution</parameter>:</entry><entry><type>CARD16</type></entry><entry>Y value of errant resolution</entry></row>
+ <row><entry><parameter>point-size</parameter>:</entry><entry><type>CARD16</type></entry><entry>point size of errant resolution</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+This error is generated in response to an invalid <link linkend="Data_Types:RESOLUTION"><type>RESOLUTION</type></link>
structure in a
-<function>SetResolution </function>
+<link linkend="Requests:SetResolution"><function>SetResolution</function></link>
request. The value that caused the
error is included in the DATA-OR-UNUSED field and as extra data.
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "Alloc" "@DEF@" -->
-<function>Alloc</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
+</section>
+
+<section id="Errors:Alloc">
+ <title><errorname>Alloc</errorname></title>
+ <indexterm zone="Errors:Length" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Alloc</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This error is generated by any request for which the server
lacks sufficient resources (especially memory).
</para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "Length" "@DEF@" -->
-<function>Length</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
- <para>
-<emphasis remap='I'>length</emphasis>: CARD32 bad length value
- </para>
+</section>
+
+<section id="Errors:Length">
+ <title><errorname>Length</errorname></title>
+ <indexterm zone="Errors:Length" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Length</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ <row><entry><parameter>length</parameter>:</entry><entry><type>CARD32</type></entry><entry>bad length value</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This error is generated by any request that has a length field
greater than (MAXIMUM-REQUEST-LENGTH * 4) bytes. The value that
caused the error is included as extra data.
</para>
-</blockquote>
-<para>
-<!-- .LP -->
-<!-- .IN "Error Codes" "Implementation" "@DEF@" -->
-<function>Implementation</function>
-</para>
-
-<blockquote>
- <para>
-<emphasis remap='I'>data-or-unused</emphasis>: CARD16 unused
- </para>
+</section>
+
+<section id="Errors:Implementation">
+ <title><errorname>Implementation</errorname></title>
+ <indexterm zone="Errors:Implementation" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Implementation</errorname></secondary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This error may be generated in response to any request that
the server is unable to process because it is deficient. Use
of this error is highly discouraged and indicates lack of
conformance to the protocol.
-<!-- .sp -->
+ </para>
+</section>
+<section id="Errors:Extensions">
+ <title>Extensions</title>
+ <para>
Additional errors may be defined by extensions.
</para>
-</blockquote>
-</sect2>
+</section>
+</section>
-<sect2 id='Events'>
+<section id='Events'>
<title>Events</title>
<!-- .XS -->
<!-- (SN Events -->
<!-- .XE -->
<para>
-<!-- .LP -->
Events may be generated in response to requests or at the server's discretion
after the initial connection setup information has been exchanged. Each event
is at least 12 bytes long and contains the following fields:
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='3' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <colspec colname='c3' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>type</parameter>:</entry><entry><type>CARD8</type></entry><entry>value of 2</entry></row>
+ <row><entry><parameter>event-code</parameter>:</entry><entry><type>CARD8</type></entry></row>
+ <row><entry><parameter>sequence-number</parameter>:</entry><entry><type>CARD16</type></entry></row>
+ <row><entry><parameter>length</parameter>:</entry><entry><type>CARD32</type></entry></row>
+ <row><entry><parameter>timestamp</parameter>:</entry><entry><link linkend="Data_Types:TIMESTAMP"><type>TIMESTAMP</type></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</para>
-<blockquote>
- <para>
-<!-- .TA .75i .75i .75i .75i -->
-<emphasis remap='I'>type</emphasis>: CARD8 value of 2
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>event-code</emphasis>: CARD8
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>sequence-number</emphasis>: CARD16
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>length</emphasis>: CARD32
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>timestamp</emphasis>: TIMESTAMP
- </para>
-</blockquote>
<para>
-<!-- .LP -->
The TYPE field contains the value 2. The EVENT-CODE field specifies the number
of the event and is in the range 0-127 for core events or the range 128-255 for
extensions. The SEQUENCE-NUMBER field specifies the least significant 16 bits
of the sequence number of the last request to have been processed by the
server. The LENGTH field specifies the number of 4-byte units in this event
-packet and must always have a value of at least 3. The TIMESTAMP field
+packet and must always have a value of at least 3. The <link linkend="Data_Types:TIMESTAMP"><type>TIMESTAMP</type></link> field
specifies the server time when the event occurred. If LENGTH is greater than
three, these fields are followed by (LENGTH - 3) * 4 bytes of additional data.
</para>
<para>
-<!-- .LP -->
Events are described using the following syntax:
+ <blockquote><para>
+ <emphasis role="bold"><function>EventName</function></emphasis>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>arg1</parameter>:</entry><entry><type>type1</type></entry></row>
+ <row><entry> ...</entry></row>
+ <row><entry><parameter>argN</parameter>:</entry><entry><type>typeN</type></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ Description
+ </para></blockquote>
</para>
-<literallayout class="monospaced">
-<function>EventName</function>
- <emphasis remap='I'>arg1</emphasis>: type1
- ...
- <emphasis remap='I'>argN</emphasis>: typeN
-
- Description
-</literallayout>
-
<para>
If an event does not provide any extra arguments, the
-<emphasis remap='I'>arg1</emphasis>...<emphasis remap='I'>argN</emphasis>
+<parameter>arg1</parameter>...<parameter>argN</parameter>
lines are omitted from the description.
</para>
<para>
-<!-- .LP -->
The core X Font Service protocol defines the following events:
</para>
-<para>
-<!-- .LP -->
-<!-- .IN "KeepAlive" "" "@DEF@" -->
-<function>KeepAlive</function>
-</para>
-<blockquote>
+
+<section id="Events:KeepAlive">
+ <title><function>KeepAlive</function></title>
+ <indexterm zone="Events:KeepAlive" significance="preferred"><primary>KeepAlive</primary></indexterm>
<para>
This unsolicited, nonmaskable event may be sent by the
server to verify that the connection has not been broken
(for transports that do not provide this information).
Clients should acknowledge receipt of this request
by sending any request (such as
-<function>NoOp</function>
- ")."
- </para>
-</blockquote>
-
-<para>
-<!-- .LP -->
-<!-- .IN "CatalogueListNotify" "" "@DEF@" -->
-<function>CatalogueListNotify</function>
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>added</emphasis>: BOOL
- </para>
- <para>
-<emphasis remap='I'>deleted</emphasis>: BOOL
- </para>
+<link linkend="Requests:NoOp"><function>NoOp</function></link>
+).
+ </para>
+</section>
+
+<section id="Events:CatalogueListNotify">
+ <title><function>CatalogueListNotify</function></title>
+ <indexterm zone="Events:CatalogueListNotify" significance="preferred"><primary>CatalogueListNotify</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>added</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ <row><entry><parameter>deleted</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This event is sent to clients that have included
-<function>CatalogueListChangeMask </function>
+<function><constant>CatalogueListChangeMask</constant></function>
in their core event mask
whenever the list of catalogues that are available has
-changed. The ADDED field is True if new catalogues have
-been added to the server, otherwise it is False. The
-DELETED field is True if any existing catalogues have
-been removed from the server, otherwise it is False.
- </para>
-</blockquote>
-<para>
-<!-- .LP -->
-<!-- .IN "FontListNotify" "" "@DEF@" -->
-<function>FontListNotify</function>
-</para>
-<blockquote>
- <para>
-<emphasis remap='I'>added</emphasis>: BOOL
- </para>
- <para>
-<!-- .br -->
-<emphasis remap='I'>deleted</emphasis>: BOOL
- </para>
+changed. The ADDED field is <constant>True</constant> if new catalogues have
+been added to the server, otherwise it is <constant>False</constant>. The
+DELETED field is <constant>True</constant> if any existing catalogues have
+been removed from the server, otherwise it is <constant>False</constant>.
+ </para>
+</section>
+
+<section id="Events:FontListNotify">
+ <title><function>FontListNotify</function></title>
+ <indexterm zone="Events:FontListNotify" significance="preferred"><primary>FontListNotify</primary></indexterm>
+ <informaltable frame='none'>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth='1.0*'/>
+ <colspec colname='c2' colwidth='1.0*'/>
+ <tbody>
+ <row><entry><parameter>added</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ <row><entry><parameter>deleted</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
<para>
This event is sent to clients that have included
-<function>FontListChangeMask </function>
+<function><constant>FontListChangeMask</constant></function>
in their event mask whenever the
list of fonts that are provided by the currently selected
-catalogues has changed. The ADDED field is True if new
+catalogues has changed. The ADDED field is <constant>True</constant> if new
fonts have been added to any of the catalogues currently
-used by the client, otherwise it is False. The DELETED
-field is True if any existing fonts have been removed
+used by the client, otherwise it is <constant>False</constant>. The DELETED
+field is <constant>True</constant> if any existing fonts have been removed
from any of catalogues used by the client, otherwise it
-is False.
+is <constant>False</constant>.
</para>
+</section>
+<section id="Events:Extensions">
+ <title>Extensions</title>
<para>
-<!-- .sp -->
Additional events may be defined by extensions.
</para>
-</blockquote>
-</sect2>
-</sect1>
+</section>
+</section>
+</chapter>
-<sect1 id='Protocol_Encoding'>
+<chapter id='Protocol_Encoding'>
<title>Protocol Encoding</title>
<!-- .XS -->
<!-- (SN Protocol Encoding -->
<!-- .XE -->
<para>
-<!-- .LP -->
-Numbers that are prefixed with "#x" are in hexadecimal (base 16). All other
+Numbers that are prefixed with <quote><literal>#x</literal></quote>
+are in hexadecimal (base 16). All other
numbers are in decimal. Requests, replies, errors, events, and compound types
are described using the syntax:
</para>
<!-- .RE -->
<para>
where COUNT is the number of bytes in the data stream occupied by this
-field, CONTENTS is the name of the type as given in Section 4 or the value if
+field, CONTENTS is the name of the type as given in
+<link linkend='Data_Types'>Section 4</link> or the value if
this field contains a constant, and NAME is a description of this field.
</para>
<para>
-<!-- .LP -->
Objects containing counted lists use a lowercase single-letter variable (whose
scope is limited to the request, reply, event, or error in which it is found)
to represent the number of objects in the list. These variables, and any
expressions in which they are used, should be treated as unsigned integers.
-Multiple copies of an object are indicated by CONTENTS prefix "LISTof".
+Multiple copies of an object are indicated by CONTENTS prefix
+<quote>LISTof</quote>.
</para>
<para>
-<!-- .LP -->
Unused bytes (whose value is undefined) will have a blank CONTENTS field and a
-NAME field of "unused". Zeroed bytes (whose value must be zero) will have a
-blank CONTENTS field and a NAME field of "zero". The expression pad(e)
-refers to the number of bytes needed to round a value "e" up to the closed
+NAME field of <quote>unused</quote>. Zeroed bytes (whose value must be zero)
+will have a blank CONTENTS field and a NAME field of <quote>zero</quote>.
+The expression pad(e) refers to the number of bytes
+needed to round a value <quote>e</quote> up to the closed
multiple of four:
</para>
<!-- .RS -->
pad(e) = (4 - (e mod 4)) mod 4
</literallayout>
-<sect2 id='Data_Types_2'>
+<section id='Encoding::Data_Types'>
<title>Data Types</title>
<!-- .XS -->
<!-- (SN Data Types -->
<!-- .XE -->
-<!-- .sp 6p -->
<literallayout class="monospaced">
-ACCESSCONTEXT
+<link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link>
+4 <type>CARD32</type> access context
+
+ with at least one of the following bits set:
-4 CARD32 access context with at least one of the following bits set:
+ #x1fffffff
-#x1fffffff
+ but none of the following bits set:
-but none of the following bits set:
+ #xe0000000 zero
-#xe0000000 zero
+<link linkend="Data_Types:ALTERNATESERVER"><type>ALTERNATESERVER</type></link>
+1 <type>BOOL</type> subset
+1 n length of name
+n <type>STRING8</type> name
+p unused, p=pad(n+2)
-ALTERNATESERVER
-1 BOOL subset
-1 n length of name
-n STRING8 name
-p unused, p=pad(n+2)
+<link linkend="Data_Types:AUTH"><type>AUTH</type></link>
+2 n length of name
+2 d length of data
+n <type>STRING8</type> name
+p unused, p=pad(n)
+d <type>STRING8</type> data
+q unused, q=pad(d)
-AUTH
-2 n length of name
-2 d length of data
-n STRING8 name
-p unused, p=pad(n)
-d STRING8 data
-q unused, q=pad(d)
+<link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link>
+4 <type>CARD32</type> value, union of the following bits:
+ #x00000001 ByteOrderMSB
+ #x00000002 BitOrderMSB
+ #x00000000 <constant>ImageRectMin</constant>
+ #x00000004 <constant>ImageRectMaxWidth</constant>
+ #x00000008 <constant>ImageRectMax</constant>
+ #x00000000 <constant>ScanlinePad8</constant>
+ #x00000100 <constant>ScanlinePad16</constant>
+ #x00000200 <constant>ScanlinePad32</constant>
+ #x00000300 <constant>ScanlinePad64</constant>
+ #x00000000 <constant>ScanlineUnit8</constant>
+ #x00001000 <constant>ScanlineUnit16</constant>
+ #x00002000 <constant>ScanlineUnit32</constant>
+ #x00003000 <constant>ScanlineUnit64</constant>
-BITMAPFORMAT
+ except for the following bits which must be zero:
-4 CARD32 value, union of the following bits:
- #x00000001 ByteOrderMSB
- #x00000002 BitOrderMSB
- #x00000000 ImageRectMin
- #x00000004 ImageRectMaxWidth
- #x00000008 ImageRectMax
- #x00000000 ScanlinePad8
- #x00000100 ScanlinePad16
- #x00000200 ScanlinePad32
- #x00000300 ScanlinePad64
- #x00000000 ScanlineUnit8
- #x00001000 ScanlineUnit16
- #x00002000 ScanlineUnit32
- #x00003000 ScanlineUnit64
+ #xffffccf0 zero
-except for the following bits which must be zero:
+ and the following of which at most one bit may be set:
- #xffffccf0 zero
+ #x0000000c at most one bit can be set
-and the following of which at most one bit may be set:
- #x0000000c at most one bit can be set
+<link linkend="Data_Types:BITMAPFORMATMASK"><type>BITMAPFORMATMASK</type></link>
+4 <type>CARD32</type> value, mask of the following bits:
+ #x00000001 <constant>ByteOrderMask</constant>
+ #x00000002 <constant>BitOrderMask</constant>
+ #x00000004 <constant>ImageRectMask</constant>
+ #x00000008 <constant>ScanlinePadMask</constant>
+ #x00000010 <constant>ScanlineUnitMask</constant>
-BITMAPFORMATMASK
+ except for the following bits which must be zero:
-4 CARD32 value, mask of the following bits:
+ #xffffffe0 zero
- #x00000001 ByteOrderMask
- #x00000002 BitOrderMask
- #x00000004 ImageRectMask
- #x00000008 ScanlinePadMask
- #x00000010 ScanlineUnitMask
+<link linkend="Data_Types:BOOL"><type>BOOL</type></link>
+1 <type>BOOL</type> boolean, one of the following values:
+ 0 <constant>False</constant>
+ 1 <constant>True</constant>
-except for the following bits which must be zero:
+<link linkend="Data_Types:BYTE"><type>BYTE</type></link>
+1 <type>BYTE</type> unsigned byte of data
- #xffffffe0 zero
+<type>CARD8</type>
+1 <type>CARD8</type> 8-bit unsigned integer
-BOOL
+<type>CARD16</type>
+2 <type>CARD16</type> 16-bit unsigned integer
-1 BOOL boolean, one of the following values:
-0 False
-1 True
+<type>CARD32</type>
+4 <type>CARD32</type> 32-bit unsigned integer
-BYTE
-1 BYTE unsigned byte of data
+<link linkend="Data_Types:CHAR2B"><type>CHAR2B</type></link>
+1 <type>CARD8</type> byte1
+1 <type>CARD8</type> byte2
-CARD8
-1 CARD8 8-bit unsigned integer
+<link linkend="Data_Types:EVENTMASK"><type>EVENTMASK</type></link>
+4 <type>CARD32</type> event mask
-CARD16
-2 CARD16 16-bit unsigned integer
+ for core events, this is union of the following bits:
-CARD32
-4 CARD32 32-bit unsigned integer
+ #00000001 <constant>CatalogueListChangeMask</constant>
+ #00000002 <constant>FontListChangeMask</constant>
-CHAR2B
-1 CARD8 byte1
-1 CARD8 byte2
+ but none of the following bits set:
-EVENTMASK
-4 CARD32 event mask
- for core events, this is union of the following bits:
+ #fffffffc
- #00000001 CatalogueListChangeMask
- #00000002 FontListChangeMask
+ extensions define their own sets of bits
-but none of the following bits set:
+<link linkend="Data_Types:FONTID"><type>FONTID</type></link>
+4 <type>CARD32</type> font identifier
- #fffffffc
+ with at least one of the following bits set:
-extensions define their own sets of bits
+ #x1fffffff
-FONTID
+ but none of the following bits set:
-4 CARD32 font identifier with at least one of
-the following bits set:
+ #xe0000000 zero
- #x1fffffff
+<type>INT8</type>
+1 <type>INT8</type> 8-bit signed integer
-but none of the following bits set:
+<type>INT16</type>
+2 <type>INT16</type> 16-bit signed integer
- #xe0000000 zero
+<type>INT32</type>
+4 <type>INT32</type> 32-bit signed integer
-INT8
-1 INT8 8-bit signed integer
+<link linkend="Data_Types:OFFSET32"><type>OFFSET32</type></link>
+4 <type>CARD32</type> position (or integer value)
+4 <type>CARD32</type> length
-INT16
-2 INT16 16-bit signed integer
+<link linkend="Data_Types:PROPINFO"><type>PROPINFO</type></link>
+4 n number of <type>PROPOFFSET</type> components
+4 m number of bytes of property data
+20*n <type>PROPOFFSET</type> property offsets into data block
+m <type>LISTofBYTE</type> property data block
-INT32
-4 INT32 32-bit signed integer
+<link linkend="Data_Types:PROPOFFSET"><type>PROPOFFSET</type></link>
+8 <type>OFFSET32</type> name in data block
+8 <type>OFFSET32</type> value in data block
+1 <type>CARD8</type> type, one of the following values:
+ 0 <constant>String</constant>
+ 1 <constant>Unsigned</constant>
+ 2 <constant>Signed</constant>
+ 3 zero
-OFFSET32
-4 CARD32 position (or integer value)
-4 CARD32 length
+<link linkend="Data_Types:RANGE"><type>RANGE</type></link>
+2 <type>CHAR2B</type> minimum character code
+2 <type>CHAR2B</type> maximum character code
-PROPINFO
-4 n number of PROPOFFSET components
-4 m number of bytes of property data
-20*n PROPOFFSET property offsets into data block
-m LISTofBYTE property data block
+<link linkend="Data_Types:RESOLUTION"><type>RESOLUTION</type></link>
+2 <type>CARD16</type> x resolution in pixels per inch
+2 <type>CARD16</type> y resolution in pixels per inch
+2 <type>CARD16</type> point size in decipoints
-PROPOFFSET
-8 OFFSET32 name in data block
-8 OFFSET32 value in data block
+STRNAME
+1 n length of name
+n <type>STRING8</type> name
-1 CARD8 type, one of the following values:
-0 String
-1 Unsigned
-2 Signed
-3 zero
+<link linkend="Data_Types:STRING8"><type>STRING8</type></link>
+n <type>LISTofBYTE</type> array of 8-bit character values
-RANGE
-2 CHAR2B minimum character code
-2 CHAR2B maximum character code
+<link linkend="Data_Types:TIMESTAMP"><type>TIMESTAMP</type></link>
+4 <type>CARD32</type> milliseconds since server time origin
-RESOLUTION
-2 CARD16 x resolution in pixels per inch
-2 CARD16 y resolution in pixels per inch
-2 CARD16 point size in decipoints
+<link linkend="Data_Types:XCHARINFO"><type>XCHARINFO</type></link>
+2 <type>INT16</type> left bearing
+2 <type>INT16</type> right bearing
+2 <type>INT16</type> width
+2 <type>INT16</type> ascent
+2 <type>INT16</type> descent
+2 <type>CARD16</type> attributes
-STRNAME
-1 n length of name
-n STRING8 name
-
-STRING8
-n LISTofBYTE array of 8-bit character values
-
-TIMESTAMP
-4 CARD32 milliseconds since server time origin
-
-XCHARINFO
-2 INT16 left bearing
-2 INT16 right bearing
-2 INT16 width
-2 INT16 ascent
-2 INT16 descent
-2 CARD16 attributes
-
-XFONTINFO
-4 CARD32 flags, union of the following bits:
- #x00000001 AllCharactersExist
- #x00000002 InkInside
- #x00000004 HorizontalOverlap
-
-but none of the following bits set:
-
- #xfffffff8 zero
-4 RANGE range of characters in font
-1 CARD8 drawing direction
- 0 LeftToRight
- 1 RightToLeft
-1 unused
-2 CHAR2B default character
-12 XCHARINFO minimum bounds
-12 XCHARINFO maximum bounds
-2 INT16 font ascent
-2 INT16 font descent
-n PROPINFO property data
+<link linkend="Data_Types:XFONTINFO"><type>XFONTINFO</type></link>
+4 <type>CARD32</type> flags, union of the following bits:
+
+ #x00000001 <constant>AllCharactersExist</constant>
+ #x00000002 <constant>InkInside</constant>
+ #x00000004 <constant>HorizontalOverlap</constant>
+
+ but none of the following bits set:
+
+ #xfffffff8 zero
+
+4 <type>RANGE</type> range of characters in font
+1 <type>CARD8</type> drawing direction
+ 0 <constant>LeftToRight</constant>
+ 1 <constant>RightToLeft</constant>
+1 unused
+2 <type>CHAR2B</type> default character
+12 <type>XCHARINFO</type> minimum bounds
+12 <type>XCHARINFO</type> maximum bounds
+2 <type>INT16</type> font ascent
+2 <type>INT16</type> font descent
+n <type>PROPINFO</type> property data
</literallayout>
-</sect2>
+</section>
-<sect2 id='Requests_2'>
+<section id='Encoding::Requests'>
<title>Requests</title>
-<para><emphasis role="bold">open connection</emphasis></para>
+<para><link linkend="Requests:open_connection"><emphasis role="bold">open connection</emphasis></link></para>
<literallayout class="monospaced">
-1 BYTE byteorder, one of the values:
- #x42 MostSignificant Byte first
- #x6c LeastSignificant Byte first
-1 CARD8 numberof auth in auth-data
+1 <type>BYTE</type> byteorder, one of the values:
+ #x42 MostSignificant Byte first
+ #x6c LeastSignificant Byte first
+1 <type>CARD8</type> numberof auth in auth-data
2 2 client-major-protocol-version
2 0 client-minor-protocol-version
2 a/4 lengthof auth-data
-a LISTofAUTH auth-data
-=>
-2 CARD16 status
-0 Success
-1 Continue
-2 Busy
-3 Denied
+a <type>LISTofAUTH</type> auth-data
+▶
+2 <type>CARD16</type> status
+ 0 <constant>Success</constant>
+ 1 <constant>Continue</constant>
+ 2 <constant>Busy</constant>
+ 3 <constant>Denied</constant>
2 2 major version
2 0 version
-1 CARD8 numberof alternate-servers-hint
-1 CARD8 authorization-index
+1 <type>CARD8</type> numberof alternate-servers-hint
+1 <type>CARD8</type> authorization-index
2 a/4 lengthof alternate-servers-hint
2 (d+q)/4 lengthof authorization-data
-a LISTofALTERNATESERVER alternate-servers-hint
-d LISTofBYTE authorization-data
+a <type>LISTofALTERNATESERVER</type> alternate-servers-hint
+d <type>LISTofBYTE</type> authorization-data
q unused, q=pad(d)
</literallayout>
<para>
-If STATUS is Busy or Denied, the protocol stops and the connection is
-closed. If STATUS is Continue, the client is expected to respond with
+If STATUS is <constant>Busy</constant> or <constant>Denied</constant>, the protocol stops and the connection is
+closed. If STATUS is <constant>Continue</constant>, the client is expected to respond with
additional data, to which the server responds with
a new status value and more data. This dialog continues until the status
-is set to Success, or until the server sets STATUS to Busy or Denied
+is set to <constant>Success</constant>, or until the server sets STATUS to <constant>Busy</constant> or <constant>Denied</constant>
and closes the connection:
</para>
<literallayout class="monospaced">
-->
+◀
4 1+(d+q)/4 length
-d LISTofBYTE more-authorization-data
+d <type>LISTofBYTE</type> more-authorization-data
q unused, q=pad(d)
-=>
+▶
4 2+(d+q)/4 length
-2 CARD16 status
- 0 Success
- 1 Continue
- 2 Busy
- 3 Denied
- 2 unused
-d LISTofBYTE more-authorization-data
+2 <type>CARD16</type> status
+ 0 <constant>Success</constant>
+ 1 <constant>Continue</constant>
+ 2 <constant>Busy</constant>
+ 3 <constant>Denied</constant>
+2 unused
+d <type>LISTofBYTE</type> more-authorization-data
q unused, q=pad(d)
</literallayout>
<para>
-When STATUS is Success, the protocol resumes with the following
+When STATUS is <constant>Success</constant>, the protocol resumes with the following
sent by the server:
</para>
<literallayout class="monospaced">
4 3+(v+w)/4 length of rest of data
-2 CARD16 maximum-request-length
+2 <type>CARD16</type> maximum-request-length
2 v length of vendor string
-4 CARD32 release-number
-v STRING8 vendor-string
+4 <type>CARD32</type> release-number
+v <type>STRING8</type> vendor-string
w unused, w=pad(v)
</literallayout>
<para>
</para>
<literallayout class="monospaced">
-<emphasis role="bold">NoOp</emphasis>
+<link linkend="Requests:NoOp"><emphasis role="bold"><function>NoOp</function></emphasis></link>
1 0 major-opcode
1 unused
2 1 length
-<emphasis role="bold">ListExtensions</emphasis>
+<link linkend="Requests:ListExtensions"><emphasis role="bold"><function>ListExtensions</function></emphasis></link>
1 1 major-opcode
1 unused
2 1 length
-=>
+▶
1 0 type reply
-1 CARD8 numberof names
-2 CARD16 sequence-number
+1 <type>CARD8</type> numberof names
+2 <type>CARD16</type> sequence-number
4 2+(n+p)/4 length
n LISTofSTRNAME names
p unused, p=pad(n)
-<emphasis role="bold">QueryExtension</emphasis>
+<link linkend="Requests:QueryExtension"><emphasis role="bold"><function>QueryExtension</function></emphasis></link>
1 2 major-opcode
1 n length of name
2 1+(n+p)/4 length
-n STRING8 name
+n <type>STRING8</type> name
p unused, p=pad(n)
-=>
+▶
1 0 type reply
-1 BOOL present
-2 CARD16 sequence-number
+1 <type>BOOL</type> present
+2 <type>CARD16</type> sequence-number
4 5 length
-2 CARD16 major-version
-2 CARD16 minor-version
-1 CARD8 major-opcode
-1 CARD8 first-event
-1 CARD8 number-events
-1 CARD8 first-error
-1 CARD8 number-errors
+2 <type>CARD16</type> major-version
+2 <type>CARD16</type> minor-version
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> first-event
+1 <type>CARD8</type> number-events
+1 <type>CARD8</type> first-error
+1 <type>CARD8</type> number-errors
3 unused
-<emphasis role="bold">ListCatalogues</emphasis>
+<link linkend="Requests:ListCatalogues"><emphasis role="bold"><function>ListCatalogues</function></emphasis></link>
1 3 major-opcode
1 unused
2 3+(n+p)/4 length
-4 CARD32 max-names
+4 <type>CARD32</type> max-names
2 n length of pattern
2 unused
-n STRING8 pattern
+n <type>STRING8</type> pattern
p unused, p=pad(n)
-=>+
+▶+
1 0 type reply
1 unused
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 4+(n+p)/4 length
-4 CARD32 replies-following-hint
-4 CARD32 numberof catalogue-names
+4 <type>CARD32</type> replies-following-hint
+4 <type>CARD32</type> numberof catalogue-names
n LISTofSTRNAME catalogue-names
p unused, p=pad(n)
-<emphasis role="bold">SetCatalogues</emphasis>
+<link linkend="Requests:SetCatalogues"><emphasis role="bold"><function>SetCatalogues</function></emphasis></link>
1 4 major-opcode
-1 CARD8 numberof catalogue-names
+1 <type>CARD8</type> numberof catalogue-names
2 1+(n+p)/4 length
n LISTofSTRNAME catalogue-names
p unused, p=pad(n)
-<emphasis role="bold">GetCatalogues</emphasis>
+<link linkend="Requests:GetCatalogues"><emphasis role="bold"><function>GetCatalogues</function></emphasis></link>
1 5 major-opcode
1 unused
2 1 length
-=>
+▶
1 0 type reply
-1 CARD8 numberof catalogue-names
-2 CARD16 sequence-number
+1 <type>CARD8</type> numberof catalogue-names
+2 <type>CARD16</type> sequence-number
4 2+(n+p)/4 length
n LISTofSTRNAME catalogue-names
p unused, p=pad(n)
-<emphasis role="bold">SetEventMask</emphasis>
+<link linkend="Requests:SetEventMask"><emphasis role="bold"><function>SetEventMask</function></emphasis></link>
1 6 major-opcode
-1 CARD8 extension-opcode
+1 <type>CARD8</type> extension-opcode
2 2 length
-4 EVENTMASK event-mask
+4 <type>EVENTMASK</type> event-mask
-<emphasis role="bold">GetEventMask</emphasis>
+<link linkend="Requests:GetEventMask"><emphasis role="bold"><function>GetEventMask</function></emphasis></link>
1 7 major-opcode
-1 CARD8 extension-opcode
+1 <type>CARD8</type> extension-opcode
2 1 length
-=>
+▶
1 0 type reply
1 unused
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 3 length
-4 EVENTMASK event-mask
+4 <type>EVENTMASK</type> event-mask
-<emphasis role="bold">CreateAC</emphasis>
+<link linkend="Requests:CreateAC"><emphasis role="bold"><function>CreateAC</function></emphasis></link>
1 8 major-opcode
-1 CARD8 numberof authorization-protocols
+1 <type>CARD8</type> numberof authorization-protocols
2 2+a/4 length
-4 ACCESSCONTEXT ac
-a LISTofAUTH authorization-protocols
-=>
+4 <type>ACCESSCONTEXT</type> ac
+a <type>LISTofAUTH</type> authorization-protocols
+▶
1 0 type reply
-1 CARD8 authorization-index
-2 CARD16 sequence-number
+1 <type>CARD8</type> authorization-index
+2 <type>CARD16</type> sequence-number
4 3+(d+q)/4 length
-2 CARD16 status
- 0 Success
- 1 Continue
- 2 Busy
- 3 Denied
+2 <type>CARD16</type> status
+ 0 <constant>Success</constant>
+ 1 <constant>Continue</constant>
+ 2 <constant>Busy</constant>
+ 3 <constant>Denied</constant>
2 unused
-d LISTofBYTE authorization-data
+d <type>LISTofBYTE</type> authorization-data
q unused, q=pad(d)
</literallayout>
<para>
-If STATUS is Continue, the client is expected to respond with additional
+If STATUS is <constant>Continue</constant>, the client is expected to respond with additional
data, to which the server
responds with a new status value and more data. This dialog continues
until the status is set to
-Success, Busy, or Denied at which point the request is finished.
+<constant>Success</constant>, <constant>Busy</constant>, or <constant>Denied</constant> at which point the request is finished.
</para>
<literallayout class="monospaced">
-->
+◀
4 1+(d+q)/4 length
-d LISTofBYTE more-authorization-data
+d <type>LISTofBYTE</type> more-authorization-data
q unused, q=pad(d)
-=>
+▶
4 2+(d+q)/4 length
-2 CARD16 status
- 0 Success
- 1 Continue
- 2 Busy
- 3 Denied
+2 <type>CARD16</type> status
+ 0 <constant>Success</constant>
+ 1 <constant>Continue</constant>
+ 2 <constant>Busy</constant>
+ 3 <constant>Denied</constant>
2 unused
-d LISTofBYTE authorization-data
+d <type>LISTofBYTE</type> authorization-data
q unused, q=pad(d)
-<emphasis role="bold">FreeAC</emphasis>
+<link linkend="Requests:FreeAC"><emphasis role="bold"><function>FreeAC</function></emphasis></link>
1 9 major-opcode
1 unused
2 2 length
-4 ACCESSCONTEXT ac
+4 <type>ACCESSCONTEXT</type> ac
-<emphasis role="bold">SetAuthorization</emphasis>
+<link linkend="Requests:SetAuthorization"><emphasis role="bold"><function>SetAuthorization</function></emphasis></link>
1 10 major-opcode
1 unused
2 2 length
-4 ACCESSCONTEXT ac
+4 <type>ACCESSCONTEXT</type> ac
-<emphasis role="bold">SetResolution</emphasis>
+<link linkend="Requests:SetResolution"><emphasis role="bold"><function>SetResolution</function></emphasis></link>
1 11 major-opcode
1 n number of resolutions
2 1+(6*n+p)/4 length
-6*n LISTofRESOLUTION resolutions
+6*n <type>LISTofRESOLUTION</type> resolutions
p p=pad(6*n)
-<emphasis role="bold">GetResolution</emphasis>
+<link linkend="Requests:GetResolution"><emphasis role="bold"><function>GetResolution</function></emphasis></link>
1 12 major-opcode
1 unused
2 1 length
-=>
+▶
1 0 type reply
1 n number of resolutions
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 2+(6*n+p)/4 length
-6*n LISTofRESOLUTION resolutions
+6*n <type>LISTofRESOLUTION</type> resolutions
p p=pad(6*n)
-<emphasis role="bold">ListFonts</emphasis>
+<link linkend="Requests:ListFonts"><emphasis role="bold"><function>ListFonts</function></emphasis></link>
1 13 major-opcode
1 unused
2 3+(n+p)/4 length
-4 CARD32 max-names
+4 <type>CARD32</type> max-names
2 n length of pattern
2 unused
-n STRING8 pattern
+n <type>STRING8</type> pattern
p unused, p=pad(n)
-=>+
+▶+
1 0 type reply
1 unused
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 4+(n+p)/4 length
-4 CARD32 replies-following-hint
-4 CARD32 numberof font-names
+4 <type>CARD32</type> replies-following-hint
+4 <type>CARD32</type> numberof font-names
n LISTofSTRNAME font-names
p unused, p=pad(n)
-<emphasis role="bold">ListFontsWithXInfo</emphasis>
+<link linkend="Requests:ListFontsWithXInfo"><emphasis role="bold"><function>ListFontsWithXInfo</function></emphasis></link>
1 14 major-opcode
1 unused
2 3+(n+p)/4 length
-4 CARD32 max-names
+4 <type>CARD32</type> max-names
2 n length of pattern
2 unused
-n STRING8 pattern
+n <type>STRING8</type> pattern
p unused, p=pad(n)
-=>+(except for last in series)
+▶+ (except for last in series)
1 0 type reply
1 n length of name
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 3+(n+p+f)/4 length
-4 CARD32 replies-hint
-f XFONTINFO fontinfo
-n STRING8 name
+4 <type>CARD32</type> replies-hint
+f <type>XFONTINFO</type> fontinfo
+n <type>STRING8</type> name
p unused, p=pad(n)
-=>(last in series)
+▶ (last in series)
1 0 type reply
1 0 last-reply indicator
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 2 reply length
-<emphasis role="bold">OpenBitmapFont</emphasis>
+<link linkend="Requests:OpenBitmapFont"><emphasis role="bold"><function>OpenBitmapFont</function></emphasis></link>
1 15 major-opcode
1 unused
2 4+(n+p)/4 length
-4 FONTID fontid
-4 BITMAPFORMATMASK format-mask
-4 BITMAPFORMAT format
+4 <type>FONTID</type> fontid
+4 <type>BITMAPFORMATMASK</type> format-mask
+4 <type>BITMAPFORMAT</type> format
n STRNAME pattern
p unused, p=pad(n)
-=>
+▶
1 0 type reply
-1 BOOL otherid-valid
-2 CARD16 sequence-number
+1 <type>BOOL</type> otherid-valid
+2 <type>CARD16</type> sequence-number
4 4 length
-4 FONTID otherid
-1 BOOL cachable
+4 <type>FONTID</type> otherid
+1 <type>BOOL</type> cachable
3 unused
-<emphasis role="bold">QueryXInfo</emphasis>
+<link linkend="Requests:QueryXInfo"><emphasis role="bold"><function>QueryXInfo</function></emphasis></link>
1 16 major-opcode
1 unused
2 2 length
-4 FONTID fontid
-=>
+4 <type>FONTID</type> fontid
+▶
1 0 type reply
1 unused
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 2+f/4 length
-f XFONTINFO fontinfo
+f <type>XFONTINFO</type> fontinfo
p unused, p=pad(f)
-<emphasis role="bold">QueryXExtents8</emphasis>
+<link linkend="Requests:QueryXExtents8"><emphasis role="bold"><function>QueryXExtents8</function></emphasis></link>
1 17 major-opcode
-1 BOOL range
+1 <type>BOOL</type> range
2 3+(n+p)/4 length
-4 FONTID fontid
+4 <type>FONTID</type> fontid
4 n number chars entries
-n STRING8 chars
+n <type>STRING8</type> chars
p unused, p=pad(n)
-=>
+▶
1 0 type reply
1 unused
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 3+3*n length
4 n number of extents
-12*n LISTofXCHARINFO extents
+12*n <type>LISTofXCHARINFO</type> extents
-<emphasis role="bold">QueryXExtents16</emphasis>
+<link linkend="Requests:QueryXExtents16"><emphasis role="bold"><function>QueryXExtents16</function></emphasis></link>
1 18 major-opcode
-1 BOOL range
+1 <type>BOOL</type> range
2 3+(2*n+p)/4 length
-4 FONTID fontid
+4 <type>FONTID</type> fontid
4 n number chars entries
-2*n LISTofCHAR2B chars
+2*n <type>LISTofCHAR2B</type> chars
p unused, p=pad(2*n)
-=>
+▶
1 0 type reply
1 unused
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 3+3*n length
4 n number of extents
-12*n LISTofXCHARINFO extents
+12*n <type>LISTofXCHARINFO</type> extents
-<emphasis role="bold">QueryXBitmaps8</emphasis>
+<link linkend="Requests:QueryXBitmaps8"><emphasis role="bold"><function>QueryXBitmaps8</function></emphasis></link>
1 19 major-opcode
-1 BOOL range
+1 <type>BOOL</type> range
2 4+(n+p)/4 length
-4 FONTID fontid
-4 BITMAPFORMAT format
+4 <type>FONTID</type> fontid
+4 <type>BITMAPFORMAT</type> format
4 n number of chars entries
-n STRING8 chars
+n <type>STRING8</type> chars
p unused, p=pad(n)
-=>+
+▶+
1 0 type reply
1 unused
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 5+2*n+(m+p)/4 length
-4 CARD32 replies-following-hint
+4 <type>CARD32</type> replies-following-hint
4 n number of offsets
4 m number of bytes of glyph images
-8*n LISTofOFFSET32 offsets
-m LISTofBYTE glyphimages
+8*n <type>LISTofOFFSET32</type> offsets
+m <type>LISTofBYTE</type> glyphimages
p unused, p=pad(m)
-<emphasis role="bold">QueryXBitmaps16</emphasis>
+<link linkend="Requests:QueryXBitmaps16"><emphasis role="bold"><function>QueryXBitmaps16</function></emphasis></link>
1 20 major-opcode
-1 BOOL range
+1 <type>BOOL</type> range
2 4+(2*n+p)/4 length
-4 FONTID fontid
-4 BITMAPFORMAT format
+4 <type>FONTID</type> fontid
+4 <type>BITMAPFORMAT</type> format
4 n number of chars entries
-2*n LISTofCHAR2B chars
+2*n <type>LISTofCHAR2B</type> chars
p unused, p=pad(2*n)
-=>
+▶
1 0 type reply
1 unused
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 5+2*n+(m+p)/4 length
-4 CARD32 replies-following-hint
+4 <type>CARD32</type> replies-following-hint
4 n number of offsets
4 m number of bytes of glyph images
-8*n LISTofOFFSET32 offsets
-m LISTofBYTE glyphimages
+8*n <type>LISTofOFFSET32</type> offsets
+m <type>LISTofBYTE</type> glyphimages
p unused, p=pad(m)
-<emphasis role="bold">CloseFont</emphasis>
+<link linkend="Requests:CloseFont"><emphasis role="bold"><function>CloseFont</function></emphasis></link>
1 21 major-opcode
1 unused
2 2 length
-4 FONTID fontid
+4 <type>FONTID</type> fontid
</literallayout>
-</sect2>
+</section>
-<sect2 id='Errors_2'>
+<section id='Encoding::Errors'>
<title>Errors</title>
<literallayout class="monospaced">
-<emphasis role="bold">Request</emphasis>
+<link linkend="Errors:Request"><emphasis role="bold"><errorname>Request</errorname></emphasis></link>
1 1 type error
-1 0 Request
-2 CARD16 sequence-number
+1 0 <errorname>Request</errorname>
+2 <type>CARD16</type> sequence-number
4 4 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
-<emphasis role="bold">Format</emphasis>
+<link linkend="Errors:Format"><emphasis role="bold"><errorname>Format</errorname></emphasis></link>
1 1 type error
-1 1 Format
-2 CARD16 sequence-number
+1 1 <errorname>Format</errorname>
+2 <type>CARD16</type> sequence-number
4 5 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
-4 BITMAPFORMAT bad-format
+4 <type>BITMAPFORMAT</type> bad-format
-<emphasis role="bold">Font</emphasis>
+<link linkend="Errors:Font"><emphasis role="bold"><errorname>Font</errorname></emphasis></link>
1 1 type error
-1 2 Font
-2 CARD16 sequence-number
+1 2 <errorname>Font</errorname>
+2 <type>CARD16</type> sequence-number
4 5 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
-4 FONTID bad-fontid
+4 <type>FONTID</type> bad-fontid
-<emphasis role="bold">Range</emphasis>
+<link linkend="Errors:Range"><emphasis role="bold"><errorname>Range</errorname></emphasis></link>
1 1 type error
-1 3 Range
-2 CARD16 sequence-number
+1 3 <errorname>Range</errorname>
+2 <type>CARD16</type> sequence-number
4 5 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
-4 RANGE bad-range
+4 <type>RANGE</type> bad-range
-<emphasis role="bold">EventMask</emphasis>
+<link linkend="Errors:EventMask"><emphasis role="bold"><errorname>EventMask</errorname></emphasis></link>
1 1 type error
-1 4 EventMask
-2 CARD16 sequence-number
+1 4 <errorname>EventMask</errorname>
+2 <type>CARD16</type> sequence-number
4 5 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
-4 EVENTMASK event-mask
+4 <type>EVENTMASK</type> event-mask
-<emphasis role="bold">AccessContext</emphasis>
+<link linkend="Errors:AccessContext"><emphasis role="bold"><errorname>AccessContext</errorname></emphasis></link>
1 1 type error
-1 5 AccessContext
-2 CARD16 sequence-number
+1 5 <errorname>AccessContext</errorname>
+2 <type>CARD16</type> sequence-number
4 5 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
-4 ACCESSCONTEXT access context
+4 <type>ACCESSCONTEXT</type> access context
-<emphasis role="bold">IDChoice</emphasis>
+<link linkend="Errors:IDChoice"><emphasis role="bold"><errorname>IDChoice</errorname></emphasis></link>
1 1 type error
-1 6 IDChoice
-2 CARD16 sequence-number
+1 6 <errorname>IDChoice</errorname>
+2 <type>CARD16</type> sequence-number
4 5 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
-4 FONTID bad-fontid
+4 <type>FONTID</type> bad-fontid
-<emphasis role="bold">Name</emphasis>
+<link linkend="Errors:Name"><emphasis role="bold"><errorname>Name</errorname></emphasis></link>
1 1 type error
-1 7 Name
-2 CARD16 sequence-number
+1 7 <errorname>Name</errorname>
+2 <type>CARD16</type> sequence-number
4 4 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
-<emphasis role="bold">Resolution</emphasis>
+<link linkend="Errors:Resolution"><emphasis role="bold"><errorname>Resolution</errorname></emphasis></link>
1 1 type error
-1 8 Resolution
-2 CARD16 sequence-number
+1 8 <errorname>Resolution</errorname>
+2 <type>CARD16</type> sequence-number
4 5 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
-6 RESOLUTION resolution
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
+6 <type>RESOLUTION</type> resolution
-<emphasis role="bold">Alloc</emphasis>
+<link linkend="Errors:Alloc"><emphasis role="bold"><errorname>Alloc</errorname></emphasis></link>
1 1 type error
-1 9 Alloc
-2 CARD16 sequence-number
+1 9 <errorname>Alloc</errorname>
+2 <type>CARD16</type> sequence-number
4 4 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
-<emphasis role="bold">Length</emphasis>
+<link linkend="Errors:Length"><emphasis role="bold"><errorname>Length</errorname></emphasis></link>
1 1 type error
-1 10 Length
-2 CARD16 sequence-number
+1 10 <errorname>Length</errorname>
+2 <type>CARD16</type> sequence-number
4 5 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
-4 CARD32 bad-length
+4 <type>CARD32</type> bad-length
-<emphasis role="bold">Implementation</emphasis>
+<link linkend="Errors:Implementation"><emphasis role="bold"><errorname>Implementation</errorname></emphasis></link>
1 1 type error
-1 11 Implementation
-2 CARD16 sequence-number
+1 11 <errorname>Implementation</errorname>
+2 <type>CARD16</type> sequence-number
4 4 length
-4 TIMESTAMP timestamp
-1 CARD8 major-opcode
-1 CARD8 minor-opcode
+4 <type>TIMESTAMP</type> timestamp
+1 <type>CARD8</type> major-opcode
+1 <type>CARD8</type> minor-opcode
2 unused
</literallayout>
-</sect2>
+</section>
-<sect2 id='Events_2'>
+<section id='Encoding::Events'>
<title>Events</title>
<literallayout class="monospaced">
-<emphasis role="bold">KeepAlive</emphasis>
+<link linkend="Events:KeepAlive"><emphasis role="bold"><function>KeepAlive</function></emphasis></link>
1 2 type event
1 0 event KeepAlive
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 3 length
-4 TIMESTAMP timestamp
+4 <type>TIMESTAMP</type> timestamp
-<emphasis role="bold">CatalogueListNotify</emphasis>
+<link linkend="Events:CatalogueListNotify"><emphasis role="bold"><function>CatalogueListNotify</function></emphasis></link>
1 2 type event
1 1 event CatalogueListNotify
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 4 length
-4 TIMESTAMP timestamp
-1 BOOL added
-1 BOOL deleted
+4 <type>TIMESTAMP</type> timestamp
+1 <type>BOOL</type> added
+1 <type>BOOL</type> deleted
2 unused
-<emphasis role="bold">FontListNotify</emphasis>
+<link linkend="Events:FontListNotify"><emphasis role="bold"><function>FontListNotify</function></emphasis></link>
1 2 type event
1 2 event FontListNotify
-2 CARD16 sequence-number
+2 <type>CARD16</type> sequence-number
4 4 length
-4 TIMESTAMP timestamp
-1 BOOL added
-1 BOOL deleted
+4 <type>TIMESTAMP</type> timestamp
+1 <type>BOOL</type> added
+1 <type>BOOL</type> deleted
2 unused
</literallayout>
-</sect2>
-</sect1>
+</section>
+</chapter>
-<sect1 id='Acknowledgements'>
+<chapter id='Acknowledgements'>
<title>Acknowledgements</title>
<!-- .XS -->
<!-- (SN Acknowledgements -->
<!-- .XE -->
<para>
This document represents the culmination of several years of debate and
-experiments done under the auspices of the MIT X Consortium font working group.
+experiments done under the auspices of the
+<orgname class="consortium">MIT X Consortium</orgname> font working group.
Although this was a group effort, the author remains responsible for any errors
-or omissions. The protocol presented here was primarily designed by Jim
-Fulton, Keith Packard, and Bob Scheifler. Special thanks goes to Ned
-Batchelder, Jim Flowers, and Axel Deininger for their invigorating comments
+or omissions. The protocol presented here was primarily designed by
+<personname><firstname>Jim</firstname><surname>Fulton</surname></personname>,
+<personname><firstname>Keith</firstname><surname>Packard</surname></personname>,
+and
+<personname><firstname>Bob</firstname><surname>Scheifler</surname></personname>.
+Special thanks goes to
+<personname><firstname>Ned</firstname><surname>Batchelder</surname></personname>,
+<personname><firstname>Jim</firstname><surname>Flowers</surname></personname>,
+and
+<personname><firstname>Axel</firstname><surname>Deininger</surname></personname>
+for their invigorating comments
which never failed to make this a better document.
-Stephen Gildea edited version 2 of this document.
-Finally, David Lemke
+<personname><firstname>Stephen</firstname><surname>Gildea</surname></personname>
+edited version 2 of this document. Finally,
+<personname><firstname>David</firstname><surname>Lemke</surname></personname>
deserves great credit for designing and coding the sample implementation.
</para>
-</sect1>
+</chapter>
-<bibliography>
+<bibliography id='References'>
<title>References</title>
<para>
All of the following documents are X Consortium standards available from
the X Consortium.
</para>
-<biblioentry>
- <title>X Window System Protocol Version 11</title>
+<biblioentry id='References:x11proto'>
+ <abbrev>1</abbrev>
+ <title><olink targetdoc='x11protocol' targetptr='x11protocol'>X Window System Protocol Version 11</olink></title>
<author><firstname>Robert W.</firstname><surname>Scheifler</surname></author>
</biblioentry>
-<biblioentry>
- <title>Adobe System - Bitmap Distribution Format 2.1</title>
+<biblioentry id='References:bdf-spec'>
+ <abbrev>2</abbrev>
+ <corpauthor>Adobe Systems</corpauthor>
+ <title>Bitmap Distribution Format 2.1</title>
</biblioentry>
-<biblioentry>
- <title>X Consortium. X Logical Font Description Conventions, Version 1.5</title>
+<biblioentry id='References:xlfd-spec'>
+ <abbrev>3</abbrev>
+ <corpauthor>X Consortium</corpauthor>
+ <title><olink targetdoc='xlfd' targetptr='xlfd'>X Logical Font
+ Description Conventions, Version 1.5</olink></title>
</biblioentry>
</bibliography>
Configuration or management of the license restrictions is outside the scope of
the font service protocol and is done in a server-dependent manner. Possible
policies might include, but are not limited to, combinations of the following:
-</para>
-<itemizedlist>
+<variablelist>
+ <?dbhtml list-presentation="list"?>
+ <varlistentry>
+ <term>No restrictions</term>
<listitem>
<para>
-No restrictions - anyone may access any fonts. The server neither
-refuses any connections nor generates AccessContext errors on any
+anyone may access any fonts. The server neither refuses any connections
+nor generates <link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link> errors on any
fonts. For environments without specially-licensed fonts, this is
sufficient.
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Per-machine</term>
<listitem>
<para>
-Per-machine - only those clients connecting from a known set of
+only those clients connecting from a known set of
machines are permitted access. The server could get the address
of the connection and look in a list of allowed machines.
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Per-user</term>
<listitem>
<para>
-Per-user - only a known set of users may access the fonts. The
+only a known set of users may access the fonts. The
server can use the authorization data (such as a Kerberos ticket
or a Secure RPC credential) to verify the identity of the user
and then look in a list of allowed users.
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Simultaneous Use</term>
<listitem>
<para>
-Simultaneous Use - only a certain number of clients may use a given
-font at any one time. Additional clients would receive AccessContext
+only a certain number of clients may use a given font at any one time.
+Additional clients would receive <link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link>
errors if they attempt to open the font. This is only effective if
the initial clients keep the font open for the entire time that it
is being used (even if all of the data has been transmitted and is
being cached).
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Postage Meter</term>
<listitem>
<para>
-Postage Meter - a particular font may only be accessed a limited
+a particular font may only be accessed a limited
number of times before its license must be renewed. Each time
the font is opened, the server decrements a counter. When the
counter reaches zero, all further attempts to open the font
-return an AccessContext error.
+return an <link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link> error.
</para>
</listitem>
-</itemizedlist>
+ </varlistentry>
+</variablelist>
+</para>
<para>
It should be noted that chaining of font servers (obtaining font data from
<appendix id="implementation_suggestions">
<title>Implementation Suggestions</title>
<para>
-<!-- .LP -->
Font server implementations will probably wish to use techniques such as the
following to avoid limits on the number of simultaneous connections:
</para>
</listitem>
</itemizedlist>
</appendix>
-</article>
+<index id="index" />
+</book>
projects / framework / uifw / xorg / proto / x11proto-fonts.git / commitdiff