X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-inhibit.xml;h=9d85908f97cdaf5ccc0f06f94f68b65eb6897e0a;hp=34095902c2b2ac40e9d699ea1a597ee9cada92b7;hb=6ecb6cec66739d733e95302031998f517261380c;hpb=eecd1362f7f4de432483b5d77c56726c3621a83a diff --git a/man/systemd-inhibit.xml b/man/systemd-inhibit.xml index 34095902c..9d85908f9 100644 --- a/man/systemd-inhibit.xml +++ b/man/systemd-inhibit.xml @@ -1,6 +1,6 @@ + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - - - - systemd-inhibit - systemd - - - - Developer - Lennart - Poettering - lennart@poettering.net - - - - - - systemd-inhibit - 1 - - - - systemd-inhibit - Execute a program with an inhibition lock taken - - - - - systemd-inhibit OPTIONS COMMAND ARGUMENTS - - - systemd-inhibit OPTIONS --list - - - - - Description - - systemd-inhibit may be used - to execute a program with a shutdown, suspend or idle - inhibitor lock taken. The lock will be acquired before - the specified command line is executed and released - afterwards. - - Inhibitor locks may be used to block or delay - suspend and shutdown requests from the user, as well - as automatic idle handling of the OS. This may be used - to avoid system suspends while an optical disc is - being recorded, or similar operations that should not - be interrupted. - - - - Options - - The following options are understood: - - - - - - - Prints a short help - text and exits. - - - - - - Prints a short version - string and exits. - - - - - - Takes a colon - separated list of one or more - operations to inhibit: - shutdown, - suspend, - idle, for - inhibiting reboot/power-off/halt/kexec, - suspending/hibernating, resp. the - automatic idle - detection. - - - - - - Takes a short human - readable descriptive string for the - program taking the lock. If not passed - defaults to the command line - string. - - - - - - Takes a short human - readable descriptive string for the - reason for taking the lock. Defaults - to "Unknown reason". - - - - - - Takes either - block or - delay and describes - how the lock is applied. If - block is used (the - default), the lock prohibits any of - the requested operations without time - limit, and only privileged users may - override it. If - delay is used, the - lock can only delay the requested - operations for a limited time. If the - time elapses the lock is ignored and - the operation executed. The time limit - may be specified in - systemd-logind.conf5. - - - - - - Lists all active - inhibition locks instead of acquiring - one. - - - - - - - - - Exit status - - Returns the exit status of the executed program. - - - - See Also - - systemd1, - systemd-logind.conf5 - - + + + + systemd-inhibit + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-inhibit + 1 + + + + systemd-inhibit + Execute a program with an inhibition lock taken + + + + + systemd-inhibit OPTIONS COMMAND ARGUMENTS + + + systemd-inhibit OPTIONS --list + + + + + Description + + systemd-inhibit may be used to execute a + program with a shutdown, sleep or idle inhibitor lock taken. The + lock will be acquired before the specified command line is + executed and released afterwards. + + Inhibitor locks may be used to block or delay system sleep + and shutdown requests from the user, as well as automatic idle + handling of the OS. This is useful to avoid system suspends while + an optical disc is being recorded, or similar operations that + should not be interrupted. + + For more information see the Inhibitor + Lock Developer Documentation. + + + + Options + + The following options are understood: + + + + + + Takes a colon-separated list of one or more + operations to inhibit: + shutdown, + sleep, + idle, + handle-power-key, + handle-suspend-key, + handle-hibernate-key, + handle-lid-switch, + for inhibiting reboot/power-off/halt/kexec, + suspending/hibernating, the automatic idle detection, or the + low-level handling of the power/sleep key and the lid switch, + respectively. If omitted, defaults to + idle:sleep:shutdown. + + + + + + Takes a short, human-readable descriptive + string for the program taking the lock. If not passed, + defaults to the command line string. + + + + + + Takes a short, human-readable descriptive + string for the reason for taking the lock. Defaults to + "Unknown reason". + + + + + + Takes either block or + delay and describes how the lock is + applied. If block is used (the default), + the lock prohibits any of the requested operations without + time limit, and only privileged users may override it. If + delay is used, the lock can only delay the + requested operations for a limited time. If the time elapses, + the lock is ignored and the operation executed. The time limit + may be specified in + logind.conf5. + Note that delay is only available for + sleep and + shutdown. + + + + + + Lists all active inhibition locks instead of + acquiring one. + + + + + + + + + + Exit status + + Returns the exit status of the executed program. + + + + Example + + # systemd-inhibit wodim foobar.iso + + This burns the ISO image + foobar.iso on a CD using + wodim1, + and inhibits system sleeping, shutdown and idle while + doing so. + + + + See Also + + systemd1, + logind.conf5 + +