Update to bigreqsproto 1.1.2. No functional changes.
This commit is contained in:
matthieu
parent
57636928ae
commit
64d16a4d7e
@ -1,3 +1,214 @@
|
||||
commit 9880dfa3489eddd8aaa1bdf24f621b13e514d5db
|
||||
Author: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
Date: Thu Mar 22 20:38:40 2012 -0700
|
||||
|
||||
bigreqsproto 1.1.2
|
||||
|
||||
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
|
||||
commit 65ba594c8e6c28ed5ec99552812bc238855f8f9a
|
||||
Author: Matt Dew <marcoz@osource.org>
|
||||
Date: Sat Jan 14 23:02:51 2012 -0700
|
||||
|
||||
informaltable cleanup
|
||||
|
||||
On certain tables, add top and bottom borders to table
|
||||
header and a bottom border to the table. This matches
|
||||
what those tables in the old pdfs looked like.
|
||||
|
||||
the <?dbfo keep-together='always'> prevents tables from
|
||||
splitting across pages. Useful for tiny tables.
|
||||
|
||||
Converting the colwidth to a floating point,
|
||||
WARNING: table-layout="fixed" and column-width unspecified
|
||||
=> falling back to proportional-column-width(1)
|
||||
|
||||
Signed-off-by: Matt Dew <marcoz@osource.org>
|
||||
|
||||
commit cc6006cb0db1373fffe92e9f00a8d06c8387e914
|
||||
Author: Matt Dew <marcoz@osource.org>
|
||||
Date: Sat Oct 1 01:52:59 2011 -0600
|
||||
|
||||
1 - fix the capitolization of the ID attriutes to match either the
|
||||
<title> or <funcdef> string it goes with.
|
||||
2 - fix any <linkend>'s that were affected by 1.
|
||||
3 - any <function> in the docs that has an actual funcdef,
|
||||
will become an olink.
|
||||
|
||||
Signed-off-by: Matt Dew <marcoz@osource.org>
|
||||
|
||||
commit abdd33c74d55238f5db4f7d5b40278f78c13ac25
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Fri Sep 16 17:09:05 2011 -0400
|
||||
|
||||
specs: fix author affiliation
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit 1d7e57287990ec1631432299bad25cdd4180c62e
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Mon Sep 12 16:54:45 2011 -0400
|
||||
|
||||
docs: use the &fullrelvers; entity to set X11 release information
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit 6540a8ea44213746d76d07c94444e937a791c1ff
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Sun Sep 11 19:49:54 2011 -0400
|
||||
|
||||
docs: remove <productnumber> which is not used by default
|
||||
|
||||
This element is not rendered by default on the title. A template
|
||||
customization is required to display it.
|
||||
X Window System does not have a product number.
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit 5306b4b7f3254a8ba3d24be86a8dd53b3d0699a1
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Thu Sep 8 20:00:00 2011 -0400
|
||||
|
||||
docbook.am: embed css styles inside the HTML HEAD element
|
||||
|
||||
Rather than referring to the external xorg.css stylesheet, embed the content
|
||||
of the file in the html output produced. This is accomplished by using
|
||||
version 1.10 of xorg-xhtml.xsl.
|
||||
|
||||
This makes the whole html docs tree much more relocatable.
|
||||
In addition, it eliminates xorg.css as a runtime file which makes
|
||||
xorg-sgml-doctools a build time only package.
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit 2e7dba38d2795735d6cbca4b6a799a2050e64313
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Wed Sep 7 10:31:04 2011 -0400
|
||||
|
||||
docbook.am: global maintenance update - entities, images and olinking
|
||||
|
||||
Adding support in libX11 for html chunking caused a reorg of docbook.am
|
||||
as well as the xorg-sgml-doctools masterdb for olinking.
|
||||
The parameter img.src.path is added for pdf images.
|
||||
A searchpath to the root builddir is added for local entities, if present.
|
||||
|
||||
The docbook.am makefile hides all the details and is identical for
|
||||
all 22 modules having DocBook documentation. It is included by a thin
|
||||
Makefile.am which requires no docbook knowledge.
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit d5028b4fd5d4541378fd0523f013a5e3cf1c6414
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Sun Jun 12 17:54:50 2011 -0400
|
||||
|
||||
Install xml versions of specs even if HAVE_XMLTO is false
|
||||
|
||||
DocBook/XML input source is also a usefull output format that can be viewed
|
||||
with an XML viewer or editor and by some O/S help system.
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit 301dd63364857bc1547f1beb58c787bfdf11e19b
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Sun Jun 5 16:27:37 2011 -0400
|
||||
|
||||
Install target dbs alongside generated documents
|
||||
|
||||
This matches a change in xorg-sgml-docs whereby the masterdb will look for
|
||||
the target dbs into the same location as the generated documents.
|
||||
|
||||
The target dbs are now installed alongside the generated documents.
|
||||
Previously they are installed in $prefix/sgml/X11/dbs alongside masterdb which
|
||||
has the potential of installing outside the package prefix and cause
|
||||
distcheck to fail when user does not have write permission in this package.
|
||||
|
||||
Requires XORG_CHECK_SGML_DOCTOOLS(1.8) which was released 2011-06-11
|
||||
|
||||
commit f92b5feb06129abb6a7a1eb86504bcb584f94320
|
||||
Author: Matt Dew <marcoz@osource.org>
|
||||
Date: Wed May 25 22:00:07 2011 -0600
|
||||
|
||||
Add id attribute to funcsynopsis to allow other docs to olink
|
||||
|
||||
Signed-off-by: Matt Dew <marcoz@osource.org>
|
||||
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit f107d40a9e91e0cd06635c29a51633339f0f7465
|
||||
Author: Matt Dew <marcoz@osource.org>
|
||||
Date: Sun May 22 19:34:50 2011 -0600
|
||||
|
||||
Add olinks to functions decribed in libX11 documentation.
|
||||
|
||||
This patch is used with the libX11 patch.
|
||||
It turns the functions listed in this doc into hyperlinks to the
|
||||
declarations that are in libX11 documentation.
|
||||
|
||||
Signed-off-by: Matt Dew <marcoz@osource.org>
|
||||
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit 20537dba79058f09d3dc9cfafb6114f2c77f1e83
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Sun Feb 27 15:06:18 2011 -0500
|
||||
|
||||
Documentation: add Docbook external references support
|
||||
|
||||
When writing technical documentation, it is often necessary to cross
|
||||
reference to other information. When that other information is not in the
|
||||
current document, additional support is needed, namely <olink>.
|
||||
|
||||
A new feature with version 1.7 of xorg-sgml-doctools adds references to
|
||||
other documents within or outside this package.
|
||||
|
||||
This patch adds technical support for this feature but does not change
|
||||
the content of the documentation as seen by the end user.
|
||||
|
||||
Each book or article must generate a database containing the href
|
||||
of sections that can be referred to from another document. This database
|
||||
is installed in DATAROOTDIR/sgml/X11/dbs. There is a requirement that
|
||||
the value of DATAROOTDIR for xorg-sgml-doctools and for the package
|
||||
documentation is the same. This forms a virtual document tree.
|
||||
|
||||
This database is consulted by other documents while they are being generated
|
||||
in order to fulfill the missing information for linking.
|
||||
Refer to the xorg-sgml-doctools for further technical information.
|
||||
|
||||
Co-authored-by: Matt Dew <marcoz@osource.org>
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit 872a6cb826f1d21c841d7df4b59a5fb993342353
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Thu Feb 24 20:37:00 2011 -0500
|
||||
|
||||
Docbook: change the book id to match the xml file basename
|
||||
|
||||
This is required for the up-coming external references support.
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit d9ee7b60c2b677323cf71ebb203a73d1aaf3f528
|
||||
Author: Paulo Zanoni <pzanoni@mandriva.com>
|
||||
Date: Thu Dec 16 13:36:00 2010 -0200
|
||||
|
||||
Use docbookx.dtd version 4.3 for all docs
|
||||
|
||||
Signed-off-by: Paulo Zanoni <pzanoni@mandriva.com>
|
||||
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
|
||||
commit 0c63dfb7abac7648638384cd1807e36c27ff6d0e
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Tue Nov 9 15:19:09 2010 -0500
|
||||
|
||||
config: HTML file generation: use the installed copy of xorg.css
|
||||
|
||||
Currenlty the xorg.css file is copied in each location
|
||||
where a DocBook/XML file resides. This produces about
|
||||
70 copies in the $(docdir) install tree.
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit 59730aba859c0b586b7e63e79c07b7741719845d
|
||||
Author: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
Date: Fri Oct 29 20:21:07 2010 -0700
|
||||
|
||||
@ -1,18 +1,19 @@
|
||||
AC_PREREQ([2.60])
|
||||
AC_INIT([BigReqsProto], [1.1.1],
|
||||
AC_INIT([BigReqsProto], [1.1.2],
|
||||
[https://bugs.freedesktop.org/enter_bug.cgi?product=xorg])
|
||||
AM_INIT_AUTOMAKE([foreign dist-bzip2])
|
||||
AM_MAINTAINER_MODE
|
||||
|
||||
# Require xorg-macros minimum of 1.10 for DocBook XML documentation
|
||||
# Require xorg-macros minimum of 1.12 for DocBook external references
|
||||
m4_ifndef([XORG_MACROS_VERSION],
|
||||
[m4_fatal([must install xorg-macros 1.10 or later before running autoconf/autogen])])
|
||||
XORG_MACROS_VERSION(1.10)
|
||||
[m4_fatal([must install xorg-macros 1.12 or later before running autoconf/autogen])])
|
||||
XORG_MACROS_VERSION(1.12)
|
||||
XORG_DEFAULT_OPTIONS
|
||||
XORG_ENABLE_SPECS
|
||||
XORG_WITH_XMLTO(0.0.20)
|
||||
XORG_WITH_XMLTO(0.0.22)
|
||||
XORG_WITH_FOP
|
||||
XORG_CHECK_SGML_DOCTOOLS(1.5)
|
||||
XORG_WITH_XSLTPROC
|
||||
XORG_CHECK_SGML_DOCTOOLS(1.8)
|
||||
|
||||
AC_OUTPUT([Makefile
|
||||
specs/Makefile
|
||||
|
||||
105
proto/bigreqsproto/docbook.am
Normal file
105
proto/bigreqsproto/docbook.am
Normal file
@ -0,0 +1,105 @@
|
||||
#
|
||||
# Generate output formats for a single DocBook/XML with/without chapters
|
||||
#
|
||||
# Variables set by the calling Makefile:
|
||||
# shelfdir: the location where the docs/specs are installed. Typically $(docdir)
|
||||
# docbook: the main DocBook/XML file, no chapters, appendix or image files
|
||||
# chapters: all files pulled in by an XInclude statement and images.
|
||||
#
|
||||
|
||||
#
|
||||
# This makefile is intended for Users Documentation and Functional Specifications.
|
||||
# Do not use for Developer Documentation which is not installed and does not require olink.
|
||||
# Refer to http://www.x.org/releases/X11R7.6/doc/xorg-docs/ReleaseNotes.html#id2584393
|
||||
# for an explanation on documents classification.
|
||||
#
|
||||
|
||||
# DocBook/XML generated output formats to be installed
|
||||
shelf_DATA =
|
||||
|
||||
# DocBook/XML file with chapters, appendix and images it includes
|
||||
dist_shelf_DATA = $(docbook) $(chapters)
|
||||
|
||||
if HAVE_XMLTO
|
||||
if HAVE_STYLESHEETS
|
||||
|
||||
XMLTO_SEARCHPATH_FLAGS = \
|
||||
--searchpath "$(XORG_SGML_PATH)/X11" \
|
||||
--searchpath "$(abs_top_builddir)"
|
||||
XMLTO_HTML_OLINK_FLAGS = \
|
||||
--stringparam target.database.document=$(XORG_SGML_PATH)/X11/dbs/masterdb.html.xml \
|
||||
--stringparam current.docid="$(<:.xml=)"
|
||||
XMLTO_HTML_STYLESHEET_FLAGS = -x $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl
|
||||
XMLTO_HTML_FLAGS = \
|
||||
$(XMLTO_SEARCHPATH_FLAGS) \
|
||||
$(XMLTO_HTML_STYLESHEET_FLAGS) \
|
||||
$(XMLTO_HTML_OLINK_FLAGS)
|
||||
|
||||
shelf_DATA += $(docbook:.xml=.html)
|
||||
%.html: %.xml $(chapters)
|
||||
$(AM_V_GEN)$(XMLTO) $(XMLTO_HTML_FLAGS) xhtml-nochunks $<
|
||||
|
||||
if HAVE_XMLTO_TEXT
|
||||
|
||||
shelf_DATA += $(docbook:.xml=.txt)
|
||||
%.txt: %.xml $(chapters)
|
||||
$(AM_V_GEN)$(XMLTO) $(XMLTO_HTML_FLAGS) txt $<
|
||||
endif HAVE_XMLTO_TEXT
|
||||
|
||||
if HAVE_FOP
|
||||
XMLTO_FO_IMAGEPATH_FLAGS = --stringparam img.src.path=$(abs_builddir)/
|
||||
XMLTO_PDF_OLINK_FLAGS = \
|
||||
--stringparam target.database.document=$(XORG_SGML_PATH)/X11/dbs/masterdb.pdf.xml \
|
||||
--stringparam current.docid="$(<:.xml=)"
|
||||
XMLTO_FO_STYLESHEET_FLAGS = -x $(STYLESHEET_SRCDIR)/xorg-fo.xsl
|
||||
|
||||
XMLTO_FO_FLAGS = \
|
||||
$(XMLTO_SEARCHPATH_FLAGS) \
|
||||
$(XMLTO_FO_STYLESHEET_FLAGS) \
|
||||
$(XMLTO_FO_IMAGEPATH_FLAGS) \
|
||||
$(XMLTO_PDF_OLINK_FLAGS)
|
||||
|
||||
shelf_DATA += $(docbook:.xml=.pdf)
|
||||
%.pdf: %.xml $(chapters)
|
||||
$(AM_V_GEN)$(XMLTO) $(XMLTO_FO_FLAGS) --with-fop pdf $<
|
||||
|
||||
shelf_DATA += $(docbook:.xml=.ps)
|
||||
%.ps: %.xml $(chapters)
|
||||
$(AM_V_GEN)$(XMLTO) $(XMLTO_FO_FLAGS) --with-fop ps $<
|
||||
endif HAVE_FOP
|
||||
|
||||
# Generate documents cross-reference target databases
|
||||
if HAVE_XSLTPROC
|
||||
|
||||
XSLT_SEARCHPATH_FLAGS = \
|
||||
--path "$(XORG_SGML_PATH)/X11" \
|
||||
--path "$(abs_top_builddir)"
|
||||
XSLT_OLINK_FLAGS = \
|
||||
--stringparam targets.filename "$@" \
|
||||
--stringparam collect.xref.targets "only" \
|
||||
--stringparam olink.base.uri "$(@:.db=)"
|
||||
|
||||
XSLT_HTML_FLAGS = \
|
||||
$(XSLT_SEARCHPATH_FLAGS) \
|
||||
$(XSLT_OLINK_FLAGS) \
|
||||
--nonet --xinclude \
|
||||
$(STYLESHEET_SRCDIR)/xorg-xhtml.xsl
|
||||
XSLT_PDF_FLAGS = \
|
||||
$(XSLT_SEARCHPATH_FLAGS) \
|
||||
$(XSLT_OLINK_FLAGS) \
|
||||
--nonet --xinclude \
|
||||
$(STYLESHEET_SRCDIR)/xorg-fo.xsl
|
||||
|
||||
shelf_DATA += $(docbook:.xml=.html.db)
|
||||
%.html.db: %.xml $(chapters)
|
||||
$(AM_V_GEN)$(XSLTPROC) $(XSLT_HTML_FLAGS) $<
|
||||
|
||||
shelf_DATA += $(docbook:.xml=.pdf.db)
|
||||
%.pdf.db: %.xml $(chapters)
|
||||
$(AM_V_GEN)$(XSLTPROC) $(XSLT_PDF_FLAGS) $<
|
||||
|
||||
endif HAVE_XSLTPROC
|
||||
endif HAVE_STYLESHEETS
|
||||
endif HAVE_XMLTO
|
||||
|
||||
CLEANFILES = $(shelf_DATA)
|
||||
@ -1,64 +1,13 @@
|
||||
#
|
||||
# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
|
||||
#
|
||||
# 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:
|
||||
#
|
||||
# The above copyright notice and this permission notice (including the next
|
||||
# paragraph) shall be included in all copies or substantial portions of the
|
||||
# Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", 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 AUTHORS OR COPYRIGHT HOLDERS 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.
|
||||
#
|
||||
|
||||
if ENABLE_SPECS
|
||||
doc_sources = bigreq.xml
|
||||
dist_doc_DATA = $(doc_sources)
|
||||
|
||||
if HAVE_XMLTO
|
||||
doc_DATA = $(doc_sources:.xml=.html)
|
||||
# Main DocBook/XML files (DOCTYPE book)
|
||||
docbook = bigreq.xml
|
||||
|
||||
if HAVE_FOP
|
||||
doc_DATA += $(doc_sources:.xml=.ps) $(doc_sources:.xml=.pdf)
|
||||
endif
|
||||
# The location where the DocBook/XML files and their generated formats are installed
|
||||
shelfdir = $(docdir)
|
||||
|
||||
if HAVE_XMLTO_TEXT
|
||||
doc_DATA += $(doc_sources:.xml=.txt)
|
||||
endif
|
||||
# Generate DocBook/XML output formats with or without stylesheets
|
||||
include $(top_srcdir)/docbook.am
|
||||
|
||||
if HAVE_STYLESHEETS
|
||||
XMLTO_FLAGS = -m $(XSL_STYLESHEET)
|
||||
|
||||
doc_DATA += xorg.css
|
||||
xorg.css: $(STYLESHEET_SRCDIR)/xorg.css
|
||||
$(AM_V_GEN)cp -pf $(STYLESHEET_SRCDIR)/xorg.css $@
|
||||
endif
|
||||
|
||||
CLEANFILES = $(doc_DATA)
|
||||
|
||||
SUFFIXES = .xml .ps .pdf .txt .html
|
||||
|
||||
.xml.txt:
|
||||
$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) txt $<
|
||||
|
||||
.xml.html:
|
||||
$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) xhtml-nochunks $<
|
||||
|
||||
.xml.pdf:
|
||||
$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop pdf $<
|
||||
|
||||
.xml.ps:
|
||||
$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop ps $<
|
||||
|
||||
endif HAVE_XMLTO
|
||||
endif ENABLE_SPECS
|
||||
|
||||
@ -1,25 +1,25 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
<!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;
|
||||
]>
|
||||
|
||||
<!-- lifted from troff+ms+XMan by doclifter -->
|
||||
<book id="bigreqms">
|
||||
<book id="bigreq">
|
||||
|
||||
<bookinfo>
|
||||
<title>Big Requests Extension</title>
|
||||
<subtitle>X Consortium Standard</subtitle>
|
||||
<releaseinfo>X Version 11, Release 6.4</releaseinfo>
|
||||
<releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo>
|
||||
<releaseinfo>Version 2.0</releaseinfo>
|
||||
<authorgroup>
|
||||
<author>
|
||||
<firstname>Bob</firstname><surname>Scheifler</surname>
|
||||
<affiliation><orgname>X Consortium</orgname></affiliation>
|
||||
</author>
|
||||
</authorgroup>
|
||||
<corpname>X Consortium Standard</corpname>
|
||||
<copyright><year>1993</year><year>1994</year>
|
||||
<holder>X Consortium</holder></copyright>
|
||||
<releaseinfo>Version 2.0</releaseinfo>
|
||||
<affiliation><orgname>X Consortium</orgname></affiliation>
|
||||
<productnumber>X Version 11, Release 7</productnumber>
|
||||
<copyright><year>1993</year><year>1994</year><holder>X Consortium</holder></copyright>
|
||||
|
||||
<legalnotice>
|
||||
<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>
|
||||
@ -35,7 +35,7 @@
|
||||
|
||||
</bookinfo>
|
||||
|
||||
<chapter id='overview'>
|
||||
<chapter id='Overview'>
|
||||
<title>Overview</title>
|
||||
|
||||
<para>This extension enables the use of protocol requests that exceed 262140 bytes in length.</para>
|
||||
@ -46,12 +46,13 @@
|
||||
|
||||
<para>For example, a normal <function>PolyLine</function> encoding is:</para>
|
||||
|
||||
<informaltable pgwide='0' frame='none'>
|
||||
<tgroup cols='4' align='left'>
|
||||
<colspec colwidth='0.5in' colname='c1'/>
|
||||
<colspec colwidth='1.5in' colname='c2'/>
|
||||
<colspec colwidth='1.5in' colname='c3'/>
|
||||
<colspec colwidth='2.0in' colname='c4'/>
|
||||
<informaltable id='PolyLine' frame='none'>
|
||||
<?dbfo keep-together="always" ?>
|
||||
<tgroup cols='4' align='left' colsep='0' rowsep='0'>
|
||||
<colspec colname='c1' colwidth='1.0*'/>
|
||||
<colspec colname='c2' colwidth='3.0*'/>
|
||||
<colspec colname='c3' colwidth='2.0*'/>
|
||||
<colspec colname='c4' colwidth='11.0*'/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry namest="c1" nameend="c4"><function>PolyLine</function></entry>
|
||||
@ -112,12 +113,13 @@
|
||||
|
||||
<para>An extended-length <function>PolyLine</function> encoding is:</para>
|
||||
|
||||
<informaltable pgwide='0' frame='none'>
|
||||
<tgroup cols='4' align='left'>
|
||||
<colspec colwidth='0.5in' colname='c1'/>
|
||||
<colspec colwidth='1.5in' colname='c2'/>
|
||||
<colspec colwidth='1.5in' colname='c3'/>
|
||||
<colspec colwidth='2.0in' colname='c4'/>
|
||||
<informaltable frame='none'>
|
||||
<?dbfo keep-together="always" ?>
|
||||
<tgroup cols='4' align='left' colsep='0' rowsep='0'>
|
||||
<colspec colname='c1' colwidth='1.0*'/>
|
||||
<colspec colname='c2' colwidth='3.0*'/>
|
||||
<colspec colname='c3' colwidth='2.0*'/>
|
||||
<colspec colname='c4' colwidth='11.0*'/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry namest="c1" nameend="c4"><function>PolyLine</function></entry>
|
||||
@ -185,7 +187,7 @@
|
||||
<para>Extended-length protocol encodings, once enabled, can be used on all protocol requests, including all extensions.</para>
|
||||
</chapter>
|
||||
|
||||
<chapter id='requests'>
|
||||
<chapter id='Requests'>
|
||||
<title>Requests</title>
|
||||
|
||||
<para><function>BigReqEnable</function></para>
|
||||
@ -197,24 +199,25 @@
|
||||
<para>This request enables extended-length protocol requests for the requesting client. It also returns the maximum length of a request, in 4-byte units, that can be used in extended-length protocol requests. This value will always be greater than the maximum-request-length returned in the connection setup information.</para>
|
||||
</chapter>
|
||||
|
||||
<chapter id='events_and_errors'>
|
||||
<chapter id='Events_and_Errors'>
|
||||
<title>Events and Errors</title>
|
||||
|
||||
<para>No new events or errors are defined by this extension.</para>
|
||||
</chapter>
|
||||
|
||||
<chapter id='encoding'>
|
||||
<chapter id='Encoding'>
|
||||
<title>Encoding</title>
|
||||
|
||||
<para>Please refer to the X11 Protocol Encoding document as this document uses conventions established there.</para>
|
||||
|
||||
<para>The name of this extension is “BIG-REQUESTS”.</para>
|
||||
|
||||
<informaltable pgwide='0' frame='none'>
|
||||
<tgroup cols='3' align='left'>
|
||||
<colspec colwidth='0.5in' colname='c1'/>
|
||||
<colspec colwidth='0.5in' colname='c2'/>
|
||||
<colspec colwidth='2.0in' colname='c3'/>
|
||||
<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='2.0*'/>
|
||||
<colspec colname='c3' colwidth='15.0*'/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry namest="c1" nameend="c3">BigReqEnable</entry>
|
||||
@ -238,10 +241,10 @@
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
<tgroup cols='3' align='left'>
|
||||
<colspec colwidth='0.5in' colname='c1'/>
|
||||
<colspec colwidth='1.5in' colname='c2'/>
|
||||
<colspec colwidth='2.0in' colname='c3'/>
|
||||
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
|
||||
<colspec colname='c1' colwidth='1.0*'/>
|
||||
<colspec colname='c2' colwidth='2.0*'/>
|
||||
<colspec colname='c3' colwidth='15.0*'/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry namest="c1" nameend="c3">=></entry>
|
||||
@ -284,16 +287,34 @@
|
||||
|
||||
</chapter>
|
||||
|
||||
<chapter id='c_language_binding'>
|
||||
<chapter id='C_Language_Binding'>
|
||||
<title>C language binding</title>
|
||||
|
||||
<para>It is desirable for core Xlib, and other extensions, to use this extension internally when necessary. It is also desirable to make the use of this extension as transparent as possible to the X client. For example, if enabling of the extension were delayed until the first time it was needed, an application that used <function>XNextRequest</function> to determine the sequence number of a request would no longer get the correct sequence number. As such, <function>XOpenDisplay</function> will determine if the extension is supported by the server and, if it is, enable extended-length encodings.</para>
|
||||
<para>It is desirable for core Xlib, and other extensions, to use this extension internally when necessary. It is also desirable to make the use of this extension as transparent as possible to the X client. For example, if enabling of the extension were delayed until the first time it was needed, an application that used
|
||||
<olink targetdoc='libX11' targetptr='XNextRequest'><function>XNextRequest</function></olink>
|
||||
to determine the sequence number of a request would no longer get the correct sequence number. As such,
|
||||
<olink targetdoc='libX11' targetptr='XOpenDisplay'><function>XOpenDisplay</function></olink>
|
||||
will determine if the extension is supported by the server and, if it is, enable extended-length encodings.</para>
|
||||
|
||||
<para>The core Xlib functions <function>XDrawLines</function>, <function>XDrawArcs</function>, <function>XFillPolygon</function>, <function>XChangeProperty</function>, <function>XSetClipRectangles</function>, and <function>XSetRegion</function> are required to use extended-length encodings when necessary, if supported by the server. Use of extended-length encodings in other core Xlib functions (<function>XDrawPoints</function>, <function>XDrawRectangles</function>, <function>XDrawSegments</function>. <function>XFillArcs</function>, <function>XFillRectangles</function>, <function>XPutImage</function> is permitted but not required; an Xlib implementation may choose to split the data across multiple smaller requests instead.</para>
|
||||
<para>The core Xlib functions
|
||||
<olink targetdoc='libX11' targetptr='XDrawLines'><function>XDrawLines</function></olink>,
|
||||
<olink targetdoc='libX11' targetptr='XDrawArcs'><function>XDrawArcs</function></olink>,
|
||||
<olink targetdoc='libX11' targetptr='XFillPolygon'><function>XFillPolygon</function></olink>,
|
||||
<olink targetdoc='libX11' targetptr='XChangeProperty'><function>XChangeProperty</function></olink>,
|
||||
<olink targetdoc='libX11' targetptr='XSetClipRectangles'><function>XSetClipRectangles</function></olink>, and
|
||||
<olink targetdoc='libX11' targetptr='XSetRegion'><function>XSetRegion</function></olink>.
|
||||
are required to use extended-length encodings when necessary, if supported by the server. Use of extended-length encodings in other core Xlib functions
|
||||
(<olink targetdoc='libX11' targetptr='XDrawPoints'><function>XDrawPoints</function></olink>,
|
||||
<olink targetdoc='libX11' targetptr='XDrawRectangles'><function>XDrawRectangles</function></olink>,
|
||||
<olink targetdoc='libX11' targetptr='XDrawSegments'><function>XDrawSegments</function></olink>.
|
||||
<olink targetdoc='libX11' targetptr='XFillArcs'><function>XFillArcs</function></olink>,
|
||||
<olink targetdoc='libX11' targetptr='XFillRectangles'><function>XFillRectangles</function></olink>,
|
||||
<olink targetdoc='libX11' targetptr='XPutImage'><function>XPutImage</function></olink>
|
||||
is permitted but not required; an Xlib implementation may choose to split the data across multiple smaller requests instead.</para>
|
||||
|
||||
<para>To permit clients to know what the maximum-request-length for extended-length encodings is, the following function is added to Xlib:
|
||||
|
||||
<funcsynopsis>
|
||||
<funcsynopsis id='XExtendedMaxRequestSize'>
|
||||
<funcprototype>
|
||||
<funcdef>long <function>XExtendedMaxRequestSize</function></funcdef>
|
||||
<paramdef>Display <parameter> *display</parameter></paramdef>
|
||||
@ -303,7 +324,7 @@
|
||||
Returns zero (0) if the specified display does not support this extension, otherwise returns the maximum-request-length (in 4-byte units) supported by the server through the extended-length encoding.</para>
|
||||
</chapter>
|
||||
|
||||
<chapter id='acknowledgements'>
|
||||
<chapter id='Acknowledgements'>
|
||||
<title>Acknowledgements</title>
|
||||
|
||||
<para>Clive Feather (IXI) originated the extended-length encoding used in this extension proposal.</para>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user