path: root/specs/fsproto.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!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;
]>


<book id="fsproto">

<bookinfo>
   <title>The X Font Service Protocol</title>
   <subtitle>X Consortium Standard</subtitle>
   <releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo>
   <releaseinfo>Version 2.0</releaseinfo>
   <authorgroup>
      <author>
         <firstname>Jim</firstname><surname>Fulton</surname>
         <affiliation><orgname>Network Computing Devices, Inc.</orgname></affiliation>
      </author>
   </authorgroup>
   <edition>Revised May 2, 1994</edition>
   <copyright><year>1991</year><holder>Network Computing Devices, Inc.</holder></copyright>

<legalnotice>
<para>
Permission to use, copy, modify, distribute, and sell this
documentation for any purpose is hereby granted without fee,
provided that the above copyright notice and this permission
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.
</para>
</legalnotice>

<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
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
furnished to do so, subject to the following conditions:
</para>
<para>
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
</para>
<para>
THE SOFTWARE IS PROVIDED &ldquo;AS IS&rdquo;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
</para>
<para>
Except as contained in this notice, the name of the X Consortium shall not be
used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from the X Consortium.
</para>
</legalnotice>
</bookinfo>

<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>
<firstterm><trademark>X Window System</trademark></firstterm>
is a trademark of The Open Group.
</para></footnote>
.  Multiple formats and the lack of
a consistent mechanism for exporting font data to all displays on a network
prevent the transparent use of applications across different display platforms.
The X Font Service protocol is designed to address this and other issues, with
specific emphasis on the needs of the core X protocol.  Upward-compatible
changes (typically in the form of new requests) are expected as consensus is
reached on new features (particularly outline font support).
</para>
<para>
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
wasted code and data space and a loss of interoperability as displays are used
in unforeseen environments.
</para>
<para>
By moving the interpretation of font data out of the X server into a separate
service on the network, these problems can be greatly reduced.  In addition,
new technologies, such as dynamically generating bitmaps from scaled or outline
fonts, can be provided to all displays transparently.  For horizontal text,
caching techniques and increased processor power can potentially make
rasterization more efficient on large, centralized hosts than on individual
displays.
</para>
<para>
Each font server provides sets of fonts that may be listed and queried for
header, property, glyph extents, and bitmap information.  This data is
transmitted over the network using a binary format (with variations to support
different bit- and byte-orders) designed to minimize the amount of processing
required by the display.  Since the font server, rather than the display, is
responsible for parsing the raw font data, new formats can be used by all
displays by modifying a single font server.
</para>
<para>
From the user's point of view, font servers are simply a new type of name in
the X font path.  Network name services allow descriptive names (such as
DEPARTMENT-FONTS or APPLICATION-FONTS) to be translated into proper network
addresses.  X displays send requests to and read replies from the font server
rather than reading directly from files.  Since the X Font Service protocol is
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>
</chapter>

<chapter id='Architectural_Model'>
<title>Architectural Model</title>
<!-- .XS -->
<!-- (SN Architectural Model -->
<!-- .XE -->
<para>
<!-- .LP -->
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>
<para>
The X Font Service protocol does not require any changes to the core X protocol
or to any applications.  To the user, font servers are simply additional types
of font path elements.  As such, X servers may connect to multiple font
servers, as shown in Figure 2.1.  Although the font protocol is geared towards
the X Window System, it may be also used by other consumers of font data (such
as printer drivers).
</para>

<figure id="figure2.1" label="2.1"><title>Connecting to a Font Server</title>
<literallayout class="monospaced">
 ┌────────┐              ┌───────────────┐
 │   X1   ├──────────────┤               │
 │ Server │              │  Font Server  │
 └────────┘      ┌───────┤      1        │
                 │       └───────────────┘
 ┌────────┐      │
 │   X2   ├──────┘       ┌───────────────┐
 │ Server ├──────────────┤               │
 └────────┘              │  Font Server  │
                 ┌───────┤      2        │
┌─────────┐      │       └───────────────┘
│  other  │      │
│ clients ├──────┘
└─────────┘
</literallayout>
</figure>

<para>
<!-- .LP  -->
Clients communicate with the font server using the request/reply/event model
over any mutually-understood virtual stream connection (such as
<acronym>TCP/IP</acronym>, DECnet,
<footnote><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
first version of the X Font Service protocol is limited to supporting the needs
of the bitmap-oriented core X Window System protocol.  Extensions are expected
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
<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   │
                │ (X server) │
                └─────┬──────┘
                      │
                   network
                      │
┌─────────────────────┴──────────────────────┐
│                                            │
│                font server 1               │
│                                            │
├─────┬─────┬─────┬─────┬────┬─────┬───┬─────┤
│ bdf │ snf │ pcf │ atm │ f3 │ dwf │ │ │ ... │
└─────┴─────┴─────┴─────┴────┴─────┴─│─┴─────┘
                                     │
                                  network
                                     │
                               ┌─────┴────┐
                               │   font   │
                               │ server 2 │
                               └──────────┘
</literallayout>
</figure>

<para>
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>
An event mechanism similar to that used in the X protocol is provided for
asynchronous notification of clients by the server.
</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
authorization changes over time (such as an X server that can verify the
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>
</chapter>

<chapter id='Font_Server_Naming'>
<title>Font Server Naming</title>
<!-- .XS -->
<!-- (SN Font Server Naming -->
<!-- .XE -->
<para>
Font clients that expose font server names to the user are encouraged to
provide ways of naming font servers symbolically (e.g. DEPARTMENT-FONTS).
However, for environments that lack appropriate name services
transport-specific names are necessary.  Since these names do occur in the
protocol, clients and servers should support at least the applicable formats
described below.  Formats for additional transports may be registered with the
X Consortium.
</para>

<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:

<literallayout class="monospaced">
    <replaceable>TCP name</replaceable>  ::=  <literal>tcp/</literal> <replaceable>hostname</replaceable> <literal>:</literal> <replaceable>ipportnumber</replaceable> <optional><literal>/</literal> <replaceable>cataloguelist</replaceable></optional>
</literallayout>

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:
<literallayout class="monospaced">
     tcp/expo.lcs.mit.edu:8012/available+special
     tcp/18.30.0.212:7890
</literallayout>
</para>
</section>

<section id='DECnet_Names'>
<title>DECnet Names</title>
<!-- .XS -->
<!-- (SN DECnet Names -->
<!-- .XE -->
<para>
<!-- .LP -->
The following syntax should be used for DECnet names:

<literallayout class="monospaced">
    <replaceable>DECnet name</replaceable>  ::=  <literal>decnet/</literal> <replaceable>nodename</replaceable> <literal>::font$</literal> <replaceable>objname</replaceable> <optional><literal>/</literal> <replaceable>cataloguelist</replaceable></optional>
</literallayout>

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:

<literallayout class="monospaced">
     DECNET/SRVNOD::FONT$DEFAULT/AVAILABLE
     decnet/44.70::font$other
</literallayout>
</para>
</section>
</chapter>

<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
<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
    </para>
  </listitem>
  <listitem>
    <para>
<!-- .IP \(bu 5 -->
Alternate values are capitalized with no word separators,
as in:  MaxWidth
    </para>
  </listitem>
  <listitem>
    <para>
<!-- .IP \(bu 5 -->
Structure element declarations are in lower case with hyphens
as word separators, as in:  byte-order-msb
    </para>
    <note>
      <para>
Structure element names are referred to in
upper case (e.g. BYTE-ORDER-MSB) 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.
      </para>
    </note>
  </listitem>
  <listitem>
    <para>
Type declarations have the form "name: type",
as in:  CARD8: 8-bit byte
    </para>
  </listitem>
  <listitem>
    <para>
Comma-separated lists of alternate values are enclosed in
braces, as in:  { Min, MaxWidth, Max }
    </para>
  </listitem>
  <listitem>
    <para>
Comma-separated lists of structure elements are enclosed in
brackets, as in:  [ byte1: CARD8, byte2: CARD8 ]
    </para>
  </listitem>
</itemizedlist>

<para>
<!-- .LP -->
A type with a prefix "LISTof" represents a counted list of
elements of that type, as in:  LISTofCARD8
</para>

<section id='Data_Types'>
<title>Data Types</title>
<!-- .XS -->
<!-- (SN Data Types -->
<!-- .XE -->
<para>
The following data types are used in the core X Font Server protocol:
</para>

<literallayout class="monospaced">
ACCESSCONTEXT:     ID
</literallayout>
<blockquote>
<para>
This value is specified in the CreateAC request as the identifier
to be used when referring to a particular AccessContext resource
within the server.  These resources are used by the server to
store client-specified authorization information.  This
information may be used by the server to determine whether or not
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
be servers (for example, X servers) requesting fonts for their own clients.
Other font clients may be doing work on behalf of a number of different
users over time (for example, print spoolers).
</para>
<para>
<!-- .sp -->
<type>AccessContext</type>s
must be created (with
<function>CreateAC</function>)
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 <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 SUBSET 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>

<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
   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>

<blockquote>
<para>
This structure specifies how glyph images are transmitted in
response to
<function>QueryXBitmaps8</function>
and
<function>QueryXBitmaps16</function>
requests.
</para>
<para>
<!-- .sp -->
If the BYTE-ORDER-MSB bit (1 &lt;&lt; 0) 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 &lt;&lt; 1) 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
glyph image.  It contains one of the following alternate values:
</para>

<literallayout class="monospaced">
     ImageRectMin          (0 &lt;&lt; 2)
     ImageRectMaxWidth     (1 &lt;&lt; 2)
     ImageRectMax          (2 &lt;&lt; 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> -
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
</literallayout>
<para>

<function>ImageRectMaxWidth</function> -
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
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
</literallayout>

<para>
ImageRectMax - 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.
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)
</literallayout>
<para>
The SCANLINE-PAD 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 &lt;&lt; 8)
     ScanlinePad16         (1 &lt;&lt; 8)
     ScanlinePad32         (2 &lt;&lt; 8)
     ScanlinePad64         (3 &lt;&lt; 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 &lt;&lt; 12)
     ScanlineUnit16         (1 &lt;&lt; 12)
     ScanlineUnit32         (2 &lt;&lt; 12)
     ScanlineUnit64         (3 &lt;&lt; 12)
</literallayout>
<para>
BITMAPFORMATs are byte-swapped as CARD32s.  All unspecified bits
must be zero.
</para>
<para>
Use of an invalid BITMAPFORMAT causes a <errorname>Format</errorname> 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 &lt;&lt; 0)
     BitOrderMask           (1 &lt;&lt; 1)
     ImageRectMask          (1 &lt;&lt; 2)
     ScanlinePadMask        (1 &lt;&lt; 3)
     ScanlineUnitMask       (1 &lt;&lt; 4)
</literallayout>
<para>
Unspecified bits are required to be zero or else a <errorname>Format</errorname> error
is returned.
</para>
<para>
BOOL:  CARD8
</para>
<blockquote>
<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>

<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>

<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>

<para>
EVENTMASK:  CARD32 mask
</para>

<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>
and
<function>GetEventMask</function>
requests):
</para>

<literallayout class="monospaced">
     CatalogueListChangeMask          (1 &lt;&lt; 0)
     FontListChangeMask               (1 &lt;&lt; 1)
</literallayout>

<para>
If
<function>CatalogueListChangeMask</function>
is set, client is interested in
receiving
<function>CatalogueListNotify</function>
events.  If
<function>FontListChangeMask</function>
is set, the client is interested in
receiving
<function>FontListNotify</function>
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 -->
All unused bits must be set to zero.  In
<function>SetEventMask</function>
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>
request), an
<errorname>EventMask</errorname>
error is generated.
<!-- .sp -->
This value is swapped as a CARD32.
    </para>
</blockquote>

<para>
FONTID:     ID
</para>

<blockquote>
<para>
This is specified by the client in the request
<function>OpenBitmapFont</function>
as the identifier to be used when referring to a particular open
font.
</para>
</blockquote>

<para>
ID:  CARD32
</para>

<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
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>

<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>
    <para>
This structure indicates a position and length within a block of
data.
    </para>
</blockquote>

<literallayout class="monospaced">
PROPINFO:     [ offsets:          LISTofPROPOFFSET,
                data:             LISTofBYTE ]
</literallayout>

<blockquote>
    <para>
This structure describes the list of properties provided by a
font.  Strings for all of the properties names and values are
stored within the data block and are located using a table of
offsets and lengths.
    </para>
    <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>

<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
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>
which have the following meanings:
    </para>
    <blockquote>
      <para>
This property contains a counted string of bytes.  The
data is stored in the PROPINFO.DATA block beginning at
relative byte VALUE.POSITION (beginning with zero), extending
for VALUE.LENGTH (at least zero) bytes.
      </para>
    </blockquote>
    <para>
This property contains a unsigned, 32-bit number stored
as a CARD32 in VALUE.POSITION (VALUE.LENGTH is zero).
    </para>
    <blockquote>
      <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.
      </para>
    </blockquote>
</blockquote>

<para>
RANGE:     [ min-char, max-char:     CHAR2B ]
</para>

<blockquote>
  <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.
  </para>
</blockquote>

<literallayout class="monospaced">
RESOLUTION:     [ x-resolution:          CARD16,
                  y-resolution:          CARD16,
                  decipoint-size:        CARD16 ]
</literallayout>

<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
size, measured in tenths of a point, and must be greater than zero.
  </para>
</blockquote>

<para>
STRING8:          LISTofCARD8
</para>

<blockquote>
  <para>
This is a counted list of 1-byte character codes, typically
encoded in <acronym>ISO</acronym> 8859-1.  A character code "c" is equivalent to a
CHAR2B structure whose BYTE1 is zero and whose BYTE2 is "c".
  </para>
</blockquote>

<para>
TIMESTAMP:     CARD32
</para>

<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
permitted to wrap.
  </para>
</blockquote>

<para>
XCHARINFO:     [ lbearing, rbearing:     INT16,
                 width:                  INT16,
                 ascent, descent:        INT16,
                 attributes:             CARD16 ]
</para>

<blockquote>
  <para>
This structure specifies the ink extents and horizontal escapement
(also known as the set- or logical width) of an individual
character.  The first five values represent directed distances in
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
<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
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 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
right) from the origin to the position where the next character
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>.
<!-- .sp -->
  </para>
  <para>
The ASCENT 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
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
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.
  </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>
  <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 &lt;&lt; 0)
     InkInside              (1 &lt;&lt; 1)
     HorizontalOverlap      (1 &lt;&lt; 2)
</literallayout>

    <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
the font.  If this bit is clear, some of the characters
may not have encoded glyphs.
    </para>
</blockquote>

<para>
InkInside
</para>
<blockquote>
    <para>
If this bit is set, the inked pixels of each glyph
fall within the rectangle described by the font's ascent,
descent, origin, and the glyph's escapement point.  If
this bit is clear, there may be glyphs whose ink extends
outside this rectangle.
    </para>
</blockquote>
<para>
HorizontalOverlap
</para>
<blockquote>
    <para>
If this bit is set, the two ink bounding
boxes (smallest rectangle enclosing the inked pixels) of
some pairs of glyphs in the font may overlap when displayed
side-by-side (i.e. the second character is imaged at the
escapement point of the first) on a common baseline.  If
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
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
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
encoded at all positions between the first and last characters.
</para>
<para>
The DEFAULT-CHAR 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
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
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.
</para>
<para>
This structure is padded to 32-bit alignment.
</para>
</blockquote>
</section>

<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
requests are received.  Servers are permitted to add or remove fonts to the
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:
    <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 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
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
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 <errorname>Length</errorname> error.  If the server runs out of internal
resources (such as memory) while processing a request, it returns an
<errorname>Alloc</errorname> error.  If a server is
deficient (and therefore non-compliant) and is unable to process a request, it
may return an <errorname>Implementation</errorname> error.
If a client uses an extension request without previously having issued a
<function>QueryExtension</function>
request for that extension, the server responds with a
<errorname>Request</errorname>
error.  If the server encounters a request
with an unknown MAJOR-OPCODE or MINOR-OPCODE, it responds with a
<errorname>Request</errorname>
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
between 0 and 255, inclusive.
</para>
<para>
<!-- .LP -->
Each reply is at least 8 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 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 TYPE field has a value of zero.  The DATA-OR-UNUSED 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.
</para>
<para>
<!-- .LP -->
Requests that have replies are described using the following syntax:
  <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>

<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>BYTE</entry></row>
          <row><entry><parameter>client-major-protocol-version</parameter>:</entry><entry>CARD16</entry></row>
          <row><entry><parameter>client-minor-protocol-version</parameter>:</entry><entry>CARD16</entry></row>
          <row><entry><parameter>authorization-protocols</parameter>:</entry><entry>LISTofAUTH</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
<para>
The initial byte of the connection specifies the BYTE-ORDER in
which subsequent 16-bit and 32-bit numeric values are to be
transmitted.  The octal value 102 (<acronym>ASCII</acronym> uppercase `B')
indicates that the most-significant byte is to be transmitted
first; the octal value 154 (<acronym>ASCII</acronym> lowercase `l') 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>
  <para>
The CLIENT-MAJOR-PROTOCOL-VERSION and
CLIENT-MINOR-PROTOCOL-VERSION 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
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>
    <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>{ Success, Continue,
                                  Busy, Denied }</entry></row>
          <row><entry><parameter>server-major-protocol-version</parameter>:</entry><entry>CARD16</entry></row>
          <row><entry><parameter>server-minor-protocol-version</parameter>:</entry><entry>CARD16</entry></row>
          <row><entry><parameter>alternate-servers-hint</parameter>:</entry><entry>LISTofALTERNATESERVER</entry></row>
          <row><entry><parameter>authorization-index</parameter>:</entry><entry>CARD8</entry></row>
          <row><entry><parameter>authorization-data</parameter>:</entry><entry>LISTofBYTE</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
  <para>
The SERVER-MAJOR-PROTOCOL-VERSION and
SERVER-MINOR-PROTOCOL-VERSION 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
requested a higher version than is supported by the server,
the server's highest version should be returned.  Otherwise,
if the client has requested a lower version than is supported
by the server, the server's lowest version should be returned.
It is the client's responsibility to decide whether or not it
can match this version of the protocol.
  </para>
  <para>
The ALTERNATE-SERVERS-HINT 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,
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>
  <para>
If STATUS is Denied, the server has rejected the client's
authorization information.  If STATUS is Busy, 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
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
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 as a challenge, authentication of the server,
etc.).
  </para>
<para>
<!-- .LP -->
If STATUS is Success, the following section of protocol is
omitted.  Otherwise, if STATUS is Continue, 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):
    <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>STRING8</entry></row>
          <row><entry>▶</entry></row>
          <row><entry><parameter>status</parameter>:</entry><entry>{ Success, Continue, Busy, Denied }</entry></row>
          <row><entry><parameter>more-authorization-data</parameter>:</entry><entry>LISTofBYTE</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
</para>
<para>
The values in STATUS 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.
</para>
<para>
<!-- .LP -->
Once the connection has been accepted and STATUS is Success,
an implicit AccessContext is created for the authorization
data and the protocol continues with the following data sent
from the server:
    <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>CARD32</entry></row>
          <row><entry><parameter>maximum-request-length</parameter>:</entry><entry>CARD16</entry></row>
          <row><entry><parameter>release-number</parameter>:</entry><entry>CARD32</entry></row>
          <row><entry><parameter>vendor</parameter>:</entry><entry>STRING8</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
</para>
<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
value of at least 4096.  Requests with a length field larger
than this value are ignored and a <errorname>Length</errorname>
error is returned.
The VENDOR string specifies the name of the manufacturer of
the font server.  The RELEASE-NUMBER 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>
</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><errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request does nothing.  It is typically used in response
to a
<function>KeepAlive</function>
event.
    </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><type>LISTofSTRING8</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>

  <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 <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>STRING8</entry></row>
          <row><entry>▶</entry></row>
          <row><entry><parameter>present</parameter>:</entry><entry>BOOL</entry></row>
          <row><entry><parameter>major-version</parameter>:</entry><entry>CARD16</entry></row>
          <row><entry><parameter>minor-version</parameter>:</entry><entry>CARD16</entry></row>
          <row><entry><parameter>major-opcode</parameter>:</entry><entry>CARD8</entry></row>
          <row><entry><parameter>first-event</parameter>:</entry><entry>CARD8</entry></row>
          <row><entry><parameter>number-events</parameter>:</entry><entry>CARD8</entry></row>
          <row><entry><parameter>first-error</parameter>:</entry><entry>CARD8</entry></row>
          <row rowsep='1'><entry><parameter>number-errors</parameter>:</entry><entry>CARD8</entry></row>
          <row><entry>Errors:</entry><entry><errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
  <para>
This request determines whether or not the extension package
specified by NAME (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 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</function> request to express interest in any of
this extension's events.  Otherwise, a
<errorname>Request</errorname>
error is returned.
  </para>
</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>STRING8</entry></row>
          <row><entry><parameter>max-names</parameter>:</entry><entry>CARD32</entry></row>
          <row><entry>▶+</entry></row>
          <row><entry><parameter>replies-following-hint</parameter>:</entry><entry>CARD32</entry></row>
          <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><type>LISTofSTRING8</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request returns a list of at most MAX-NAMES names
of collections (called catalogues) of fonts that match
the specified PATTERN.  In the pattern (which is encoded
in <acronym>ISO</acronym> 8859-1), the `?' character (octal 77) matches any
single character; the `*' character (octal 52) matches
any series of zero or more characters; and alphabetic
characters match either upper- or lowercase.  The
returned NAMES 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,
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 catalogues to the set returned by
<function>ListCatalogues</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.
    </para>
    <para>
To reduce the amount of buffering needed by the server, the
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
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>
</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><type>LISTofSTRING8</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Alloc</errorname>,
<errorname>Name</errorname></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>,
and
<function>OpenBitmapFont</function>
requests.  The catalogue names are
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
<errorname>Name</errorname>
error is returned and the request is ignored.
    </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><type>LISTofSTRING8</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request returns the current list of catalogue names
(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>,
and
<function>OpenBitmapFont</function>.
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>
</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>CARD8</entry></row>
          <row rowsep='1'><entry><parameter>event-mask</parameter>:</entry><entry><type>EVENTMASK</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>EventMask</errorname>,
<errorname>Request</errorname></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)
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>
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>
or zero, a
<errorname>Request</errorname>
error is
returned.  If EVENT-MASK contains any bits that do not
correspond to valid events for the specified extension (or
core), an
<errorname>EventMask</errorname>
error is returned and the request is
ignored.
    </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>CARD8</entry></row>
          <row><entry>▶</entry></row>
          <row rowsep='1'><entry><parameter>event-mask</parameter>:</entry><entry><type>EVENTMASK</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Request</errorname></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)
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
previously returned by
<function>QueryExtension</function>
or zero, a
<errorname>Request</errorname>
error is returned.
    </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>ACCESSCONTEXT</entry></row>
          <row><entry><parameter>authorization-protocols</parameter>:</entry><entry>LISTofAUTH</entry></row>
          <row><entry>▶</entry></row>
          <row><entry><parameter>status</parameter>:</entry><entry>{ Success, Continue, Denied }</entry></row>
          <row><entry><parameter>authorization-index</parameter>:</entry><entry>CARD8</entry></row>
          <row rowsep='1'><entry><parameter>authorization-data</parameter>:</entry><entry><type>LISTofBYTE</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>IDChoice</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request creates a new
<type>AccessContext</type>
object within the
server containing the specified authorization data.  When
this
<type>AccessContext</type>
is selected by the client using the
<function>SetAuthorization</function>
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
<type>AccessContext</type>.
In this case, AUTHORIZATION-INDEX is set
to zero, and zero bytes of AUTHORIZATION-DATA is returned.
    </para>
    <para>
<!-- .sp -->
Otherwise, 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 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
as a challenge, authentication of the server, etc.).
    </para>
    <para>
<!-- .sp -->
If STATUS is Continue, 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>
    <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>STRING8</entry></row>
          <row><entry>     ▶</entry></row>
          <row><entry><parameter>status</parameter>:</entry><entry>{ Success, Continue, Denied }</entry></row>
          <row><entry><parameter>    more-authorization-data</parameter>:</entry><entry>LISTofBYTE</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <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 <errorname>IDChoice</errorname> 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>ACCESSCONTEXT</entry></row>
          <row rowsep='1'><entry>Errors:</entry><entry><errorname>AccessContext</errorname>,
<errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request indicates that the specified AC should no longer
be associated with a valid access context.  If AC is also the
current
<type>AccessContext</type>
(as set by the
<function>SetAuthorization</function>
request), an implicit
<function>SetAuthorization</function>
of None is done to
restore the
<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>
request.
    </para>
    <para>
If AC isn't associated with any valid authorization previously
created by
<function>CreateAC</function>, an
<errorname>AccessContext</errorname>
error is returned.
    </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>ACCESSCONTEXT</entry></row>
          <row rowsep='1'><entry>Errors:</entry><entry><errorname>AccessContext</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request sets the
<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>
and
<function>CloseFont</function>
which are done under the
<type>AccessContext</type>
of the
corresponding
<function>OpenBitmapFont</function>
).
An AC of None 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
<type>AccessContext</type>
previously created by
<function>CreateAC</function>,
an
<errorname>AccessContext</errorname>
error is returned.
    </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><type>LISTofRESOLUTION</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Resolution</errorname>,
<errorname>Alloc</errorname></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 <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
server-dependent default value is restored.  Otherwise, if
elements of all of the specified RESOLUTIONS are non-zero, the
default resolutions for this client are changed.
    </para>
    <para>
If a RESOLUTION entry contains a zero, a <errorname>Resolution</errorname> error is
returned and the default resolutions are not changed.
    </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><type>LISTofRESOLUTION</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Alloc</errorname></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>,
a server-dependent default value is returned.
    </para>
</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>STRING8</entry></row>
          <row><entry><parameter>max-names</parameter>:</entry><entry>CARD32</entry></row>
          <row><entry>▶+</entry></row>
          <row><entry><parameter>replies-following-hint</parameter>:</entry><entry>CARD32</entry></row>
          <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><type>LISTofSTRING8</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request returns a list of at most MAX-NAMES font names
that match the specified PATTERN, 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 `?' character
(octal 77) matches any single character; the `*' character
(octal 52) matches any series of zero or more characters; and
alphabetic characters match either upper- or lowercase.  The
returned NAMES 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,
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>
between any two requests.  This request is not
cumulative; repeated uses are processed in isolation and do
result in an iteration through the list.
    </para>
    <para>
To reduce the amount of buffering needed by the server, the
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
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>
</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>STRING8</entry></row>
          <row><entry><parameter>pattern</parameter>:</entry><entry>STRING8</entry></row>
          <row><entry><parameter>pattern</parameter>:</entry><entry>STRING8</entry></row>
          <row><entry><parameter>max-names</parameter>:</entry><entry>CARD32</entry></row>
          <row><entry>▶+</entry></row>
          <row><entry><parameter>replies-following-hint</parameter>:</entry><entry>CARD32</entry></row>
          <row><entry><parameter>info</parameter>:</entry><entry>XFONTINFO</entry></row>
          <row rowsep='1'><entry><parameter>name</parameter>:</entry><entry><type>STRING8</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request is similar to
<function>ListFonts</function>
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.
    </para>
    <para>
<!-- .sp -->
The REPLIES-FOLLOWING-HINT 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
client with the server.
    </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>FONTID</entry></row>
          <row><entry><parameter>pattern</parameter>:</entry><entry>STRING8</entry></row>
          <row><entry><parameter>format-mask</parameter>:</entry><entry>BITMAPFORMATMASK</entry></row>
          <row><entry><parameter>format-hint</parameter>:</entry><entry>BITMAPFORMAT</entry></row>
          <row><entry>▶</entry></row>
          <row><entry><parameter>otherid</parameter>:</entry><entry>FONTID or None</entry></row>
          <row><entry><parameter>otherid-valid</parameter>:</entry><entry>BOOL</entry></row>
          <row rowsep='1'><entry><parameter>cachable</parameter>:</entry><entry><type>BOOL</type></entry></row>
          <row><entry>Errors:</entry><entry>
<errorname>IDChoice</errorname>,
<errorname>Name</errorname>,
<errorname>Format</errorname>,
<errorname>AccessContext</errorname>,
<errorname>Alloc</errorname></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>.
If no matches are found, a
<errorname>Name</errorname>
error is returned.  Otherwise, the server attempts to
open the font associated with the chosen name.
    </para>
    <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
<type>AccessContext</type>
(as set by the most
recent
<function>SetAuthorization</function>
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
<type>AccessContext</type>
with
<function>SetAuthorization</function>
or release
the
<type>AccessContext</type>
using
<function>FreeAC</function>
.  Subsequent
<function>QueryXInfo</function>,
<function>QueryXExtents8</function>,
<function>QueryXExtents16</function>,
<function>QueryXBitmaps8</function>,
<function>QueryXBitmaps16</function>
and
<function>CloseFont</function>
requests on this FONTID are
performed according to permissions granted at the time of the
<function>OpenBitmapFont</function>
request.
    </para>
    <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
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
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
<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 CACHABLE is False, the
client should reopen the font for each
<type>AccessContext</type>.
<!-- .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
<errorname>IDChoice</errorname>
error is returned.
If no font is available that matches the specified PATTERN, a
<errorname>Name</errorname>
error is returned.  If the font is present but the client
is not permitted access, an
<errorname>AccessContext</errorname>
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
<errorname>Format</errorname>
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>FONTID</entry></row>
          <row><entry>▶</entry></row>
          <row rowsep='1'><entry><parameter>info</parameter>:</entry><entry><type>XFONTINFO</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Font</errorname>,
<errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <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
<errorname>Font</errorname>
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>FONTID</entry></row>
          <row><entry><parameter>range</parameter>:</entry><entry>BOOL</entry></row>
          <row><entry><parameter>chars</parameter>:</entry><entry>STRING8</entry></row>
          <row><entry>▶</entry></row>
          <row rowsep='1'><entry><parameter>extents</parameter>:</entry><entry><type>LISTofXCHARINFO</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Font</errorname>,
<errorname>Range</errorname>,
<errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request is equivalent to
<function>QueryXExtents16</function>
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>FONTID</entry></row>
          <row><entry><parameter>range</parameter>:</entry><entry>BOOL</entry></row>
          <row><entry><parameter>chars</parameter>:</entry><entry>LISTofCHAR2B</entry></row>
          <row><entry>▶</entry></row>
          <row rowsep='1'><entry><parameter>extents</parameter>:</entry><entry><type>LISTofXCHARINFO</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Font</errorname>,
<errorname>Range</errorname>,
<errorname>Alloc</errorname></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.
    </para>
    <para>
<!-- .sp -->
If RANGE is True, each succeeding pair of elements in CHARS 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 <errorname>Range</errorname>
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.
    </para>
    <para>
<!-- .sp -->
If RANGE is False, then CHARS specifies the set of character
codes for which extents are returned.  If CHARS 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.
At least one metric for each character shall be non-zero
unless the character is not encoded in the font, in which case
all-zero metrics are returned.
A blank, zero-width character can be encoded
with non-zero but equal left and right bearings.
    </para>
    <para>
<!-- .sp -->
If FONTID is not associated with any open fonts, a
<errorname>Font</errorname>
error is
returned.  If RANGE is True and CHARS contains any invalid
ranges, a
<errorname>Range</errorname>
error is returned.
    </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>FONTID</entry></row>
          <row><entry><parameter>range</parameter>:</entry><entry>BOOL</entry></row>
          <row><entry><parameter>chars</parameter>:</entry><entry>STRING8</entry></row>
          <row><entry><parameter>format</parameter>:</entry><entry>BITMAPFORMAT</entry></row>
          <row><entry>▶+</entry></row>
          <row><entry><parameter>replies-following-hint</parameter>:</entry><entry>CARD32</entry></row>
          <row><entry><parameter>offsets</parameter>:</entry><entry>LISTofOFFSET32</entry></row>
          <row><entry><parameter>bitmaps</parameter>:</entry><entry>LISTofBYTE</entry></row>
          <row rowsep='1'><entry>Errors:</entry><entry><errorname>Font</errorname>,
<errorname>Range</errorname>,
<errorname>Format</errorname>,
<errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request is equivalent to
<function>QueryXBitmaps16</function>
except that it
uses 1-byte character codes.
    </para>
</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>FONTID</entry></row>
          <row><entry><parameter>range</parameter>:</entry><entry>BOOL</entry></row>
          <row><entry><parameter>chars</parameter>:</entry><entry>LISTofCHAR2B</entry></row>
          <row><entry><parameter>format</parameter>:</entry><entry>BITMAPFORMAT</entry></row>
          <row><entry>▶+</entry></row>
          <row><entry><parameter>replies-following-hint</parameter>:</entry><entry>CARD32</entry></row>
          <row><entry><parameter>offsets</parameter>:</entry><entry>LISTofOFFSET32</entry></row>
          <row rowsep='1'><entry><parameter>bitmaps</parameter>:</entry><entry><type>LISTofBYTE</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Font</errorname>,
          <errorname>Range</errorname>,
          <errorname>Format</errorname>,
          <errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <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
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 <errorname>Range</errorname>
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.
    </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
offsets and bitmaps is returned.
    </para>
    <para>
<!-- .sp -->
If any of the resulting character ranges are invalid, a <errorname>Range</errorname>
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.
    </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
partitioned into an implementation-dependent number of
ordered, non-overlapping subsets containing runs of one or
more consecutive characters.  The global ordering of
characters must be maintained such that concatenating the
subsets in order that they were produced yields the original
set.  A reply is generated for each subset, in the order that
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
and clear bits represent inked and non-inked pixels,
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
to right into a sequence of FORMAT.SCANLINE-UNIT bits.  The
bits of each unit are then arranged such that the left-most
pixel is stored in the most- or least-significant bit,
according to FORMAT.BIT-ORDER-MSB.  The bytes of each unit are
then arranged such that the most- or least-significant byte,
according to FORMAT.BYTE-ORDER-MSB, is transmitted first.
Finally, the units are arranged such that the left-most is
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
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
glyph image must begin at a bit position that is a multiple of
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
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).
    </para>
    <para>
<!-- .sp -->
The REPLIES-FOLLOWING-HINT 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 <errorname>Font</errorname>
error is returned.  If RANGE is True and CHARS contains any invalid
ranges, a <errorname>Range</errorname> error is returned.
If FORMAT is invalid, a <errorname>Format</errorname> error is returned.
    </para>
</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><type>FONTID</type></entry></row>
          <row><entry>Errors:</entry><entry><errorname>Font</errorname>, <errorname>Alloc</errorname></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This request indicates that the specified FONTID 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>
request.
    </para>
    <para>
<!-- .sp -->
If FONTID is not associated with any open fonts, a
<errorname>Font</errorname>
error is returned.
    </para>
</section>

<section id="Requests:close_connection">
    <title>close connection</title>
    <indexterm zone="Requests:close_connection" significance="preferred"><primary>close connection</primary></indexterm>

    <para>
When a connection is closed, a
<function>CloseFont</function>
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>
</section>
</section>

<section id='Errors'>
<title>Errors</title>
<!-- .XS -->
<!-- (SN Errors -->
<!-- .XE -->
<para>
All errors are at least 16 bytes long and contain the following fields:
</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><parameter>type</parameter>:</entry><entry>CARD8</entry><entry>value of 1</entry></row>
          <row><entry><parameter>error-code</parameter>:</entry><entry>CARD8</entry></row>
          <row><entry><parameter>sequence-number</parameter>:</entry><entry>CARD16</entry></row>
          <row><entry><parameter>length</parameter>:</entry><entry>CARD32</entry></row>
          <row><entry><parameter>timestamp</parameter>:</entry><entry>TIMESTAMP</entry></row>
          <row><entry><parameter>major-opcode</parameter>:</entry><entry>CARD8</entry></row>
          <row><entry><parameter>minor-opcode</parameter>:</entry><entry>CARD8</entry></row>
          <row><entry><parameter>data-or-unused</parameter>:</entry><entry>CARD16</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
least significant 16 bits of the sequence number of the request that caused the
error.  The LENGTH field specifies the length of the error packet in 4-byte
units and must have a value of at least 4.  The TIMESTAMP specifies the server
time when the error occurred.  The MAJOR-OPCODE and MINOR-OPCODE (zero for core
requests) fields specify the type of request that generated the error.  The
DATA-OR-UNUSED field may be used for 16 bits of error-specific information.  If
LENGTH is greater than four, these fields are followed by (LENGTH - 4) * 4
bytes of extra data.
</para>
<para>
<!-- .LP -->
The following errors are defined for the core protocol:
</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>CARD16</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>
of that extension.
    </para>
</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>CARD16</entry><entry>unused</entry></row>
          <row><entry><parameter>format</parameter>:</entry><entry>BITMAPFORMAT</entry><entry>bad format value</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This error is generated by the use of an invalid BITMAPFORMAT
in the
<function>OpenBitmapFont</function>,
<function>QueryXBitmaps8</function>, and
<function>QueryXBitmaps16</function>
requests.
The value that caused the error is included as extra data.
    </para>
</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>CARD16</entry><entry>unused</entry></row>
          <row><entry><parameter>fontid</parameter>:</entry><entry>FONTID</entry><entry>bad font identifier</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <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>
and
<function>CloseFont</function>
requests.  The value that caused
the error is included as extra data.
    </para>
</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>CARD16</entry><entry>unused</entry></row>
          <row><entry><parameter>range</parameter>:</entry><entry>RANGE</entry><entry>bad range</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This error is generated by an invalid RANGE in the
<function>QueryXExtents8</function>,
<function>QueryXExtents16</function>,
<function>QueryXBitmaps8</function>
and
<function>QueryXBitmaps16</function>
requests.  The
value that caused the error is included as extra data.
    </para>
</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>CARD16</entry><entry>unused</entry></row>
          <row><entry><parameter>event-mask</parameter>:</entry><entry>EVENTMASK</entry><entry>bad event mask</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This error is generated by an invalid EVENTMASK in the
<function>SetEventMask</function>
request.  The value that caused the error is
included as extra data.
    </para>
</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>CARD16</entry><entry>unused</entry></row>
          <row><entry><parameter>ac</parameter>:</entry><entry>ACCESSCONTEXT</entry><entry>unaccepted <type>AccessContext</type></entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This error is generated by an invalid ACCESSCONTEXT in the
<function>FreeAC</function>
or
<function>SetAuthorization</function>
request or by an
<function>OpenBitmapFont</function>
request performed without sufficient authorization.  In the
first two cases, the ACCESSCONTEXT of the errant request is
returned as extra data.  In the third case, the current
ACCESSCONTEXT 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>CARD16</entry><entry>unused</entry></row>
          <row><entry><parameter>id</parameter>:</entry><entry>ID</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
in an
<function>OpenBitmapFont</function>
request.  The value that caused the error
is included as extra data.
    </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>CARD16</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>
request or no catalogue names in a
<function>SetCatalogues</function>
request.
    </para>
</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>CARD16</entry><entry>X value of errant resolution</entry></row>
          <row><entry><parameter>y-resolution</parameter>:</entry><entry>CARD16</entry><entry>Y value of errant resolution</entry></row>
          <row><entry><parameter>point-size</parameter>:</entry><entry>CARD16</entry><entry>point size of errant resolution</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This error is generated in response to an invalid RESOLUTION
structure in a
<function>SetResolution</function>
request.  The value that caused the
error is included in the DATA-OR-UNUSED field and as extra data.
    </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>CARD16</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>
</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>CARD16</entry><entry>unused</entry></row>
          <row><entry><parameter>length</parameter>:</entry><entry>CARD32</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>
</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>CARD16</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.
    </para>
</section>
<section id="Errors:Extensions">
  <title>Extensions</title>
    <para>
Additional errors may be defined by extensions.
    </para>
</section>
</section>

<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>CARD8</entry><entry>value of 2</entry></row>
          <row><entry><parameter>event-code</parameter>:</entry><entry>CARD8</entry></row>
          <row><entry><parameter>sequence-number</parameter>:</entry><entry>CARD16</entry></row>
          <row><entry><parameter>length</parameter>:</entry><entry>CARD32</entry></row>
          <row><entry><parameter>timestamp</parameter>:</entry><entry>TIMESTAMP</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
</para>
<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
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>
<para>
If an event does not provide any extra arguments, the
<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>

<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>
</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>BOOL</entry></row>
          <row><entry><parameter>deleted</parameter>:</entry><entry>BOOL</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This event is sent to clients that have included
<function>CatalogueListChangeMask</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>
</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>BOOL</entry></row>
          <row><entry><parameter>deleted</parameter>:</entry><entry>BOOL</entry></row>
        </tbody>
      </tgroup>
    </informaltable>
    <para>
This event is sent to clients that have included
<function>FontListChangeMask</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
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
from any of catalogues used by the client, otherwise it
is False.
    </para>
</section>
<section id="Events:Extensions">
  <title>Extensions</title>
    <para>
Additional events may be defined by extensions.
    </para>
</section>
</section>
</chapter>

<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 are in decimal.  Requests, replies, errors, events, and compound types
are described using the syntax:
</para>
<!-- .RS -->
<literallayout class="monospaced">

    Name
     <emphasis remap='I'>count</emphasis>          <emphasis remap='I'>contents</emphasis>     <emphasis remap='I'>name</emphasis>
     ...
     <emphasis remap='I'>count</emphasis>          <emphasis remap='I'>contents</emphasis>     <emphasis remap='I'>name</emphasis>
</literallayout>

<!-- .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
<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".
</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
multiple of four:
</para>
<!-- .RS -->
<literallayout class="monospaced">

     pad(e) = (4 - (e mod 4)) mod 4
</literallayout>

<section id='Encoding::Data_Types'>
<title>Data Types</title>
<!-- .XS -->
<!-- (SN Data Types -->
<!-- .XE -->
<!-- .sp 6p -->
<literallayout class="monospaced">
ACCESSCONTEXT

4 CARD32 access context with at least one of the following bits set:

#x1fffffff

but none of the following bits set:

#xe0000000               zero


ALTERNATESERVER
1     BOOL               subset
1     n                  length of name
n     STRING8            name
p                        unused, p=pad(n+2)

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)


BITMAPFORMAT

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

except for the following bits which must be zero:

     #xffffccf0           zero

and the following of which at most one bit may be set:

     #x0000000c at most one bit can be set


BITMAPFORMATMASK

4 CARD32 value, mask of the following bits:

     #x00000001           ByteOrderMask
     #x00000002           BitOrderMask
     #x00000004           ImageRectMask
     #x00000008           ScanlinePadMask
     #x00000010           ScanlineUnitMask

except for the following bits which must be zero:

     #xffffffe0           zero

BOOL

1    BOOL       boolean, one of the following values:
0    False
1    True

BYTE
1    BYTE       unsigned byte of data

CARD8
1    CARD8       8-bit unsigned integer

CARD16
2    CARD16      16-bit unsigned integer

CARD32
4    CARD32      32-bit unsigned integer

CHAR2B
1    CARD8       byte1
1    CARD8       byte2

EVENTMASK
4    CARD32 event mask
     for core events, this is union of the following bits:

     #00000001   CatalogueListChangeMask
     #00000002   FontListChangeMask

but none of the following bits set:

     #fffffffc

extensions define their own sets of bits

FONTID

4 CARD32 font identifier with at least one of
the following bits set:

     #x1fffffff

but none of the following bits set:

     #xe0000000   zero

INT8
1    INT8         8-bit signed integer

INT16
2    INT16         16-bit signed integer

INT32
4    INT32         32-bit signed integer

OFFSET32
4    CARD32         position (or integer value)
4    CARD32         length

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

PROPOFFSET
8    OFFSET32         name in data block
8    OFFSET32         value in data block

1 CARD8 type, one of the following values:
0    String
1    Unsigned
2    Signed
3    zero

RANGE
2    CHAR2B                 minimum character code
2    CHAR2B         maximum character code

RESOLUTION
2    CARD16 x resolution in pixels per inch
2    CARD16 y resolution in pixels per inch
2    CARD16 point size in decipoints

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
</literallayout>
</section>

<section id='Encoding::Requests'>
<title>Requests</title>
<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
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
2     2                      major version
2     0                      version
1     CARD8                  numberof alternate-servers-hint
1     CARD8                  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
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
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
and closes the connection:
</para>

<literallayout class="monospaced">
◀
4     1+(d+q)/4              length
d     LISTofBYTE             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
q                            unused, q=pad(d)
</literallayout>
<para>
When STATUS is Success, 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     v                      length of vendor string
4     CARD32                 release-number
v     STRING8                vendor-string
w                            unused, w=pad(v)
</literallayout>
<para>
Once the connection has been established, the client may send the
following requests:
</para>

<literallayout class="monospaced">
<link linkend="Requests:NoOp"><emphasis role="bold"><function>NoOp</function></emphasis></link>
1   0                        major-opcode
1                            unused
2   1                        length

<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
4   2+(n+p)/4                length
n   LISTofSTRNAME            names
p                            unused, p=pad(n)

<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
p                            unused, p=pad(n)
▶
1   0                        type reply
1   BOOL                     present
2   CARD16                   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
3                            unused

<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
2   n                        length of pattern
2                            unused
n   STRING8                  pattern
p                            unused, p=pad(n)
▶+
1   0                        type reply
1                            unused
2   CARD16                   sequence-number
4   4+(n+p)/4                length
4   CARD32                   replies-following-hint
4   CARD32                   numberof catalogue-names
n   LISTofSTRNAME            catalogue-names
p                            unused, p=pad(n)

<link linkend="Requests:SetCatalogues"><emphasis role="bold"><function>SetCatalogues</function></emphasis></link>
1   4                        major-opcode
1   CARD8                    numberof catalogue-names
2   1+(n+p)/4                length
n   LISTofSTRNAME            catalogue-names
p                            unused, p=pad(n)

<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
4   2+(n+p)/4                length
n   LISTofSTRNAME            catalogue-names
p                            unused, p=pad(n)

<link linkend="Requests:SetEventMask"><emphasis role="bold"><function>SetEventMask</function></emphasis></link>
1   6                        major-opcode
1   CARD8                    extension-opcode
2   2                        length
4   EVENTMASK                event-mask

<link linkend="Requests:GetEventMask"><emphasis role="bold"><function>GetEventMask</function></emphasis></link>
1   7                        major-opcode
1   CARD8                    extension-opcode
2   1                        length
▶
1   0                        type reply
1                            unused
2   CARD16                   sequence-number
4   3                        length
4   EVENTMASK                event-mask

<link linkend="Requests:CreateAC"><emphasis role="bold"><function>CreateAC</function></emphasis></link>
1   8                        major-opcode
1   CARD8                    numberof authorization-protocols
2   2+a/4                    length
4   ACCESSCONTEXT            ac
a   LISTofAUTH               authorization-protocols
▶
1   0                        type reply
1   CARD8                    authorization-index
2   CARD16                   sequence-number
4   3+(d+q)/4                length
2   CARD16                   status
    0 Success
    1 Continue
    2 Busy
    3 Denied
2                            unused
d   LISTofBYTE               authorization-data
q                            unused, q=pad(d)
</literallayout>

<para>
If STATUS is Continue, 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.
</para>

<literallayout class="monospaced">
◀
4   1+(d+q)/4                length
d   LISTofBYTE               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               authorization-data
q                            unused, q=pad(d)

<link linkend="Requests:FreeAC"><emphasis role="bold"><function>FreeAC</function></emphasis></link>
1   9                        major-opcode
1                            unused
2   2                        length
4   ACCESSCONTEXT            ac

<link linkend="Requests:SetAuthorization"><emphasis role="bold"><function>SetAuthorization</function></emphasis></link>
1   10                       major-opcode
1                            unused
2   2                        length
4   ACCESSCONTEXT            ac

<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
p   p=pad(6*n)

<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
4   2+(6*n+p)/4              length
6*n LISTofRESOLUTION         resolutions
p   p=pad(6*n)

<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
2   n                        length of pattern
2                            unused
n   STRING8                  pattern
p                            unused, p=pad(n)
▶+
1   0                        type reply
1                            unused
2   CARD16                   sequence-number
4   4+(n+p)/4                length
4   CARD32                   replies-following-hint
4   CARD32                   numberof font-names
n   LISTofSTRNAME            font-names
p                            unused, p=pad(n)

<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
2   n                        length of pattern
2                            unused
n   STRING8                  pattern
p                            unused, p=pad(n)
▶+ (except for last in series)
1   0                        type reply
1   n                        length of name
2   CARD16                   sequence-number
4   3+(n+p+f)/4              length
4   CARD32                   replies-hint
f   XFONTINFO                fontinfo
n   STRING8                  name
p                            unused, p=pad(n)
▶ (last in series)
1   0                        type reply
1   0                        last-reply indicator
2   CARD16                   sequence-number
4   2                        reply length

<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
n   STRNAME                  pattern
p                            unused, p=pad(n)
▶
1   0                        type reply
1   BOOL                     otherid-valid
2   CARD16                   sequence-number
4   4                        length
4   FONTID                   otherid
1   BOOL                     cachable
3                            unused

<link linkend="Requests:QueryXInfo"><emphasis role="bold"><function>QueryXInfo</function></emphasis></link>
1   16                       major-opcode
1                            unused
2   2                        length
4   FONTID                   fontid
▶
1   0                        type reply
1                            unused
2   CARD16                   sequence-number
4   2+f/4                    length
f   XFONTINFO                fontinfo
p                            unused, p=pad(f)

<link linkend="Requests:QueryXExtents8"><emphasis role="bold"><function>QueryXExtents8</function></emphasis></link>
1   17                       major-opcode
1   BOOL                     range
2   3+(n+p)/4                length
4   FONTID                   fontid
4   n                        number chars entries
n   STRING8                  chars
p                            unused, p=pad(n)
▶
1   0                        type reply
1                            unused
2   CARD16                   sequence-number
4   3+3*n                    length
4   n                        number of extents
12*n LISTofXCHARINFO         extents

<link linkend="Requests:QueryXExtents16"><emphasis role="bold"><function>QueryXExtents16</function></emphasis></link>
1   18                       major-opcode
1   BOOL                     range
2   3+(2*n+p)/4              length
4   FONTID                   fontid
4   n                        number chars entries
2*n                          LISTofCHAR2B chars
p                            unused, p=pad(2*n)
▶
1   0                        type reply
1                            unused
2   CARD16                   sequence-number
4   3+3*n                    length
4   n                        number of extents
12*n LISTofXCHARINFO         extents

<link linkend="Requests:QueryXBitmaps8"><emphasis role="bold"><function>QueryXBitmaps8</function></emphasis></link>
1   19                       major-opcode
1   BOOL                     range
2   4+(n+p)/4                length
4   FONTID                   fontid
4   BITMAPFORMAT             format
4   n                        number of chars entries
n   STRING8                  chars
p                            unused, p=pad(n)
▶+
1   0                        type reply
1                            unused
2   CARD16                   sequence-number
4   5+2*n+(m+p)/4            length
4   CARD32                   replies-following-hint
4   n                        number of offsets
4   m                        number of bytes of glyph images
8*n LISTofOFFSET32           offsets
m   LISTofBYTE               glyphimages
p                            unused, p=pad(m)

<link linkend="Requests:QueryXBitmaps16"><emphasis role="bold"><function>QueryXBitmaps16</function></emphasis></link>
1   20                       major-opcode
1   BOOL                     range
2   4+(2*n+p)/4              length
4   FONTID                   fontid
4   BITMAPFORMAT             format
4   n                        number of chars entries
2*n LISTofCHAR2B             chars
p                            unused, p=pad(2*n)
▶
1   0                        type reply
1                            unused
2   CARD16                   sequence-number
4   5+2*n+(m+p)/4            length
4   CARD32                   replies-following-hint
4   n                        number of offsets
4   m                        number of bytes of glyph images
8*n LISTofOFFSET32           offsets
m   LISTofBYTE               glyphimages
p                            unused, p=pad(m)

<link linkend="Requests:CloseFont"><emphasis role="bold"><function>CloseFont</function></emphasis></link>
1   21                       major-opcode
1                            unused
2   2                        length
4   FONTID                   fontid
</literallayout>
</section>

<section id='Encoding::Errors'>
<title>Errors</title>
<literallayout class="monospaced">

<link linkend="Errors:Request"><emphasis role="bold"><errorname>Request</errorname></emphasis></link>
1   1                        type error
1   0                        <errorname>Request</errorname>
2   CARD16                   sequence-number
4   4                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused

<link linkend="Errors:Format"><emphasis role="bold"><errorname>Format</errorname></emphasis></link>
1   1                        type error
1   1                        <errorname>Format</errorname>
2   CARD16                   sequence-number
4   5                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused
4   BITMAPFORMAT             bad-format

<link linkend="Errors:Font"><emphasis role="bold"><errorname>Font</errorname></emphasis></link>
1   1                        type error
1   2                        <errorname>Font</errorname>
2   CARD16                   sequence-number
4   5                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused
4   FONTID bad-fontid

<link linkend="Errors:Range"><emphasis role="bold"><errorname>Range</errorname></emphasis></link>
1   1                        type error
1   3                        <errorname>Range</errorname>
2   CARD16                   sequence-number
4   5                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused
4   RANGE                    bad-range

<link linkend="Errors:EventMask"><emphasis role="bold"><errorname>EventMask</errorname></emphasis></link>
1   1                        type error
1   4                        <errorname>EventMask</errorname>
2   CARD16                   sequence-number
4   5                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused
4   EVENTMASK                event-mask

<link linkend="Errors:AccessContext"><emphasis role="bold"><errorname>AccessContext</errorname></emphasis></link>
1   1                        type error
1   5                        <errorname>AccessContext</errorname>
2   CARD16                   sequence-number
4   5                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused
4   ACCESSCONTEXT            access context

<link linkend="Errors:IDChoice"><emphasis role="bold"><errorname>IDChoice</errorname></emphasis></link>
1   1                        type error
1   6                        <errorname>IDChoice</errorname>
2   CARD16                   sequence-number
4   5                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused
4   FONTID                   bad-fontid

<link linkend="Errors:Name"><emphasis role="bold"><errorname>Name</errorname></emphasis></link>
1   1                        type error
1   7                        <errorname>Name</errorname>
2   CARD16                   sequence-number
4   4                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused

<link linkend="Errors:Resolution"><emphasis role="bold"><errorname>Resolution</errorname></emphasis></link>
1   1                        type error
1   8                        <errorname>Resolution</errorname>
2   CARD16                   sequence-number
4   5                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
6   RESOLUTION               resolution

<link linkend="Errors:Alloc"><emphasis role="bold"><errorname>Alloc</errorname></emphasis></link>
1   1                        type error
1   9                        <errorname>Alloc</errorname>
2   CARD16                   sequence-number
4   4                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused

<link linkend="Errors:Length"><emphasis role="bold"><errorname>Length</errorname></emphasis></link>
1   1                        type error
1   10                       <errorname>Length</errorname>
2   CARD16                   sequence-number
4   5                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused
4   CARD32                   bad-length

<link linkend="Errors:Implementation"><emphasis role="bold"><errorname>Implementation</errorname></emphasis></link>
1   1                        type error
1   11                       <errorname>Implementation</errorname>
2   CARD16                   sequence-number
4   4                        length
4   TIMESTAMP                timestamp
1   CARD8                    major-opcode
1   CARD8                    minor-opcode
2                            unused

</literallayout>
</section>

<section id='Encoding::Events'>
<title>Events</title>
<literallayout class="monospaced">
<link linkend="Events:KeepAlive"><emphasis role="bold"><function>KeepAlive</function></emphasis></link>
1   2                        type event
1   0                        event KeepAlive
2   CARD16                   sequence-number
4   3                        length
4   TIMESTAMP                timestamp

<link linkend="Events:CatalogueListNotify"><emphasis role="bold"><function>CatalogueListNotify</function></emphasis></link>
1   2                        type event
1   1                        event CatalogueListNotify
2   CARD16                   sequence-number
4   4                        length
4   TIMESTAMP                timestamp
1   BOOL                     added
1   BOOL                     deleted
2                            unused

<link linkend="Events:FontListNotify"><emphasis role="bold"><function>FontListNotify</function></emphasis></link>
1   2                        type event
1   2                        event FontListNotify
2   CARD16                   sequence-number
4   4                        length
4   TIMESTAMP                timestamp
1   BOOL                     added
1   BOOL                     deleted
2                            unused

</literallayout>
</section>
</chapter>

<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
<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
<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.
<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>
</chapter>

<bibliography id='References'>
<title>References</title>
<para>
All of the following documents are X Consortium standards available from
the X Consortium.
</para>
<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 id='References:bdf-spec'>
  <abbrev>2</abbrev>
  <corpauthor>Adobe Systems</corpauthor>
  <title>Bitmap Distribution Format 2.1</title>
</biblioentry>

<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>

<appendix id="suggested_licensing_policies">
<title>Suggested Licensing Policies</title>
<para>
The authorization data passed by the client in the initial connection
setup information may be used by the font server to implement restrictions
on which fonts may be accessed.  Furthermore, the font server is free to
refuse new connections at any time.
</para>
<para>
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:

<variablelist>
  <?dbhtml list-presentation="list"?>
  <varlistentry>
    <term>No restrictions</term>
  <listitem>
    <para>
anyone may access any fonts.  The server neither refuses any connections
nor generates <errorname>AccessContext</errorname> errors on any
fonts.  For environments without specially-licensed fonts, this is
sufficient.
    </para>
  </listitem>
  </varlistentry>
  <varlistentry>
    <term>Per-machine</term>
  <listitem>
    <para>
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>
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>
only a certain number of clients may use a given font at any one time.
Additional clients would receive <errorname>AccessContext</errorname>
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>
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 <errorname>AccessContext</errorname> error.
    </para>
  </listitem>
  </varlistentry>
</variablelist>
</para>

<para>
It should be noted that chaining of font servers (obtaining font data from
other font servers) may conflict with certain license policies.
</para>
</appendix>

<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>
<itemizedlist>
  <listitem>
    <para>
The initial connection information returned by the font
server contains the names of other font servers that
may be used as substitutes.  A font server may refuse to
accept a connection, indicating that the client should
try one of the alternatives instead.
    </para>
  </listitem>
  <listitem>
    <para>
On operating systems that support processing forking, font
servers might choose to fork so that the child can continue
processing the existing connections and the parent can accept
new connections.  Such implementations are encouraged to use
shared memory so that in-memory font databases can be shared.
    </para>
  </listitem>
  <listitem>
    <para>
On operating systems that support passing stream file descriptors
between processes, cooperating font servers could collect
connections in a single process when there are few connections
and spread them among several processes as the load increases.
    </para>
  </listitem>
  <listitem>
    <para>
If a font client is unable to connect to a server (as opposed
to having the connection terminated), it should retry for an
implementation-dependent length of time (see Xlib's
handling of ECONNREFUSED in XConnDis.c).
    </para>
  </listitem>
</itemizedlist>
</appendix>
<index id="index" />
</book>