| OLD | NEW |
|---|
| (Empty) | |
| 1 <?xml version="1.0"?> |
| 2 <?xml-stylesheet type="text/xsl" |
| 3 href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl
"?> |
| 4 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" |
| 5 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ |
| 6 ]> |
| 7 <refentry id="xdg-screensaver"> |
| 8 <refentryinfo> |
| 9 <title>xdg-screensaver Manual</title> |
| 10 <copyright> |
| 11 <year>2006</year> |
| 12 </copyright> |
| 13 <author> |
| 14 <firstname>Bryce</firstname> |
| 15 <surname>Harrington</surname> |
| 16 </author> |
| 17 <address><email>bryce@osdl.org</email></address> |
| 18 <releaseinfo>xdg-utils 1.0</releaseinfo> |
| 19 </refentryinfo> |
| 20 |
| 21 <refmeta> |
| 22 <refentrytitle>xdg-screensaver</refentrytitle> |
| 23 <manvolnum>1</manvolnum> |
| 24 </refmeta> |
| 25 |
| 26 <refnamediv> |
| 27 <refname>xdg-screensaver</refname> |
| 28 <refpurpose>command line tool for controlling the screensaver</refpurpose> |
| 29 </refnamediv> |
| 30 |
| 31 <refsynopsisdiv> |
| 32 <cmdsynopsis> |
| 33 <command>xdg-screensaver</command> |
| 34 <arg choice="plain"><option>suspend <replaceable>WindowID</replaceable></o
ption></arg> |
| 35 </cmdsynopsis> |
| 36 <cmdsynopsis> |
| 37 <command>xdg-screensaver</command> |
| 38 <arg choice="plain"><option>resume <replaceable>WindowID</replaceable></op
tion></arg> |
| 39 </cmdsynopsis> |
| 40 <cmdsynopsis> |
| 41 <command>xdg-screensaver</command> |
| 42 <group choice="req"> |
| 43 <arg choice="plain"><option>activate</option></arg> |
| 44 <arg choice="plain"><option>lock</option></arg> |
| 45 <arg choice="plain"><option>reset</option></arg> |
| 46 <arg choice="plain"><option>status</option></arg> |
| 47 </group> |
| 48 </cmdsynopsis> |
| 49 <cmdsynopsis> |
| 50 <command>xdg-screensaver</command> |
| 51 <group choice="req"> |
| 52 <arg choice="plain"><option>--help</option></arg> |
| 53 <arg choice="plain"><option>--manual</option></arg> |
| 54 <arg choice="plain"><option>--version</option></arg> |
| 55 </group> |
| 56 </cmdsynopsis> |
| 57 </refsynopsisdiv> |
| 58 |
| 59 <refsect1 id="description"> |
| 60 <title>Description</title> |
| 61 <para> |
| 62 xdg-screensaver provides commands to control the screensaver. |
| 63 </para> |
| 64 <para> |
| 65 xdg-screensaver is for use inside a desktop session only. |
| 66 It is not recommended to use xdg-screensaver as root. |
| 67 </para> |
| 68 </refsect1> |
| 69 <refsect1 id="commands"> |
| 70 <title>Commands</title> |
| 71 <variablelist> |
| 72 <varlistentry> |
| 73 <term><option>suspend <replaceable>WindowID</replaceable></option></term
> |
| 74 <listitem> |
| 75 <simpara> |
| 76 Suspends the screensaver and monitor power management. |
| 77 <replaceable>WindowID</replaceable> must be the X Window ID |
| 78 of an existing window of the calling application. The window |
| 79 must remain in existance for the duration of the suspension. |
| 80 </simpara> |
| 81 <simpara> |
| 82 WindowID can be represented as either a decimal number |
| 83 or as a hexadecimal number consisting of the prefix |
| 84 <emphasis>0x</emphasis> followed by one or more hexadecimal |
| 85 digits. |
| 86 </simpara> |
| 87 <simpara> |
| 88 The screensaver can be suspended in relation to multiple |
| 89 windows at the same time. In that case screensaver |
| 90 operation is only restored once the screensaver has been |
| 91 resumed in relation to each of the windows |
| 92 </simpara> |
| 93 </listitem> |
| 94 </varlistentry> |
| 95 |
| 96 <varlistentry> |
| 97 <term><option>resume <replaceable>WindowID</replaceable></option></term> |
| 98 <listitem> |
| 99 <simpara> |
| 100 Resume the screensaver and monitor power management after being |
| 101 suspended. |
| 102 <replaceable>WindowID</replaceable> |
| 103 must be the same X Window ID that was passed to a previous call |
| 104 of <command>xdg-screensaver suspend</command> |
| 105 </simpara> |
| 106 </listitem> |
| 107 </varlistentry> |
| 108 |
| 109 <varlistentry> |
| 110 <term><option>activate</option></term> |
| 111 <listitem> |
| 112 <simpara> |
| 113 Turns the screensaver on immediately. This may result in the |
| 114 screen getting locked, depending on existing system policies. |
| 115 </simpara> |
| 116 </listitem> |
| 117 </varlistentry> |
| 118 |
| 119 <varlistentry> |
| 120 <term><option>lock</option></term> |
| 121 <listitem> |
| 122 <simpara> |
| 123 Lock the screen immediately. |
| 124 </simpara> |
| 125 </listitem> |
| 126 </varlistentry> |
| 127 |
| 128 <varlistentry> |
| 129 <term><option>reset</option></term> |
| 130 <listitem> |
| 131 <simpara> |
| 132 Turns the screensaver off immediately. If the screen was locked |
| 133 the user may be asked to authenticate first. |
| 134 </simpara> |
| 135 </listitem> |
| 136 </varlistentry> |
| 137 |
| 138 <varlistentry> |
| 139 <term><option>status</option></term> |
| 140 <listitem> |
| 141 <simpara> |
| 142 Prints <emphasis>enabled</emphasis> to stdout if the |
| 143 screensaver is enabled to turn on after a period of |
| 144 inactivity and prints |
| 145 <emphasis>disabled</emphasis> if the screensaver is |
| 146 not enabled. |
| 147 </simpara> |
| 148 </listitem> |
| 149 </varlistentry> |
| 150 </variablelist> |
| 151 </refsect1> |
| 152 <refsect1 id="options"> |
| 153 <title>Options</title> |
| 154 <variablelist> |
| 155 <varlistentry> |
| 156 <term><option>--help</option></term> |
| 157 <listitem> |
| 158 <simpara> |
| 159 Show command synopsis. |
| 160 </simpara> |
| 161 </listitem> |
| 162 </varlistentry> |
| 163 |
| 164 <varlistentry> |
| 165 <term><option>--manual</option></term> |
| 166 <listitem> |
| 167 <simpara> |
| 168 Show this manualpage. |
| 169 </simpara> |
| 170 </listitem> |
| 171 </varlistentry> |
| 172 |
| 173 <varlistentry> |
| 174 <term><option>--version</option></term> |
| 175 <listitem> |
| 176 <simpara> |
| 177 Show the xdg-utils version information. |
| 178 </simpara> |
| 179 </listitem> |
| 180 </varlistentry> |
| 181 </variablelist> |
| 182 </refsect1> |
| 183 <refsect1 id="exitcodes"> |
| 184 <title>Exit Codes</title> |
| 185 <para> |
| 186 An exit code of 0 indicates success while a non-zero exit code |
| 187 indicates failure. The following failure codes can be returned: |
| 188 </para> |
| 189 <variablelist> |
| 190 <varlistentry> |
| 191 <term><option>1</option></term> |
| 192 <listitem> |
| 193 <simpara> |
| 194 Error in command line syntax. |
| 195 </simpara> |
| 196 </listitem> |
| 197 </varlistentry> |
| 198 <varlistentry> |
| 199 <term><option>3</option></term> |
| 200 <listitem> |
| 201 <simpara> |
| 202 A required tool could not be found. |
| 203 </simpara> |
| 204 </listitem> |
| 205 </varlistentry> |
| 206 <varlistentry> |
| 207 <term><option>4</option></term> |
| 208 <listitem> |
| 209 <simpara> |
| 210 The action failed. |
| 211 </simpara> |
| 212 </listitem> |
| 213 </varlistentry> |
| 214 </variablelist> |
| 215 </refsect1> |
| 216 <refsect1 id="examples"> |
| 217 <title>Examples</title> |
| 218 <para> |
| 219 <programlisting> |
| 220 xdg-screensaver suspend 0x1c00007 |
| 221 </programlisting>Causes the screensaver to be disabled till |
| 222 <command>xdg-screensaver resume 0x1c00007</command> is called. |
| 223 <emphasis>0x1c00007</emphasis> must be the X Window ID of an |
| 224 existing window. |
| 225 </para> |
| 226 </refsect1> |
| 227 </refentry> |
| OLD | NEW |
|---|
Chromium Code Reviews
