NAME
App::VivaldiUtils - Utilities related to the Vivaldi browser
VERSION
This document describes version 0.011 of App::VivaldiUtils (from Perl
distribution App-VivaldiUtils), released on 2023-10-28.
SYNOPSIS
DESCRIPTION
This distribution includes several utilities related to the Vivaldi
browser:
1. kill-vivaldi
2. list-vivaldi-profiles
3. pause-vivaldi
4. ps-vivaldi
5. restart-vivaldi
6. start-vivaldi
7. terminate-vivaldi
8. unpause-vivaldi
9. vivaldi-has-processes
10. vivaldi-is-paused
11. vivaldi-is-running
FUNCTIONS
pause_vivaldi
Usage:
pause_vivaldi(%args) -> [$status_code, $reason, $payload, \%result_meta]
Pause (kill -STOP) Vivaldi.
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):
* cmndline_pat => *re_from_str*
Filter processes using regex against their cmndline.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* exec_pat => *re_from_str*
Filter processes using regex against their exec.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* fname_pat => *re_from_str*
Filter processes using regex against their fname.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* pid_pat => *re_from_str*
Filter processes using regex against their pid.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* 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_vivaldi
Usage:
ps_vivaldi(%args) -> [$status_code, $reason, $payload, \%result_meta]
List Vivaldi processes.
This function is not exported.
Arguments ('*' denotes required arguments):
* cmndline_pat => *re_from_str*
Filter processes using regex against their cmndline.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* exec_pat => *re_from_str*
Filter processes using regex against their exec.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* fname_pat => *re_from_str*
Filter processes using regex against their fname.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* pid_pat => *re_from_str*
Filter processes using regex against their pid.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* 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_vivaldi
Usage:
restart_vivaldi(%args) -> [$status_code, $reason, $payload, \%result_meta]
Restart Vivaldi.
This function is not exported.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
* quiet => *true*
(No description)
* vivaldi_cmd => *array[str]|str* (default: "vivaldi")
(No description)
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_vivaldi
Usage:
start_vivaldi(%args) -> [$status_code, $reason, $payload, \%result_meta]
Start Vivaldi if not already started.
This function is not exported.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
* quiet => *true*
(No description)
* vivaldi_cmd => *array[str]|str* (default: "vivaldi")
(No description)
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_vivaldi
Usage:
terminate_vivaldi(%args) -> [$status_code, $reason, $payload, \%result_meta]
Terminate (kill -KILL) Vivaldi.
This function is not exported.
Arguments ('*' denotes required arguments):
* cmndline_pat => *re_from_str*
Filter processes using regex against their cmndline.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* exec_pat => *re_from_str*
Filter processes using regex against their exec.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* fname_pat => *re_from_str*
Filter processes using regex against their fname.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* pid_pat => *re_from_str*
Filter processes using regex against their pid.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* signal => *unix::signal*
(No description)
* 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_vivaldi
Usage:
unpause_vivaldi(%args) -> [$status_code, $reason, $payload, \%result_meta]
Unpause (resume, continue, kill -CONT) Vivaldi.
This function is not exported.
Arguments ('*' denotes required arguments):
* cmndline_pat => *re_from_str*
Filter processes using regex against their cmndline.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* exec_pat => *re_from_str*
Filter processes using regex against their exec.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* fname_pat => *re_from_str*
Filter processes using regex against their fname.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* pid_pat => *re_from_str*
Filter processes using regex against their pid.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* 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)
vivaldi_has_processes
Usage:
vivaldi_has_processes(%args) -> [$status_code, $reason, $payload, \%result_meta]
Check whether Vivaldi has processes.
This function is not exported.
Arguments ('*' denotes required arguments):
* cmndline_pat => *re_from_str*
Filter processes using regex against their cmndline.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* exec_pat => *re_from_str*
Filter processes using regex against their exec.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* fname_pat => *re_from_str*
Filter processes using regex against their fname.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* pid_pat => *re_from_str*
Filter processes using regex against their pid.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* quiet => *true*
(No description)
* 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)
vivaldi_is_paused
Usage:
vivaldi_is_paused(%args) -> [$status_code, $reason, $payload, \%result_meta]
Check whether Vivaldi is paused.
Vivaldi is defined as paused if *all* of its processes are in 'stop'
state.
This function is not exported.
Arguments ('*' denotes required arguments):
* cmndline_pat => *re_from_str*
Filter processes using regex against their cmndline.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* exec_pat => *re_from_str*
Filter processes using regex against their exec.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* fname_pat => *re_from_str*
Filter processes using regex against their fname.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* pid_pat => *re_from_str*
Filter processes using regex against their pid.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* quiet => *true*
(No description)
* 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)
vivaldi_is_running
Usage:
vivaldi_is_running(%args) -> [$status_code, $reason, $payload, \%result_meta]
Check whether Vivaldi is running.
Vivaldi is defined as running if there are some Vivaldi processes that
are *not* in 'stop' state. In other words, if Vivaldi has been started
but is currently paused, we do not say that it's running. If you want to
check if Vivaldi process exists, you can use "ps_vivaldi".
This function is not exported.
Arguments ('*' denotes required arguments):
* cmndline_pat => *re_from_str*
Filter processes using regex against their cmndline.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* exec_pat => *re_from_str*
Filter processes using regex against their exec.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* fname_pat => *re_from_str*
Filter processes using regex against their fname.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* pid_pat => *re_from_str*
Filter processes using regex against their pid.
If one of the "*-pat" options are specified, then instead of the
default heuristic rules to find the browser processes, these "*-pat"
options are solely used to determine which processes are the browser
processes.
* quiet => *true*
(No description)
* 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
SOURCE
Source repository is at
SEE ALSO
Some other CLI utilities related to Vivaldi: dump-vivaldi-history (from
App::DumpVivaldiHistory).
App::BraveUtils
App::OperaUtils
App::FirefoxUtils
App::OperaUtils
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) 2023, 2022, 2020, 2019 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
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.