App::PowerManagementUtils - CLI utilities related to power management
This document describes version 0.004 of App::PowerManagementUtils (from Perl distribution App-PowerManagementUtils), released on 2019-09-15.
This distribution contains the following CLI utilities related to screensaver:
nosleep
prevent-sleep
prevent-sleep-until-interrupted
prevent-sleep-while
sleep-is-prevented
unprevent-sleep
Usage:
prevent_sleep_until_interrupted() -> [status, msg, payload, meta]
Prevent sleep until interrupted.
Uses Proc::Govern to run sleep infinity, with the option `no-sleep' to instruct Proc::Govern to disable system from sleeping. To stop preventing sleep, you can press Ctrl-C.
sleep infinity
This function is not exported.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
prevent_sleep_while(%args) -> [status, msg, payload, meta]
Prevent sleep while running a command.
Uses Proc::Govern to run a command, with the option `no-sleep' to instruct Proc::Govern to disable system from sleeping while running the command. For more options when running command, e.g. timeout, load control, autorestart, screensaver control, use the module or its CLI govproc directly.
Arguments ('*' denotes required arguments):
command* => array[str]
Please visit the project's homepage at https://metacpan.org/release/App-PowerManagementUtils.
Source repository is at https://github.com/perlancar/perl-App-PowerManagementUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PowerManagementUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2019 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::PowerManagementUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::PowerManagementUtils
CPAN shell
perl -MCPAN -e shell install App::PowerManagementUtils
For more information on module installation, please visit the detailed CPAN module installation guide.