xdg-screensaver man page on ElementaryOS

Man page or keyword search:  
man Server   4994 pages
apropos Keyword Search (all sections)
Output format
ElementaryOS logo
[printable version]

XDG-SCREENSAVER(1)	    xdg-screensaver Manual	    XDG-SCREENSAVER(1)

NAME
       xdg-screensaver - command line tool for controlling the screensaver

SYNOPSIS
       xdg-screensaver suspend WindowID

       xdg-screensaver resume WindowID

       xdg-screensaver {activate | lock | reset | status}

       xdg-screensaver {--help | --manual | --version}

DESCRIPTION
       xdg-screensaver provides commands to control the screensaver.

       xdg-screensaver is for use inside a desktop session only. It is not
       recommended to use xdg-screensaver as root.

COMMANDS
       suspend WindowID
	   Suspends the screensaver and monitor power management.  WindowID
	   must be the X Window ID of an existing window of the calling
	   application. The window must remain in existance for the duration
	   of the suspension.

	   WindowID can be represented as either a decimal number or as a
	   hexadecimal number consisting of the prefix 0x followed by one or
	   more hexadecimal digits.

	   The screensaver can be suspended in relation to multiple windows at
	   the same time. In that case screensaver operation is only restored
	   once the screensaver has been resumed in relation to each of the
	   windows

       resume WindowID
	   Resume the screensaver and monitor power management after being
	   suspended.  WindowID must be the same X Window ID that was passed
	   to a previous call of xdg-screensaver suspend

       activate
	   Turns the screensaver on immediately. This may result in the screen
	   getting locked, depending on existing system policies.

       lock
	   Lock the screen immediately.

       reset
	   Turns the screensaver off immediately. If the screen was locked the
	   user may be asked to authenticate first.

       status
	   Prints enabled to stdout if the screensaver is enabled to turn on
	   after a period of inactivity and prints disabled if the screensaver
	   is not enabled.

OPTIONS
       --help
	   Show command synopsis.

       --manual
	   Show this manualpage.

       --version
	   Show the xdg-utils version information.

EXIT CODES
       An exit code of 0 indicates success while a non-zero exit code
       indicates failure. The following failure codes can be returned:

       1
	   Error in command line syntax.

       3
	   A required tool could not be found.

       4
	   The action failed.

EXAMPLES
	   xdg-screensaver suspend 0x1c00007

       Causes the screensaver to be disabled till xdg-screensaver resume
       0x1c00007 is called.  0x1c00007 must be the X Window ID of an existing
       window.

AUTHOR
       Bryce Harrington
	   Author.

COPYRIGHT
       Copyright © 2006

xdg-utils 1.0			  12/31/2010		    XDG-SCREENSAVER(1)
[top]

List of man pages available for ElementaryOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net