OLD | NEW |
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859
-1"><title>xdg-screensaver</title><meta name="generator" content="DocBook XSL St
ylesheets V1.69.1"></head><body bgcolor="white" text="black" link="#0000FF" vlin
k="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-screens
aver"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>x
dg-screensaver — command line tool for controlling the screensaver</p></di
v><div class="refsynopsisdiv"><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="cmdsynops
is"><p><code class="command">xdg-screensaver</code> <code class="option">resum
e <em class="replaceable"><code>WindowID</code></em></code> </p></div><div class
="cmdsynopsis"><p><code class="command">xdg-screensaver</code> { <code class="o
ption">activate</code> | <code class="option">lock</code> | <code class="o
ption">reset</code> | <code class="option">status</code> }</p></div><div clas
s="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" lang="en"><a n
ame="description"></a><h2>Description</h2><p> | 1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859
-1"><title>xdg-screensaver</title><meta name="generator" content="DocBook XSL St
ylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlin
k="#840084" alink="#0000FF"><div class="refentry" title="xdg-screensaver"><a nam
e="xdg-screensaver"></a><div class="titlepage"></div><div class="refnamediv"><h2
>Name</h2><p>xdg-screensaver — command line tool for controlling the scree
nsaver</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><d
iv class="cmdsynopsis"><p><code class="command">xdg-screensaver</code> <code c
lass="option">suspend <em class="replaceable"><code>WindowID</code></em></code>
</p></div><div class="cmdsynopsis"><p><code class="command">xdg-screensaver</cod
e> <code class="option">resume <em class="replaceable"><code>WindowID</code></
em></code> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-scree
nsaver</code> { <code class="option">activate</code> | <code class="option">
lock</code> | <code class="option">reset</code> | <code class="option">sta
tus</code> }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-scre
ensaver</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> |
2 xdg-screensaver provides commands to control the screensaver. | 2 xdg-screensaver provides commands to control the screensaver. |
3 </p><p> | 3 </p><p> |
4 xdg-screensaver is for use inside a desktop session only. | 4 xdg-screensaver is for use inside a desktop session only. |
5 It is not recommended to use xdg-screensaver as root. | 5 It is not recommended to use xdg-screensaver as root. |
6 </p></div><div class="refsect1" lang="en"><a name="commands"></a><h2>Command
s</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> | 6 </p></div><div class="refsect1" title="Commands"><a name="commands"></a><h2>
Commands</h2><div class="variablelist"><dl><dt><span class="term"><code class="o
ption">suspend <em class="replaceable"><code>WindowID</code></em></code></span><
/dt><dd><p class="simpara"> |
7 Suspends the screensaver and monitor power management. | 7 Suspends the screensaver and monitor power management. |
8 <em class="replaceable"><code>WindowID</code></em> must be the X Win
dow ID | 8 <em class="replaceable"><code>WindowID</code></em> must be the X Win
dow ID |
9 of an existing window of the calling application. The window | 9 of an existing window of the calling application. The window |
10 must remain in existance for the duration of the suspension. | 10 must remain in existance for the duration of the suspension. |
11 </p><p> | 11 </p><p class="simpara"> |
12 WindowID can be represented as either a decimal number | 12 WindowID can be represented as either a decimal number |
13 or as a hexadecimal number consisting of the prefix | 13 or as a hexadecimal number consisting of the prefix |
14 <span class="emphasis"><em>0x</em></span> followed by one or more he
xadecimal | 14 <span class="emphasis"><em>0x</em></span> followed by one or more he
xadecimal |
15 digits. | 15 digits. |
16 </p><p> | 16 </p><p class="simpara"> |
17 The screensaver can be suspended in relation to multiple | 17 The screensaver can be suspended in relation to multiple |
18 windows at the same time. In that case screensaver | 18 windows at the same time. In that case screensaver |
19 operation is only restored once the screensaver has been | 19 operation is only restored once the screensaver has been |
20 resumed in relation to each of the windows | 20 resumed in relation to each of the windows |
21 </p></dd><dt><span class="term"><code class="option">resume <em class=
"replaceable"><code>WindowID</code></em></code></span></dt><dd> | 21 </p></dd><dt><span class="term"><code class="option">resume <em class=
"replaceable"><code>WindowID</code></em></code></span></dt><dd> |
22 Resume the screensaver and monitor power management after being | 22 Resume the screensaver and monitor power management after being |
23 suspended. | 23 suspended. |
24 <em class="replaceable"><code>WindowID</code></em> | 24 <em class="replaceable"><code>WindowID</code></em> |
25 must be the same X Window ID that was passed to a previous call | 25 must be the same X Window ID that was passed to a previous call |
26 of <span><strong class="command">xdg-screensaver suspend</strong></s
pan> | 26 of <span class="command"><strong>xdg-screensaver suspend</strong></s
pan> |
27 </dd><dt><span class="term"><code class="option">activate</code></span
></dt><dd> | 27 </dd><dt><span class="term"><code class="option">activate</code></span
></dt><dd> |
28 Turns the screensaver on immediately. This may result in the | 28 Turns the screensaver on immediately. This may result in the |
29 screen getting locked, depending on existing system policies. | 29 screen getting locked, depending on existing system policies. |
30 </dd><dt><span class="term"><code class="option">lock</code></span></d
t><dd> | 30 </dd><dt><span class="term"><code class="option">lock</code></span></d
t><dd> |
31 Lock the screen immediately. | 31 Lock the screen immediately. |
32 </dd><dt><span class="term"><code class="option">reset</code></span></
dt><dd> | 32 </dd><dt><span class="term"><code class="option">reset</code></span></
dt><dd> |
33 Turns the screensaver off immediately. If the screen was locked | 33 Turns the screensaver off immediately. If the screen was locked |
34 the user may be asked to authenticate first. | 34 the user may be asked to authenticate first. |
35 </dd><dt><span class="term"><code class="option">status</code></span><
/dt><dd> | 35 </dd><dt><span class="term"><code class="option">status</code></span><
/dt><dd> |
36 Prints <span class="emphasis"><em>enabled</em></span> to stdout if t
he | 36 Prints <span class="emphasis"><em>enabled</em></span> to stdout if t
he |
37 screensaver is enabled to turn on after a period of | 37 screensaver is enabled to turn on after a period of |
38 inactivity and prints | 38 inactivity and prints |
39 <span class="emphasis"><em>disabled</em></span> if the screensaver i
s | 39 <span class="emphasis"><em>disabled</em></span> if the screensaver i
s |
40 not enabled. | 40 not enabled. |
41 </dd></dl></div></div><div class="refsect1" lang="en"><a name="options
"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code
class="option">--help</code></span></dt><dd> | 41 </dd></dl></div></div><div class="refsect1" title="Options"><a name="o
ptions"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"
><code class="option">--help</code></span></dt><dd> |
42 Show command synopsis. | 42 Show command synopsis. |
43 </dd><dt><span class="term"><code class="option">--manual</code></span
></dt><dd> | 43 </dd><dt><span class="term"><code class="option">--manual</code></span
></dt><dd> |
44 Show this manualpage. | 44 Show this manualpage. |
45 </dd><dt><span class="term"><code class="option">--version</code></spa
n></dt><dd> | 45 </dd><dt><span class="term"><code class="option">--version</code></spa
n></dt><dd> |
46 Show the xdg-utils version information. | 46 Show the xdg-utils version information. |
47 </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcod
es"></a><h2>Exit Codes</h2><p> | 47 </dd></dl></div></div><div class="refsect1" title="Exit Codes"><a name
="exitcodes"></a><h2>Exit Codes</h2><p> |
48 An exit code of 0 indicates success while a non-zero exit code | 48 An exit code of 0 indicates success while a non-zero exit code |
49 indicates failure. The following failure codes can be returned: | 49 indicates failure. The following failure codes can be returned: |
50 </p><div class="variablelist"><dl><dt><span class="term"><code class="option
">1</code></span></dt><dd> | 50 </p><div class="variablelist"><dl><dt><span class="term"><code class="option
">1</code></span></dt><dd> |
51 Error in command line syntax. | 51 Error in command line syntax. |
52 </dd><dt><span class="term"><code class="option">3</code></span></dt><
dd> | 52 </dd><dt><span class="term"><code class="option">3</code></span></dt><
dd> |
53 A required tool could not be found. | 53 A required tool could not be found. |
54 </dd><dt><span class="term"><code class="option">4</code></span></dt><
dd> | 54 </dd><dt><span class="term"><code class="option">4</code></span></dt><
dd> |
55 The action failed. | 55 The action failed. |
56 » </dd></dl></div></div><div class="refsect1" lang="en"><a name="example
s"></a><h2>Examples</h2><p> | 56 » </dd></dl></div></div><div class="refsect1" title="Examples"><a name="
examples"></a><h2>Examples</h2><p> |
57 </p><pre class="programlisting"> | 57 </p><pre class="programlisting"> |
58 xdg-screensaver suspend 0x1c00007 | 58 xdg-screensaver suspend 0x1c00007 |
59 </pre><p>Causes the screensaver to be disabled till | 59 </pre><p>Causes the screensaver to be disabled till |
60 <span><strong class="command">xdg-screensaver resume 0x1c00007</strong><
/span> is called. | 60 <span class="command"><strong>xdg-screensaver resume 0x1c00007</strong><
/span> is called. |
61 <span class="emphasis"><em>0x1c00007</em></span> must be the X Window ID
of an | 61 <span class="emphasis"><em>0x1c00007</em></span> must be the X Window ID
of an |
62 existing window. | 62 existing window. |
63 </p></div></div></body></html> | 63 </p></div></div></body></html> |
OLD | NEW |