blob: 219f48ca2fe1466fd980ed74678c451812af27a6 [file] [log] [blame]
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-screensaver</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="xdg-screensaver"><a name="xdg-screensaver"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-screensaver &#8212; command line tool for controlling the screensaver</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-screensaver</code> <code class="option">suspend <em class="replaceable"><code>WindowID</code></em></code> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-screensaver</code> <code class="option">resume <em class="replaceable"><code>WindowID</code></em></code> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-screensaver</code> { <code class="option">activate</code> | <code class="option">lock</code> | <code class="option">reset</code> | <code class="option">status</code> }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-screensaver</code> { <code class="option">--help</code> | <code class="option">--manual</code> | <code class="option">--version</code> }</p></div></div><div class="refsect1" title="Description"><a name="description"></a><h2>Description</h2><p>
xdg-screensaver provides commands to control the screensaver.
</p><p>
xdg-screensaver is for use inside a desktop session only.
It is not recommended to use xdg-screensaver as root.
</p></div><div class="refsect1" title="Commands"><a name="commands"></a><h2>Commands</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">suspend <em class="replaceable"><code>WindowID</code></em></code></span></dt><dd><p class="simpara">
Suspends the screensaver and monitor power management.
<em class="replaceable"><code>WindowID</code></em> 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.
</p><p class="simpara">
WindowID can be represented as either a decimal number
or as a hexadecimal number consisting of the prefix
<span class="emphasis"><em>0x</em></span> followed by one or more hexadecimal
digits.
</p><p class="simpara">
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
</p></dd><dt><span class="term"><code class="option">resume <em class="replaceable"><code>WindowID</code></em></code></span></dt><dd>
Resume the screensaver and monitor power management after being
suspended.
<em class="replaceable"><code>WindowID</code></em>
must be the same X Window ID that was passed to a previous call
of <span class="command"><strong>xdg-screensaver suspend</strong></span>
</dd><dt><span class="term"><code class="option">activate</code></span></dt><dd>
Turns the screensaver on immediately. This may result in the
screen getting locked, depending on existing system policies.
</dd><dt><span class="term"><code class="option">lock</code></span></dt><dd>
Lock the screen immediately.
</dd><dt><span class="term"><code class="option">reset</code></span></dt><dd>
Turns the screensaver off immediately. If the screen was locked
the user may be asked to authenticate first.
</dd><dt><span class="term"><code class="option">status</code></span></dt><dd>
Prints <span class="emphasis"><em>enabled</em></span> to stdout if the
screensaver is enabled to turn on after a period of
inactivity and prints
<span class="emphasis"><em>disabled</em></span> if the screensaver is
not enabled.
</dd></dl></div></div><div class="refsect1" title="Options"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--help</code></span></dt><dd>
Show command synopsis.
</dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd>
Show this manualpage.
</dd><dt><span class="term"><code class="option">--version</code></span></dt><dd>
Show the xdg-utils version information.
</dd></dl></div></div><div class="refsect1" title="Exit Codes"><a name="exitcodes"></a><h2>Exit Codes</h2><p>
An exit code of 0 indicates success while a non-zero exit code
indicates failure. The following failure codes can be returned:
</p><div class="variablelist"><dl><dt><span class="term"><code class="option">1</code></span></dt><dd>
Error in command line syntax.
</dd><dt><span class="term"><code class="option">3</code></span></dt><dd>
A required tool could not be found.
</dd><dt><span class="term"><code class="option">4</code></span></dt><dd>
The action failed.
</dd></dl></div></div><div class="refsect1" title="Examples"><a name="examples"></a><h2>Examples</h2><p>
</p><pre class="programlisting">
xdg-screensaver suspend 0x1c00007
</pre><p>Causes the screensaver to be disabled till
<span class="command"><strong>xdg-screensaver resume 0x1c00007</strong></span> is called.
<span class="emphasis"><em>0x1c00007</em></span> must be the X Window ID of an
existing window.
</p></div></div></body></html>