Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

PERLANCAR / App-PowerManagementUtils-0.005 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

              
NAME
    App::PowerManagementUtils - CLI utilities related to power management
VERSION
    This document describes version 0.005 of App::PowerManagementUtils (from
    Perl distribution App-PowerManagementUtils), released on 2020-09-25.
DESCRIPTION
    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
FUNCTIONS
  prevent_sleep_until_interrupted
    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.
    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.
    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
    Usage:
     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.
    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.
    This function is not exported.
    Arguments ('*' denotes required arguments):
    *   command* => *array[str]*
    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)
HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-PowerManagementUtils>.
SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-PowerManagementUtils>.
BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=App-PowerManagementUt
    ils>
    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.
AUTHOR
    perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
    This software is copyright (c) 2020, 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.