- COPYRIGHT AND LICENSE
prevent-sleep-while - Prevent sleep while running a command
This document describes version 0.005 of prevent-sleep-while (from Perl distribution App-PowerManagementUtils), released on 2020-09-25.
% prevent-sleep-while [--debug] [--format=name] [--json] [--log-level=level] [--(no)naked-res] [--page-result[=program]] [--quiet] [--trace] [--verbose] <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.
Note that sleep prevention survives reboot, so if this script is terminated prematurely before it can unprevent sleep again, you'll need to invoke unprevent-sleep to restore normal sleep.
* marks required options.
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Choose output format, e.g. json, text.
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
Filter output through a pager.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C prevent-sleep-while prevent-sleep-while
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete prevent-sleep-while 'p/*/`prevent-sleep-while`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
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.
This software is copyright (c) 2020, 2019 by firstname.lastname@example.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.