diff options
Diffstat (limited to 'proto/scrnsaverproto')
| -rw-r--r-- | proto/scrnsaverproto/ChangeLog | 194 | ||||
| -rw-r--r-- | proto/scrnsaverproto/configure.ac | 13 | ||||
| -rw-r--r-- | proto/scrnsaverproto/docbook.am | 105 | ||||
| -rw-r--r-- | proto/scrnsaverproto/specs/Makefile.am | 63 | ||||
| -rw-r--r-- | proto/scrnsaverproto/specs/saver.xml | 162 |
5 files changed, 397 insertions, 140 deletions
diff --git a/proto/scrnsaverproto/ChangeLog b/proto/scrnsaverproto/ChangeLog index d77c417e3..5b3a31a3a 100644 --- a/proto/scrnsaverproto/ChangeLog +++ b/proto/scrnsaverproto/ChangeLog @@ -1,3 +1,197 @@ +commit c33f4368e85d976b112dda4a34ca254944cb354d +Author: Alan Coopersmith <alan.coopersmith@oracle.com> +Date: Thu Mar 22 20:49:20 2012 -0700 + + scrnsaverproto 1.2.2 + +commit 27cf3d03cdd502c1228e59ba560eab77d8393405 +Author: Matt Dew <marcoz@osource.org> +Date: Sat Jan 14 22:21:00 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 ffbc319b69b1e3502a9b14195e7fa94f2beee3b6 +Author: Matt Dew <marcoz@osource.org> +Date: Sat Sep 24 20:07:44 2011 -0600 + + Fix id attributes, linkend and olinks + + #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 if external, xref if internal. + + Reviewed-by: Gaetan Nadon <memsize@videotron.ca> + +commit 4aa72b32c7707bd78fc8dd8e287e3030eeb85d05 +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Tue Sep 20 20:17:40 2011 -0400 + + specs: fix markup for single license dual holder + + Signed-off-by: Gaetan Nadon <memsize@videotron.ca> + +commit d9c42cb0ba35e1c5e5a36a8cbde81eb311350931 +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Mon Sep 12 11:04:11 2011 -0400 + + docs: use the &fullrelvers; entity to set X11 release information + + Signed-off-by: Gaetan Nadon <memsize@videotron.ca> + +commit 378e4e73352a6bc11589460fdb4e6ceead2e82dc +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 feaac4aaccb25d79d29a6020e75fca5a9938bf8a +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 25764e51ecdea56df02063ae3b9d625d41a1209d +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 e80d85902dcd19edd9bdb5f574ca47d0811ac0aa +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 8f407c9417ffe2c1e01b37e18c71469d2baee970 +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 2408165cb190a10e2d899bdc259866cbf7a8e125 +Author: Matt Dew <marcoz@osource.org> +Date: Wed May 25 22:04:10 2011 -0600 + + add id attributes to funcsynopsis to allow other docs to olink to them. + + Signed-off-by: Matt Dew <marcoz@osource.org> + Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com> + Reviewed-by: Gaetan Nadon <memsize@videotron.ca> + +commit 2cd4a9898644dde49a876eeb53037149c85a37f0 +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 9d7dc8242feae5690e7aef48a386555c04183e9f +Author: Alan Coopersmith <alan.coopersmith@oracle.com> +Date: Thu Dec 16 23:16:54 2010 -0800 + + specs: change othercredit tags to author tags + + Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> + +commit d50038590f72f02bc95712d8a4c37654f6d05a64 +Author: Alan Coopersmith <alan.coopersmith@oracle.com> +Date: Thu Dec 16 23:15:19 2010 -0800 + + spec: Fix section titles/nesting + + Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> + +commit f85ed94ac012675dff25afbd3161dbbd3f62882b +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 b4899c5d6090efdf292f5686cc23ed90e3729e4b Author: Alan Coopersmith <alan.coopersmith@oracle.com> Date: Fri Oct 29 23:27:16 2010 -0700 diff --git a/proto/scrnsaverproto/configure.ac b/proto/scrnsaverproto/configure.ac index 993821647..6a7098946 100644 --- a/proto/scrnsaverproto/configure.ac +++ b/proto/scrnsaverproto/configure.ac @@ -1,18 +1,19 @@ AC_PREREQ([2.60]) -AC_INIT([ScrnSaverProto], [1.2.1], +AC_INIT([ScrnSaverProto], [1.2.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 diff --git a/proto/scrnsaverproto/docbook.am b/proto/scrnsaverproto/docbook.am new file mode 100644 index 000000000..bba4d5453 --- /dev/null +++ b/proto/scrnsaverproto/docbook.am @@ -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) diff --git a/proto/scrnsaverproto/specs/Makefile.am b/proto/scrnsaverproto/specs/Makefile.am index a312ac94d..f93e295a8 100644 --- a/proto/scrnsaverproto/specs/Makefile.am +++ b/proto/scrnsaverproto/specs/Makefile.am @@ -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 = saver.xml -dist_doc_DATA = $(doc_sources) -if HAVE_XMLTO -doc_DATA = $(doc_sources:.xml=.html) +# Main DocBook/XML files (DOCTYPE book) +docbook = saver.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 diff --git a/proto/scrnsaverproto/specs/saver.xml b/proto/scrnsaverproto/specs/saver.xml index 93b52290d..237421823 100644 --- a/proto/scrnsaverproto/specs/saver.xml +++ b/proto/scrnsaverproto/specs/saver.xml @@ -1,29 +1,35 @@ <?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; +]> <book id="saver"> <bookinfo> <title>X11 Screen Saver Extension</title> <subtitle>MIT X Consortium Proposed Standard</subtitle> + <releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo> <releaseinfo>Version 1.0</releaseinfo> <authorgroup> - <othercredit> + <author> <firstname>Jim</firstname><surname>Fulton</surname> <affiliation><orgname>Network Computing Devices, Inc</orgname></affiliation> - </othercredit> - <othercredit> + </author> + <author> <firstname>Keith</firstname><surname>Packard</surname> <affiliation><orgname> X Consortium, Laboratory for Computer Science, Massachusetts Institute of Technology </orgname></affiliation> - </othercredit> + </author> </authorgroup> - <copyright><year>1992</year><holder>Massachusetts Institute of Technology and Network Computing Devices, Inc</holder></copyright> + <copyright><year>1992</year> + <holder>Massachusetts Institute of Technology</holder> + <holder>Network Computing Devices, Inc</holder> + </copyright> - <productnumber>X Version 11, Release 5</productnumber> <legalnotice> <para> @@ -39,9 +45,7 @@ implied warranty. </legalnotice> </bookinfo> -<chapter id="title"> -<title>TITLE</title> -<sect1 id="Introduction_"> +<chapter id='Introduction'> <title>Introduction</title> <para> The X Window System provides support for changing the image on a display screen @@ -61,9 +65,9 @@ particular, such users often wish to be able to display corporate logos, instructions on how to reactivate the screen, and automatic screen-locking utilities. This extension provides a means for writing such clients. </para> -</sect1> +</chapter> -<sect1 id="Assumptions"> +<chapter id="Assumptions"> <title>Assumptions</title> <para> This extension exports the notion of a special screen saver window that is @@ -73,9 +77,9 @@ the window manager. Furthermore, the X identifier for the window is never returned by <function>QueryTree</function> requests on the root window, so it is typically not visible to other clients. </para> -</sect1> +</chapter> -<sect1 id="Overview"> +<chapter id="Overview"> <title>Overview</title> <para> The core @@ -106,9 +110,9 @@ id for the screen saver window and setting the attributes (e.g. size, location, visual, colormap) to be used when the window is mapped. These requirements form the basis of this extension. </para> -</sect1> +</chapter> -<sect1 id="Issues"> +<chapter id="Issues"> <title>Issues</title> <para> This extension raises several interesting issues. First is the question of @@ -130,33 +134,34 @@ it is not mapped so that it need not be avoided during event delivery. Thus, screen saver clients may find that the requests that reference the screen saver window may fail when the window is not displayed. </para> -</sect1> +</chapter> -<sect1 id="Protocol"> +<chapter id="Protocol"> <title>Protocol</title> <para> The Screen Saver extension is as follows: </para> -<sect2 id="Types"> +<sect1 id="Types"> <title>Types</title> <para> In adition to the comon types described in the core protocol, the following type is used in the request and event definitions in subsequent sections. </para> -<informaltable frame="none"> - <tgroup cols='2' align='left'> - <colspec colname='c1' colsep="0"/> - <colspec colname='c2' colsep="0"/> +<informaltable frame="topbot"> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth="1.0*"/> + <colspec colname='c2' colwidth="1.5*"/> <thead> - <row> + <row rowsep='1'> <entry>Name</entry> <entry>Value</entry> </row> </thead> <tbody> - <row rowsep="0"> + <row> <entry>SCREENSAVEREVENT</entry> <entry><emphasis role="bold">ScreenSaverNotify</emphasis>, <emphasis role="bold">ScreenSaverCycle</emphasis></entry> @@ -164,16 +169,16 @@ type is used in the request and event definitions in subsequent sections. </tbody> </tgroup> </informaltable> -</sect2> +</sect1> -<sect2 id="Errors"> +<sect1 id="Errors"> <title>Errors</title> <para> The Screen Saver extension adds no errors beyond the core protocol. </para> -</sect2> +</sect1> -<sect2 id="Requests"> +<sect1 id="Requests"> <title>Requests</title> <para> The Screen Saver extension adds the following requests: @@ -232,11 +237,12 @@ active and how the <emphasis remap='I'>til-or-since</emphasis> value should be i </para> <informaltable frame="none"> - <tgroup cols='2' align='left'> - <colspec colname='c1' colsep="0"/> - <colspec colname='c2' colsep="0"/> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth="1.0*"/> + <colspec colname='c2' colwidth="5.0*"/> <tbody> - <row rowsep="0"> + <row> <entry><emphasis role="bold">Off</emphasis></entry> <entry> The screen is not currently being saved; @@ -245,7 +251,7 @@ specifies the number of milliseconds until the screen saver is expected to activate. </entry> </row> - <row rowsep="0"> + <row> <entry><emphasis role="bold">On</emphasis></entry> <entry> The screen is currently being saved; @@ -253,7 +259,7 @@ The screen is currently being saved; the number of milliseconds since the screen saver activated. </entry> </row> - <row rowsep="0"> + <row> <entry><emphasis role="bold">Disabled</emphasis></entry> <entry> The screen saver is currently disabled; @@ -270,21 +276,22 @@ used or would have been were the screen being saved: </para> <informaltable frame="none"> - <tgroup cols='2' align='left'> - <colspec colname='c1' colsep="0"/> - <colspec colname='c2' colsep="0"/> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth="1.0*"/> + <colspec colname='c2' colwidth="5.0*"/> <tbody> - <row rowsep="0"> + <row> <entry><emphasis role="bold">Blanked</emphasis></entry> <entry>The video signal to the display monitor was disabled.</entry> </row> - <row rowsep="0"> + <row> <entry><emphasis role="bold">Internal</emphasis></entry> <entry>A server-dependent, built-in screen saver image was displayed; either no client had set the screen saver window attributes or a different client had the server grabbed when the screen saver activated.</entry> </row> - <row rowsep="0"> + <row> <entry><emphasis role="bold">External</emphasis></entry> <entry>The screen saver window was mapped with attributes set by a client using the <function>ScreenSaverSetAttributes</function> request.</entry> @@ -328,18 +335,19 @@ Otherwise, any combination of the following bits may be set: </para> <informaltable frame="none"> - <tgroup cols='2' align='center'> - <colspec colname='c1' colsep="0"/> - <colspec colname='c2' colsep="0"/> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth="1.0*"/> + <colspec colname='c2' colwidth="3.0*"/> <tbody> - <row rowsep="0"> + <row> <entry><emphasis role="bold">ScreenSaverNotify</emphasis></entry> <entry> If this bit is set, <emphasis role="bold">ScreenSaverNotify</emphasis> events are generated whenever the screen saver is activated or deactivated. </entry> </row> - <row rowsep="0"> + <row> <entry><emphasis role="bold">ScreenSaverCycle</emphasis></entry> <entry> If this bit is set, <emphasis role="bold">ScreenSaverNotify</emphasis> events are generated whenever @@ -464,9 +472,9 @@ deactivation. This request is ignored if the client has not previously set the screen saver window attributes. </para> -</sect2> +</sect1> -<sect2 id="Events_"> +<sect1 id="Events"> <title>Events</title> <para> The Screen Saver extension adds one event: @@ -500,25 +508,26 @@ The <emphasis remap='I'>state</emphasis> field specifies the cause of the event: </para> <informaltable frame="none"> - <tgroup cols='2' align='left'> - <colspec colname='c1' colsep="0"/> - <colspec colname='c2' colsep="0"/> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth="1.0*"/> + <colspec colname='c2' colwidth="5.0*"/> <tbody> - <row rowsep="0"> + <row> <entry><emphasis role="bold">Off</emphasis></entry> <entry> The screen saver deactivated; this event is sent if the client has set the ScreenSaverNotify bit in its event mask. </entry> </row> - <row rowsep="0"> + <row> <entry><emphasis role="bold">On</emphasis></entry> <entry> The screen saver activated. This event is sent if the client has set the ScreenSaverNotify bit in its event mask. </entry> </row> - <row rowsep="0"> + <row> <entry><emphasis role="bold">Cycle</emphasis></entry> <entry> The cycle interval passed and the client is expected to change the image on @@ -550,10 +559,10 @@ when the screen saver was activated, as described in The <emphasis remap='I'>time</emphasis> field indicates the server time when the event was generated. </para> -</sect2> </sect1> +</chapter> -<sect1 id="Encoding"> +<chapter id="Encoding"> <title>Encoding</title> <para> Please refer to the X11 Protocol Encoding document as this document uses @@ -563,16 +572,16 @@ conventions established there. The name of this extension is "SCREEN-SAVER". </para> -<sect2 id="Common_Types"> +<sect1 id="Common_Types"> <title>Common Types</title> <literallayout class="monospaced"> SETofSCREENSAVEREVENT #x00000001 ScreenSaverNotifyMask #x00000002 ScreenSaverCycleMask </literallayout> -</sect2> +</sect1> -<sect2 id="Requests_2"> +<sect1 id="Requests_2"> <title>Requests</title> <literallayout class="monospaced"> <emphasis role="bold">ScreenSaverQueryVersion</emphasis> @@ -649,9 +658,9 @@ SETofSCREENSAVEREVENT 2 3 request length 4 DRAWABLE drawable associated with screen </literallayout> -</sect2> +</sect1> -<sect2 id="Events"> +<sect1 id="Events_2"> <title>Events</title> <literallayout class="monospaced"> @@ -672,10 +681,10 @@ SETofSCREENSAVEREVENT 1 BOOL forced 14 unused </literallayout> -</sect2> </sect1> +</chapter> -<sect1 id="Inter_Client_Communications_Conventions_"> +<chapter id='Inter_Client_Communications_Conventions'> <title>Inter-Client Communications Conventions</title> <para> Screen saver clients should create at least one resource value whose @@ -691,9 +700,9 @@ resource and should be one of the following: <emphasis role="bold">FONT</emphasis>, or <emphasis role="bold">COLORMAP</emphasis>. </para> -</sect1> +</chapter> -<sect1 id="C_language_binding"> +<chapter id="C_language_binding"> <title>C language binding</title> <para> @@ -707,7 +716,7 @@ The include file for this extension is </para> -<funcsynopsis> +<funcsynopsis id='XScreenSaverQueryExtension'> <funcprototype> <funcdef>Bool <function>XScreenSaverQueryExtension</function></funcdef> <paramdef>Display <parameter>*display</parameter></paramdef> @@ -730,7 +739,7 @@ no additional errors are defined by this extension, the results of <emphasis remap='I'>error_base</emphasis> are not defined. </para> -<funcsynopsis> +<funcsynopsis id='XScreenSaverQueryVersion'> <funcprototype> <funcdef>Status <function>XScreenSaverQueryVersion</function></funcdef> <paramdef>Display <parameter>*display</parameter></paramdef> @@ -755,14 +764,14 @@ set and 0 is returned. <para> This routine allocates and returns an <emphasis role="bold">XScreenSaverInfo</emphasis> structure -for use in calls to <function>XScreenSaverQueryInfo</function>. +for use in calls to <xref linkend='XScreenSaverQueryInfo' xrefstyle='select: title'/>. All fields in the structure are initialized to zero. If insufficient memory is available, NULL is returned. The results of this routine can be released -using <emphasis remap='I'>XFree</emphasis>. +using <olink targetdoc='libX11' targetptr='XFree'><function>XFree</function></olink>. </para> -<funcsynopsis> +<funcsynopsis id='XScreenSaverQueryInfo'> <funcprototype> <funcdef>Status <function>XScreenSaverQueryInfo</function></funcdef> <paramdef>Display <parameter>*display</parameter></paramdef> @@ -797,7 +806,7 @@ description of the fields. If the extension is not supported, is returned. </para> -<funcsynopsis> +<funcsynopsis id='XScreenSaverSelectInput'> <funcprototype> <funcdef>void <function>XScreenSaverSelectInput</function></funcdef> <paramdef>Display <parameter>*display</parameter></paramdef> @@ -834,7 +843,7 @@ See the definition of the of the allowed event masks. <!-- xref ? --> </para> -<funcsynopsis> +<funcsynopsis id='XScreenSaverSetAttributes'> <funcprototype> <funcdef>void <function>XScreenSaverSetAttributes</function></funcdef> <paramdef>Display <parameter>*dpy</parameter></paramdef> @@ -860,7 +869,7 @@ of the <function>ScreenSaverSetAttributes</function> request for a description of each of the arguments. </para> -<funcsynopsis> +<funcsynopsis id='XScreenSaverUnsetAttributes'> <funcprototype> <funcdef>void <function>XScreenSaverUnsetAttributes</function></funcdef> <paramdef>Display <parameter>*display</parameter></paramdef> @@ -874,7 +883,7 @@ extension, this routine instructs the server to discard any previous screen saver window attributes set by this client. </para> -<funcsynopsis> +<funcsynopsis id='XScreenSaverRegister'> <funcprototype> <funcdef>Status <function>XScreenSaverRegister</function></funcdef> <paramdef>Display <parameter>*display</parameter></paramdef> @@ -893,7 +902,7 @@ is encountered and the property is not changed, otherwise it returns non-zero. </para> -<funcsynopsis> +<funcsynopsis id='XScreenSaverUnregister'> <funcprototype> <funcdef>Status <function>XScreenSaverUnregister</function></funcdef> <paramdef>Display <parameter>*display</parameter></paramdef> @@ -908,7 +917,7 @@ It returns zero if an error is encountered and the property is changed, otherwise it returns non-zero. </para> -<funcsynopsis> +<funcsynopsis id='XScreenSaverGetRegistered'> <funcprototype> <funcdef>Status <function>XScreenSaverGetRegistered</function></funcdef> <paramdef>Display <parameter>*display</parameter></paramdef> @@ -930,6 +939,5 @@ is encountered or if the property does not exist or is not of the correct format; otherwise it returns non-zero. </para> -</sect1> </chapter> </book> |