Update the package version number to 1.1. Require scrnsaverproto >= 1.1.libXScrnSaver-1_1_0XORG-7_1XORG-7_0_99_901

Update the manpage to document the new XScreenSaverSuspend function.
Add the implementation of XScreenSaverSuspend.

2 files changed, 43 insertions, 4 deletions

diff --git a/man/Makefile.am b/man/Makefile.am
index e7ea480..2448746 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -68,7 +68,8 @@ Xss_shadows = 				\
 	XScreenSaverUnsetAttributes	\
 	XScreenSaverRegister		\
 	XScreenSaverUnregister		\
-	XScreenSaverGetRegistered
+	XScreenSaverGetRegistered	\
+	XScreenSaverSuspend
 
 shadows.DONE:
 	-rm -f $(Xss_shadows:=.@LIB_MAN_SUFFIX@)
diff --git a/man/Xss.man b/man/Xss.man
index 95fcb63..0a46fad 100644
--- a/man/Xss.man
+++ b/man/Xss.man
@@ -1,6 +1,6 @@
 .\"
 .\" $XFree86: xc/lib/Xss/Xss.man,v 1.1 2003/10/26 19:00:24 herrb Exp $
-.\" $XdotOrg$
+.\" $XdotOrg: lib/XScrnSaver/man/Xss.man,v 1.2 2004/04/23 18:43:51 eich Exp $
 .\"
 .\" Copyright (C) 2003 The XFree86 Project, Inc.  All Rights Reserved.
 .\"
@@ -97,6 +97,8 @@ Status XScreenSaverUnregister(Display *\fIdpy\fP, int \fIscreen\fP\^);
 .HP
 Status XScreenSaverGetRegistered(Display *\fIdpy\fP, int \fIscreen\fP,
 XID *\fIxid\fP, Atom *\fItype\fP\^);
+.HP
+void XScreenSaverSuspend(Display *\fIdpy\fP, Bool \fIsuspend\fP\^);
 .PP
 .SH DESCRIPTION
 The X Window System provides support for changing the image on a
@@ -168,7 +170,7 @@ screen server in \fIsaver_info\fP and a non-zero value is
 returned.
 If the extension is not supported, \fIsaver_info\fP is not changed and 0
 is returned.
-.br
+.PP
 The \fIstate\fP field specifies whether or not the screen saver is currently
 active and how the \fItil-or-since\fP value should be interpreted:
 .TP 4
@@ -183,7 +185,7 @@ the number of milliseconds since the screen saver activated.
 .TP 4
 .I Disabled
 The screen saver is currently disabled; \fItil-or-since\fP is zero.
-.br
+.PP
 The \fIkind\fP field specifies the mechanism that either is currently being
 used or would have been were the screen being saved:
 .TP 4
@@ -304,6 +306,37 @@ the \fB_SCREEN_SAVER_ID\fP property on the
 root window of the specified \fIscreen\fP.
 It returns zero if an error is encountered or if the property does not
 exist or is not of the correct format; otherwise it returns non-zero.
+.PP
+.B XScreenSaverSuspend
+temporarily suspends the screensaver and DPMS timer if \fIsuspend\fP
+is 'True', and restarts the timer if \fIsuspend\fP is 'False'.
+.br
+This function should be used by applications that don't want the
+screensaver or DPMS to become activated while they're for example in
+the process of playing a media sequence, or are otherwise continuously
+presenting visual information to the user while in a non-interactive
+state. This function is not intended to be called by an external
+screensaver application.
+.br
+If \fBXScreenSaverSuspend\fP is called multiple times with \fIsuspend\fP
+set to 'True', it must be called an equal number of times with
+\fIsuspend\fP set to 'False' in order for the screensaver timer to be
+restarted. This request has no affect if a client tries to resume the
+screensaver without first having suspended it.
+\fBXScreenSaverSuspend\fP can thus not be used by one client to resume
+the screensaver if it's been suspended by another client.
+.br
+If a client that has suspended the screensaver becomes disconnected from
+the X server, the screensaver timer will automatically be restarted, unless
+it's still suspended by another client. Suspending the screensaver timer
+doesn't prevent the screensaver from being forceably activated with the
+\fBForceScreenSaver\fP request, or a DPMS mode from being set with the
+\fBDPMSForceLevel\fP request.
+.br
+\fBXScreenSaverSuspend\fP also doesn't deactivate the screensaver or DPMS
+if either is active at the time the request to suspend them is received by
+the X server. But once they've been deactivated, they won't automatically
+be activated again, until the client has canceled the suspension.
 .SH "ERRORS"
 .B XScreenSaverSelectInput,
 .B XScreenSaverQueryInfo,
@@ -317,6 +350,11 @@ If any undefined bits are set in \fIevent-mask\fP,
 a BadValue error is generated by 
 .B XScreenSaverSelectInput .
 .PP
+.SH AVAILABILITY
+\fBXScreenSaverSuspend\fP is available in version 1.1 and later versions
+of the X Screen Saver Extension. Version 1.1 was first released with
+X11R7.1.
+.PP
 .SH "SEE ALSO"
 X(__miscmansuffix__)
 .SH AUTHORS