diff options
Diffstat (limited to 'portland/xdg-utils/scripts/xdg-screensaver')
| -rwxr-xr-x | portland/xdg-utils/scripts/xdg-screensaver | 131 |
1 files changed, 71 insertions, 60 deletions
diff --git a/portland/xdg-utils/scripts/xdg-screensaver b/portland/xdg-utils/scripts/xdg-screensaver index f1374eb..1bf0530 100755 --- a/portland/xdg-utils/scripts/xdg-screensaver +++ b/portland/xdg-utils/scripts/xdg-screensaver @@ -35,102 +35,113 @@ manualpage() cat << _MANUALPAGE Name -xdg-screensaver — command line tool for controlling the screensaver + xdg-screensaver -- command line tool for controlling the screensaver Synopsis -xdg-screensaver suspend WindowID + xdg-screensaver suspend WindowID -xdg-screensaver resume WindowID + xdg-screensaver resume WindowID -xdg-screensaver { activate | reset | status } + xdg-screensaver { activate | reset | status } -xdg-screensaver { --help | --manual | --version } + xdg-screensaver { --help | --manual | --version } Description -xdg-screensaver provides commands to control the screensaver. + 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. + 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. -reset - Turns the screensaver off immediately. On some systems the user may be - asked to authenticate first before the screen is unlocked. -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. + 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. + + reset + Turns the screensaver off immediately. On some systems the user + may be asked to authenticate first before the screen is unlocked. + + 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. + --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: + 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. -2 - One of the files passed on the command line did not exist. -3 - A required tool could not be found. -4 - The action failed. + 1 + Error in command line syntax. -Examples + 2 + One of the files passed on the command line did not exist. -xdg-screensaver suspend 0x1c00007 + 3 + A required tool could not be found. + + 4 + The action failed. + +Examples -Causes the screensaver to be disabled till xdg-screensaver resume 0x1c00007 is -called. 0x1c00007 must be the X Window ID of an existing window. + 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. _MANUALPAGE } usage() { cat << _USAGE -xdg-screensaver — command line tool for controlling the screensaver + xdg-screensaver -- command line tool for controlling the screensaver Synopsis -xdg-screensaver suspend WindowID + xdg-screensaver suspend WindowID -xdg-screensaver resume WindowID + xdg-screensaver resume WindowID -xdg-screensaver { activate | reset | status } + xdg-screensaver { activate | reset | status } -xdg-screensaver { --help | --manual | --version } + xdg-screensaver { --help | --manual | --version } _USAGE } |