Update to recordproto 1.14.2. No functional change.
This commit is contained in:
matthieu
parent
a60b38a96d
commit
ca7e48cded
@ -1,3 +1,188 @@
|
||||
commit 32236c56b7015a98d845bb1836817328a307edce
|
||||
Author: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
Date: Thu Mar 22 20:46:36 2012 -0700
|
||||
|
||||
recordproto 1.14.2
|
||||
|
||||
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
|
||||
commit 10028272314500dd2e17e5ae7efa0a2d4d118c13
|
||||
Author: Matt Dew <marcoz@osource.org>
|
||||
Date: Fri Jan 13 23:20:09 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,
|
||||
IE, 1* -> 1.0* cleans up these build errors:
|
||||
WARNING: table-layout="fixed" and column-width unspecified
|
||||
=> falling back to proportional-column-width(1)
|
||||
|
||||
Signed-off-by: Matt Dew <marcoz@osource.org>
|
||||
|
||||
commit 5a7a2820665a495df32694d90b6f5192dd53547e
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Tue Sep 20 20:12:54 2011 -0400
|
||||
|
||||
specs: refactor copyright license text for multi licening
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit 233ed0eef7526ae02223359851be51e43240652b
|
||||
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 9ecf07de57da54009c5bb4567655996f69ba8deb
|
||||
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 c8d4e3eddc07889f0bc493884f120e741226c28b
|
||||
Author: Gaetan Nadon <memsize@videotron.ca>
|
||||
Date: Sun Sep 11 08:51:02 2011 -0400
|
||||
|
||||
specs: use more appropriate docbook element to get "Edited by"
|
||||
|
||||
The proper element to use is <editor>.
|
||||
The <contrib> was a hack to insert text and showed up in the wrong location
|
||||
|
||||
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
||||
|
||||
commit 1950143424ea47973613bc1dbec805e8a32aa97b
|
||||
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 d1011e878c92be804fe896f9adf2b686c01f2172
|
||||
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 cbba0d1e4665b585804b5de33c5ed1a4c3b19727
|
||||
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 b045d4c13967bd061f6a104136152e841bc432b5
|
||||
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 dcc64434a3e79931b05fc807906189dfa3a9ddd0
|
||||
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 f5813bffb2b642d8b515306caff555eac32b9b43
|
||||
Author: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
Date: Thu Dec 16 23:12:58 2010 -0800
|
||||
|
||||
specs/record.xml: Pair copyright notices with matching license notices
|
||||
|
||||
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
|
||||
commit 3011b8527ba7370e7e29758ecba0231e7e25bda8
|
||||
Author: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
Date: Thu Dec 16 23:10:06 2010 -0800
|
||||
|
||||
specs/record.xml: Fix section titles/nesting
|
||||
|
||||
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
|
||||
commit 2c1cabffad2903867fd352c19f0157d07adde232
|
||||
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 396cdde0242256976fbacec64839e48dfc56d639
|
||||
Author: Alan Coopersmith <alan.coopersmith@oracle.com>
|
||||
Date: Fri Oct 29 23:20:43 2010 -0700
|
||||
|
||||
@ -1,18 +1,19 @@
|
||||
AC_PREREQ([2.60])
|
||||
AC_INIT([RecordProto], [1.14.1],
|
||||
AC_INIT([RecordProto], [1.14.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 HAVE_STYLESHEETS in XORG_CHECK_SGML_DOCTOOLS
|
||||
# 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/recordproto/docbook.am
Normal file
105
proto/recordproto/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 = record.xml
|
||||
dist_doc_DATA = $(doc_sources)
|
||||
|
||||
if HAVE_XMLTO
|
||||
doc_DATA = $(doc_sources:.xml=.html)
|
||||
# Main DocBook/XML files (DOCTYPE book)
|
||||
docbook = record.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,6 +1,9 @@
|
||||
<?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">
|
||||
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
|
||||
[
|
||||
<!ENTITY % defs SYSTEM "defs.ent"> %defs;
|
||||
]>
|
||||
|
||||
|
||||
<!-- lifted from troff+ms+XMan by doclifter -->
|
||||
@ -14,19 +17,14 @@
|
||||
<firstname>Martha</firstname><surname>Zimet</surname>
|
||||
<affiliation><orgname>Network Computing Devices, Inc.</orgname></affiliation>
|
||||
</author>
|
||||
<othercredit>
|
||||
<contrib>edited by</contrib>
|
||||
<editor>
|
||||
<firstname>Stephen</firstname><surname>Gildea</surname>
|
||||
<affiliation><orgname>X Consortium</orgname></affiliation>
|
||||
</othercredit>
|
||||
</editor>
|
||||
</authorgroup>
|
||||
<corpname>X Consortium Standard</corpname>
|
||||
<copyright><year>1994</year><holder>Network Computing Devices, Inc.</holder></copyright>
|
||||
<copyright><year>1994</year><holder>X Consortium</holder></copyright>
|
||||
<copyright><year>1995</year><holder>X Consortium</holder></copyright>
|
||||
<affiliation><orgname>X Consortium</orgname></affiliation>
|
||||
<productnumber>Version 1.13</productnumber>
|
||||
<releaseinfo>X Version 11, Release 6.7</releaseinfo>
|
||||
<releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo>
|
||||
<copyright><year>1994</year><holder>Network Computing Devices, Inc.</holder>
|
||||
</copyright>
|
||||
|
||||
<legalnotice>
|
||||
<para>
|
||||
@ -36,8 +34,12 @@ 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.
|
||||
provided “as is” without express or implied warranty.
|
||||
</para>
|
||||
</legalnotice>
|
||||
|
||||
<legalnotice>
|
||||
<para role="multiLicensing">Copyright © 1994, 1995 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
|
||||
@ -54,7 +56,7 @@ in all copies or substantial portions of the Software.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
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 X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
||||
@ -69,12 +71,11 @@ 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>
|
||||
<para>X Window System is a trademark of The Open Group.</para>
|
||||
</legalnotice>
|
||||
</bookinfo>
|
||||
|
||||
<chapter>
|
||||
<title>TITLE</title>
|
||||
<sect1 id="Introduction">
|
||||
<chapter id="Introduction">
|
||||
<title>Introduction</title>
|
||||
<para>
|
||||
Several proposals have been written over the past few years that address some
|
||||
@ -168,7 +169,7 @@ changes, drawing of certain text strings, etc.) can capture the
|
||||
information it needs using RECORD facilities.
|
||||
</para>
|
||||
|
||||
<sect2 id="Acknowledgements">
|
||||
<sect1 id="Acknowledgements">
|
||||
<title>Acknowledgements</title>
|
||||
<para>
|
||||
The document represents the culmination of two years of debate and
|
||||
@ -189,9 +190,9 @@ clarification of the recorded event policy, and Kent Siefkes of
|
||||
Performance Awareness has assisted in clarification of the timestamp
|
||||
policy.
|
||||
</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect2 id="Goals">
|
||||
<sect1 id="Goals">
|
||||
<title>Goals</title>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
@ -216,9 +217,9 @@ To provide the ability to record arbitrary X protocol extensions.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect2 id="Requirements">
|
||||
<sect1 id="Requirements">
|
||||
<title>Requirements</title>
|
||||
<para>
|
||||
The extension should function as follows:
|
||||
@ -256,17 +257,17 @@ support the recording of synchronization information for user events.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
||||
<sect1 id="Design">
|
||||
<chapter id="Design">
|
||||
<title>Design</title>
|
||||
<para>
|
||||
This section gives an overview of the RECORD extension and discusses
|
||||
its overall operation and data types.
|
||||
</para>
|
||||
|
||||
<sect2 id="Overview">
|
||||
<sect1 id="Overview">
|
||||
<title>Overview</title>
|
||||
<para>
|
||||
The mechanism used by this extension for recording is to intercept
|
||||
@ -287,7 +288,7 @@ In addition, the
|
||||
extension does not provide data compression before intercepted protocol
|
||||
is returned to the recording clients.
|
||||
</para>
|
||||
<sect3 id="Data_Delivery">
|
||||
<sect2 id="Data_Delivery">
|
||||
<title>Data Delivery</title>
|
||||
<!-- .XS -->
|
||||
<!-- (SN Data Delivery -->
|
||||
@ -314,8 +315,8 @@ might be collected
|
||||
into a single reply.
|
||||
Nevertheless, all data are returned to the client in a timely manner.
|
||||
</para>
|
||||
</sect3>
|
||||
<sect3 id="Record_Context">
|
||||
</sect2>
|
||||
<sect2 id="Record_Context">
|
||||
<title>Record Context</title>
|
||||
<!-- .XS -->
|
||||
<!-- (SN Record Context -->
|
||||
@ -342,9 +343,9 @@ it is required to do so immediately. That is, it is not permissible for
|
||||
the server to wait until recording is enabled to register clients
|
||||
or recording is disabled to unregister clients.
|
||||
</para>
|
||||
</sect3>
|
||||
</sect2>
|
||||
|
||||
<sect3 id="Record_Client_Connections">
|
||||
<sect2 id="Record_Client_Connections">
|
||||
<title>Record Client Connections</title>
|
||||
<!-- .XS -->
|
||||
<!-- (SN Record Client Connections -->
|
||||
@ -374,8 +375,8 @@ to the "enable" request is sent by the server. Therefore, unless a
|
||||
recording client never has the need to disable the interception and reporting
|
||||
of protocol data, two client connections are necessary.
|
||||
</para>
|
||||
</sect3>
|
||||
<sect3 id="Events">
|
||||
</sect2>
|
||||
<sect2 id="Events">
|
||||
<title>Events</title>
|
||||
<!-- .XS -->
|
||||
<!-- (SN Events -->
|
||||
@ -429,9 +430,9 @@ and
|
||||
<function>KeyRelease</function>
|
||||
device events are reported.
|
||||
</para>
|
||||
</sect3>
|
||||
</sect2>
|
||||
|
||||
<sect3 id="Timing">
|
||||
<sect2 id="Timing">
|
||||
<title>Timing</title>
|
||||
<!-- .XS -->
|
||||
<!-- (SN Timing -->
|
||||
@ -441,10 +442,10 @@ Requests are recorded just before
|
||||
they are executed; the time associated with a request is the server
|
||||
time when it is recorded.
|
||||
</para>
|
||||
</sect3>
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect2 id="Types">
|
||||
<sect1 id="Types">
|
||||
<title>Types</title>
|
||||
<para>
|
||||
The following new types are used in the request definitions that appear
|
||||
@ -460,27 +461,28 @@ type is a resource identifier for a server record context.
|
||||
</para>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols='3' align='left'>
|
||||
<colspec colname='c1' colsep="0" colwidth="1*"/>
|
||||
<colspec colname='c2' colsep="0" colwidth="1*"/>
|
||||
<colspec colname='c3' colsep="0" colwidth="1*"/>
|
||||
<?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="4.0*"/>
|
||||
<tbody>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>RANGE8:</entry>
|
||||
<entry>[first, last:</entry>
|
||||
<entry>CARD8]</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>RANGE16:</entry>
|
||||
<entry>[first, last:</entry>
|
||||
<entry>CARD16]</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>EXTRANGE:</entry>
|
||||
<entry>[major:</entry>
|
||||
<entry>RANGE8</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>minor:</entry>
|
||||
<entry>RANGE16]</entry>
|
||||
@ -490,52 +492,53 @@ type is a resource identifier for a server record context.
|
||||
</informaltable>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols='3' align='left'>
|
||||
<colspec colname='c1' colsep="0" colwidth="1*"/>
|
||||
<colspec colname='c2' colsep="0" colwidth="1*"/>
|
||||
<colspec colname='c3' colsep="0" colwidth="1*"/>
|
||||
<?dbfo keep-together="always" ?>
|
||||
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
|
||||
<colspec colname='c1' colwidth="1.5*"/>
|
||||
<colspec colname='c2' colwidth="1.0*"/>
|
||||
<colspec colname='c3' colwidth="4.0*"/>
|
||||
<tbody>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>RECORDRANGE:</entry>
|
||||
<entry>[core-requests:</entry>
|
||||
<entry>RANGE8</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>core-replies:</entry>
|
||||
<entry>RANGE8</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>ext-requests:</entry>
|
||||
<entry>EXTRANGE</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>ext-replies:</entry>
|
||||
<entry>EXTRANGE</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>delivered-events:</entry>
|
||||
<entry>RANGE8</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>device-events:</entry>
|
||||
<entry>RANGE8</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>errors:</entry>
|
||||
<entry>RANGE8</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>client-started:</entry>
|
||||
<entry>BOOL</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>client-died:</entry>
|
||||
<entry>BOOL]</entry>
|
||||
@ -691,22 +694,23 @@ this RECORDRANGE.
|
||||
</itemizedlist>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols='3' align='left'>
|
||||
<colspec colname='c1' colsep="0" colwidth="1*"/>
|
||||
<colspec colname='c2' colsep="0" colwidth="1*"/>
|
||||
<colspec colname='c3' colsep="0" colwidth="1*"/>
|
||||
<?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="2.0*"/>
|
||||
<tbody>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>ELEMENT_HEADER:</entry>
|
||||
<entry>[from-server-time:</entry>
|
||||
<entry>BOOL</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>from-client-time:</entry>
|
||||
<entry>BOOL</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>from-client-sequence:</entry>
|
||||
<entry>BOOL]</entry>
|
||||
@ -843,17 +847,18 @@ It is an error to explicitly register the data connection.
|
||||
</para>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols='3' align='left'>
|
||||
<colspec colname='c1' colsep="0" colwidth="1*"/>
|
||||
<colspec colname='c2' colsep="0" colwidth="1*"/>
|
||||
<colspec colname='c3' colsep="0" colwidth="1*"/>
|
||||
<?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="3.0*"/>
|
||||
<tbody>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>CLIENT_INFO:</entry>
|
||||
<entry>[client-resource:</entry>
|
||||
<entry>CLIENTSPEC</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry>intercepted-protocol:</entry>
|
||||
<entry>LISTofRECORDRANGE]</entry>
|
||||
@ -869,9 +874,9 @@ resource base that identifies the intercepted client. The
|
||||
<emphasis remap='I'>intercepted-protocol</emphasis> field specifies the protocol to intercept
|
||||
for the <emphasis remap='I'>client-resource</emphasis>.
|
||||
</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect2 id="Errors">
|
||||
<sect1 id="Errors">
|
||||
<title>Errors</title>
|
||||
<para>
|
||||
<emphasis role="bold">RecordContext</emphasis>
|
||||
@ -887,10 +892,10 @@ in a request does not name a defined record context.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
||||
<sect1 id="Protocol_Requests">
|
||||
<chapter id="Protocol_Requests">
|
||||
<title>Protocol Requests</title>
|
||||
<!-- .XS -->
|
||||
<!-- (SN Protocol Requests -->
|
||||
@ -945,30 +950,31 @@ minor version thirteen (13).
|
||||
</para>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols='1' align='left'>
|
||||
<colspec colname='c1' colsep="0" colwidth="1*"/>
|
||||
<?dbfo keep-together="always" ?>
|
||||
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
|
||||
<colspec colname='c1' colwidth="1.0*"/>
|
||||
<tbody>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>context</emphasis>: RC
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>element-header</emphasis>: ELEMENT_HEADER
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>client-specifiers</emphasis>: LISTofCLIENTSPEC
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>ranges</emphasis>: LISTofRECORDRANGE
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
Errors:
|
||||
<function>Match ,</function>
|
||||
@ -1063,30 +1069,31 @@ resources.
|
||||
</para>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols='1' align='left'>
|
||||
<colspec colname='c1' colsep="0" colwidth="1*"/>
|
||||
<?dbfo keep-together="always" ?>
|
||||
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
|
||||
<colspec colname='c1' colwidth="1.0*"/>
|
||||
<tbody>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>context</emphasis>: RC
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>element-header</emphasis>: ELEMENT_HEADER
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>client-specifiers</emphasis>: LISTofCLIENTSPEC
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>ranges</emphasis>: LISTofRECORDRANGE
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
Errors:
|
||||
<function>Match ,</function>
|
||||
@ -1189,20 +1196,21 @@ resources.
|
||||
</para>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols='1' align='left'>
|
||||
<colspec colname='c1' colsep="0" colwidth="1*"/>
|
||||
<?dbfo keep-together="always" ?>
|
||||
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
|
||||
<colspec colname='c1' colwidth="1.0*"/>
|
||||
<tbody>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>context</emphasis>: RC
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>client-specifiers</emphasis>: LISTofCLIENTSPEC
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
Errors:
|
||||
<function>Match ,</function>
|
||||
@ -1282,40 +1290,41 @@ A client is unregistered automatically when it disconnects.
|
||||
</para>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols='1' align='left'>
|
||||
<colspec colname='c1' colsep="0" colwidth="1*"/>
|
||||
<?dbfo keep-together="always" ?>
|
||||
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
|
||||
<colspec colname='c1' colwidth="1.0*"/>
|
||||
<tbody>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>context</emphasis>: RC
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
->
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>enabled</emphasis>: BOOL
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>element-header</emphasis>: ELEMENT_HEADER
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>intercepted-clients</emphasis>: LISTofCLIENT_INFO
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
Errors:
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<function>RecordContext</function>
|
||||
</entry>
|
||||
@ -1365,20 +1374,20 @@ error results.
|
||||
</para>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols='1' align='left'>
|
||||
<colspec colname='c1' colsep="0" colwidth="1*"/>
|
||||
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
|
||||
<colspec colname='c1' colwidth="1.0*"/>
|
||||
<tbody>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>context</emphasis>: RC
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
->+
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>category</emphasis>:
|
||||
{<function>FromServer</function>, <function>FromClient</function>,
|
||||
@ -1388,37 +1397,37 @@ error results.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>element-header</emphasis>: ELEMENT_HEADER
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>client-swapped</emphasis>: BOOL
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>id-base</emphasis>: XIDBASE
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>server-time</emphasis>: TIMESTAMP
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>recorded-sequence-number</emphasis>: CARD32
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>data</emphasis>: LISTofBYTE
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
Errors:
|
||||
<function>Match</function>,
|
||||
@ -1599,15 +1608,16 @@ error results.
|
||||
</para>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols='1' align='left'>
|
||||
<colspec colname='c1' colsep="0" colwidth="1*"/>
|
||||
<?dbfo keep-together="always" ?>
|
||||
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
|
||||
<colspec colname='c1' colwidth="1.0*"/>
|
||||
<tbody>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
<emphasis remap='I'>context</emphasis>: RC
|
||||
</entry>
|
||||
</row>
|
||||
<row rowsep="0">
|
||||
<row>
|
||||
<entry>
|
||||
Errors:
|
||||
<function>RecordContext</function>
|
||||
@ -1678,9 +1688,9 @@ is closed down and the close-down mode is <function>DestroyAll</function>. When
|
||||
<function>RecordContext</function>
|
||||
error results.
|
||||
</para>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
||||
<sect1 id="Encoding">
|
||||
<chapter id="Encoding">
|
||||
<title>Encoding</title>
|
||||
<para>
|
||||
Please refer to the X11 Protocol Encoding document as this document uses
|
||||
@ -1691,7 +1701,7 @@ conventions established there.
|
||||
The name of this extension is "RECORD".
|
||||
</para>
|
||||
|
||||
<sect2 id="Types_2">
|
||||
<sect1 id="Types_2">
|
||||
<title>Types</title>
|
||||
<para>
|
||||
RC: CARD32
|
||||
@ -1756,8 +1766,8 @@ CLIENT_INFO
|
||||
24n LISTofRECORDRANGE intercepted-protocol
|
||||
</literallayout>
|
||||
|
||||
</sect2>
|
||||
<sect2 id="Errors_2">
|
||||
</sect1>
|
||||
<sect1 id="Errors_2">
|
||||
<title>Errors</title>
|
||||
|
||||
<literallayout class="monospaced">
|
||||
@ -1768,9 +1778,9 @@ CLIENT_INFO
|
||||
4 CARD32 invalid record context
|
||||
24 unused
|
||||
</literallayout>
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect2 id="Requests">
|
||||
<sect1 id="Requests">
|
||||
<title>Requests</title>
|
||||
|
||||
<literallayout class="monospaced">
|
||||
@ -1889,7 +1899,6 @@ CLIENT_INFO
|
||||
4 RC context
|
||||
</literallayout>
|
||||
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
||||
</book>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user