NAME App::BraveUtils - Utilities related to Brave browser VERSION This document describes version 0.001 of App::BraveUtils (from Perl distribution App-BraveUtils), released on 2022-10-07. SYNOPSIS DESCRIPTION This distribution includes several utilities related to Brave browser: * brave-has-processes * brave-is-paused * brave-is-running * kill-brave * pause-and-unpause-brave * pause-brave * ps-brave * restart-brave * start-brave * terminate-brave * unpause-brave FUNCTIONS brave_has_processes Usage: brave_has_processes(%args) -> [$status_code, $reason, $payload, \%result_meta] Check whether Brave has processes. This function is not exported. Arguments ('*' denotes required arguments): * quiet => *true* * users => *array[unix::uid::exists]* Kill browser processes that belong to certain user(s) only. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) brave_is_paused Usage: brave_is_paused(%args) -> [$status_code, $reason, $payload, \%result_meta] Check whether Brave is paused. Brave is defined as paused if *all* of its processes are in 'stop' state. This function is not exported. Arguments ('*' denotes required arguments): * quiet => *true* * users => *array[unix::uid::exists]* Kill browser processes that belong to certain user(s) only. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) brave_is_running Usage: brave_is_running(%args) -> [$status_code, $reason, $payload, \%result_meta] Check whether Brave is running. Brave is defined as running if there are some Brave processes that are *not* in 'stop' state. In other words, if Brave has been started but is currently paused, we do not say that it's running. If you want to check if Brave process exists, you can use "ps_brave". This function is not exported. Arguments ('*' denotes required arguments): * quiet => *true* * users => *array[unix::uid::exists]* Kill browser processes that belong to certain user(s) only. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) pause_and_unpause_brave Usage: pause_and_unpause_brave(%args) -> [$status_code, $reason, $payload, \%result_meta] Pause and unpause Brave alternately. A modern browser now runs complex web pages and applications. Despite browser's power management feature, these pages/tabs on the browser often still eat considerable CPU cycles even though they only run in the background. Pausing (kill -STOP) the browser processes is a simple and effective way to stop CPU eating on Unix and prolong your laptop battery life. It can be performed whenever you are not using your browser for a little while, e.g. when you are typing on an editor or watching a movie. When you want to use your browser again, simply unpause (kill -CONT) it. The "pause-and-unpause" action pause and unpause browser in an alternate fashion, by default every 5 minutes and 30 seconds. This is a compromise to save CPU time most of the time but then give time for web applications in the browser to catch up during the unpause window (e.g. for WhatsApp Web to display new messages and sound notification.) It can be used when you are not browsing but still want to be notified by web applications from time to time. If you run this routine, it will start pausing and unpausing browser. When you want to use the browser, press Ctrl-C to interrupt the routine. Then after you are done with the browser and want to pause-and-unpause again, you can re-run this routine. You can customize the periods via the "periods" option. This function is not exported. Arguments ('*' denotes required arguments): * periods => *array[duration]* Pause and unpause times, in seconds. For example, to pause for 5 minutes, then unpause 10 seconds, then pause for 2 minutes, then unpause for 30 seconds (then repeat the pattern), you can use: 300,10,120,30 * users => *array[unix::uid::exists]* Kill browser processes that belong to certain user(s) only. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) pause_brave Usage: pause_brave(%args) -> [$status_code, $reason, $payload, \%result_meta] Pause (kill -STOP) Brave. A modern browser now runs complex web pages and applications. Despite browser's power management feature, these pages/tabs on the browser often still eat considerable CPU cycles even though they only run in the background. Pausing (kill -STOP) the browser processes is a simple and effective way to stop CPU eating on Unix and prolong your laptop battery life. It can be performed whenever you are not using your browser for a little while, e.g. when you are typing on an editor or watching a movie. When you want to use your browser again, simply unpause (kill -CONT) it. This function is not exported. Arguments ('*' denotes required arguments): * users => *array[unix::uid::exists]* Kill browser processes that belong to certain user(s) only. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) ps_brave Usage: ps_brave(%args) -> [$status_code, $reason, $payload, \%result_meta] List Brave processes. This function is not exported. Arguments ('*' denotes required arguments): * users => *array[unix::uid::exists]* Kill browser processes that belong to certain user(s) only. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) restart_brave Usage: restart_brave(%args) -> [$status_code, $reason, $payload, \%result_meta] Restart brave. This function is not exported. This function supports dry-run operation. Arguments ('*' denotes required arguments): * quiet => *true* Special arguments: * -dry_run => *bool* Pass -dry_run=>1 to enable simulation mode. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) start_brave Usage: start_brave(%args) -> [$status_code, $reason, $payload, \%result_meta] Start brave if not already started. This function is not exported. This function supports dry-run operation. Arguments ('*' denotes required arguments): * quiet => *true* Special arguments: * -dry_run => *bool* Pass -dry_run=>1 to enable simulation mode. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) terminate_brave Usage: terminate_brave(%args) -> [$status_code, $reason, $payload, \%result_meta] Terminate Brave (by default with -KILL signal). This function is not exported. Arguments ('*' denotes required arguments): * signal => *unix::signal* * users => *array[unix::uid::exists]* Kill browser processes that belong to certain user(s) only. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) unpause_brave Usage: unpause_brave(%args) -> [$status_code, $reason, $payload, \%result_meta] Unpause (resume, continue, kill -CONT) Brave. This function is not exported. Arguments ('*' denotes required arguments): * users => *array[unix::uid::exists]* Kill browser processes that belong to certain user(s) only. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) HOMEPAGE Please visit the project's homepage at <https://metacpan.org/release/App-BraveUtils>. SOURCE Source repository is at <https://github.com/perlancar/perl-App-BraveUtils>. SEE ALSO <https://brave.com> App::ChromeUtils App::FirefoxUtils App::OperaUtils App::VivaldiUtils App::BrowserUtils AUTHOR perlancar <perlancar@cpan.org> CONTRIBUTING To contribute, you can send patches by email/via RT, or send pull requests on GitHub. Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via: % prove -l If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me. COPYRIGHT AND LICENSE This software is copyright (c) 2022 by perlancar <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. BUGS Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=App-BraveUtils> 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.