NAME
    App::FirefoxUtils - Utilities related to Firefox

VERSION
    This document describes version 0.004 of App::FirefoxUtils (from Perl
    distribution App-FirefoxUtils), released on 2019-11-29.

SYNOPSIS
DESCRIPTION
    This distribution includes several utilities related to Firefox:

    *   firefox-is-paused

    *   kill-firefox

    *   pause-firefox

    *   ps-firefox

    *   terminate-firefox

    *   unpause-firefox

FUNCTIONS
  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 Firefox processes of certain users 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.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   users => *array[unix::local_uid]*

        Kill Firefox processes of certain users 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 Firefox processes of certain users 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)

  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 Firefox processes of certain users 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 Firefox processes of certain users 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::ChromeUtils

    App::OperaUtils

AUTHOR
    perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 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.

