NAME
App::FirefoxUtils - Utilities related to Firefox
VERSION
This document describes version 0.014 of App::FirefoxUtils (from Perl distribution App-FirefoxUtils), released on 2020-07-19.
SYNOPSIS
DESCRIPTION
This distribution includes several utilities related to Firefox:
FUNCTIONS
firefox_has_processes
Usage:
firefox_has_processes(%args) -> [status, msg, payload, meta]Check whether Firefox has processes.
This function is not exported.
Arguments ('*' denotes required arguments):
quiet => true
users => array[unix::local_uid]
Kill browser processes that belong to certain user(s) only.
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)
firefox_is_paused
Usage:
firefox_is_paused(%args) -> [status, msg, payload, meta]Check whether Firefox is paused.
Firefox 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::local_uid]
Kill browser processes that belong to certain user(s) only.
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)
firefox_is_running
Usage:
firefox_is_running(%args) -> [status, msg, payload, meta]Check whether Firefox is running.
Firefox is defined as running if there are some Firefox processes that are not in 'stop' state. In other words, if Firefox has been started but is currently paused, we do not say that it's running. If you want to check if Firefox process exists, you can use ps_firefox.
This function is not exported.
Arguments ('*' denotes required arguments):
quiet => true
users => array[unix::local_uid]
Kill browser processes that belong to certain user(s) only.
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)
pause_firefox
Usage:
pause_firefox(%args) -> [status, msg, payload, meta]Pause (kill -STOP) Firefox.
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. Stopping (kill -STOP) the browser processes is a simple and effective way to stop CPU eating on Unix. 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 it.
This function is not exported.
Arguments ('*' denotes required arguments):
users => array[unix::local_uid]
Kill browser processes that belong to certain user(s) only.
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)
ps_firefox
Usage:
ps_firefox(%args) -> [status, msg, payload, meta]List Firefox processes.
This function is not exported.
Arguments ('*' denotes required arguments):
users => array[unix::local_uid]
Kill browser processes that belong to certain user(s) only.
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)
restart_firefox
Usage:
restart_firefox(%args) -> [status, msg, payload, meta]Restart firefox.
This function is not exported.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
firefox_cmd => array[str]|str (default: "firefox")
quiet => true
Special arguments:
-dry_run => bool
Pass -dry_run=>1 to enable simulation mode.
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)
start_firefox
Usage:
start_firefox(%args) -> [status, msg, payload, meta]Start firefox if not already started.
This function is not exported.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
firefox_cmd => array[str]|str (default: "firefox")
quiet => true
Special arguments:
-dry_run => bool
Pass -dry_run=>1 to enable simulation mode.
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)
terminate_firefox
Usage:
terminate_firefox(%args) -> [status, msg, payload, meta]Terminate (kill -KILL) Firefox.
This function is not exported.
Arguments ('*' denotes required arguments):
users => array[unix::local_uid]
Kill browser processes that belong to certain user(s) only.
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)
unpause_firefox
Usage:
unpause_firefox(%args) -> [status, msg, payload, meta]Unpause (resume, continue, kill -CONT) Firefox.
This function is not exported.
Arguments ('*' denotes required arguments):
users => array[unix::local_uid]
Kill browser processes that belong to certain user(s) only.
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-FirefoxUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-FirefoxUtils.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-FirefoxUtils
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.
SEE ALSO
Some other CLI utilities related to Firefox: dump-firefox-history (from App::DumpFirefoxHistory), App::FirefoxMultiAccountContainersUtils.
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.