view release on metacpan or  search on metacpan

lib/App/VivaldiUtils.pm  view on Meta::CPAN

__END__

=pod

=encoding UTF-8

=head1 NAME

App::VivaldiUtils - Utilities related to the Vivaldi browser

=head1 VERSION

This document describes version 0.011 of App::VivaldiUtils (from Perl distribution App-VivaldiUtils), released on 2023-10-28.

=head1 SYNOPSIS

=head1 DESCRIPTION

This distribution includes several utilities related to the Vivaldi browser:

=over

=item 1. L<kill-vivaldi>

=item 2. L<list-vivaldi-profiles>

=item 3. L<pause-vivaldi>

=item 4. L<ps-vivaldi>

=item 5. L<restart-vivaldi>

=item 6. L<start-vivaldi>

=item 7. L<terminate-vivaldi>

=item 8. L<unpause-vivaldi>

=item 9. L<vivaldi-has-processes>

=item 10. L<vivaldi-is-paused>

=item 11. L<vivaldi-is-running>

=back

=head1 FUNCTIONS


=head2 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):

=over 4

=item * B<cmndline_pat> => I<re_from_str>

Filter processes using regex against their cmndline.

If one of the C<*-pat> options are specified, then instead of the default
heuristic rules to find the browser processes, these C<*-pat> options are solely
used to determine which processes are the browser processes.

=item * B<exec_pat> => I<re_from_str>

Filter processes using regex against their exec.

If one of the C<*-pat> options are specified, then instead of the default
heuristic rules to find the browser processes, these C<*-pat> options are solely
used to determine which processes are the browser processes.

=item * B<fname_pat> => I<re_from_str>

Filter processes using regex against their fname.

If one of the C<*-pat> options are specified, then instead of the default
heuristic rules to find the browser processes, these C<*-pat> options are solely
used to determine which processes are the browser processes.

=item * B<pid_pat> => I<re_from_str>

Filter processes using regex against their pid.

If one of the C<*-pat> options are specified, then instead of the default
heuristic rules to find the browser processes, these C<*-pat> options are solely
used to determine which processes are the browser processes.

=item * B<users> => I<array[unix::uid::exists]>

Kill browser processes that belong to certain user(s) only.


=back

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.