NAME

App::instopt - Download and install software

VERSION

This document describes version 0.002 of App::instopt (from Perl distribution App-instopt), released on 2018-10-04.

SYNOPSIS

See instopt script.

FUNCTIONS

cleanup

Usage:

cleanup(%args) -> [status, msg, result, meta]

Remove inactive versions.

This function is not exported.

Arguments ('*' denotes required arguments):

  • download_dir => dirname

  • install_dir => dirname

  • program_dir => dirname

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

download

Usage:

download(%args) -> [status, msg, result, meta]

Download latest version of software.

This function is not exported.

Arguments ('*' denotes required arguments):

  • arch => software::arch

  • download_dir => dirname

  • install_dir => dirname

  • program_dir => dirname

  • software* => str

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

list_downloaded

Usage:

list_downloaded(%args) -> [status, msg, result, meta]

List all downloaded software.

This function is not exported.

Arguments ('*' denotes required arguments):

  • detail => bool

  • download_dir => dirname

  • install_dir => dirname

  • program_dir => dirname

  • software* => str

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

list_installed

Usage:

list_installed(%args) -> [status, msg, result, meta]

List all installed software.

This function is not exported.

Arguments ('*' denotes required arguments):

  • detail => true

  • download_dir => dirname

  • install_dir => dirname

  • program_dir => dirname

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

list_installed_versions

Usage:

list_installed_versions(%args) -> [status, msg, result, meta]

List all installed versions of a software.

This function is not exported.

Arguments ('*' denotes required arguments):

  • download_dir => dirname

  • install_dir => dirname

  • program_dir => dirname

  • software* => str

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

update

Usage:

update(%args) -> [status, msg, result, meta]

Update a software to the latest version.

This function is not exported.

Arguments ('*' denotes required arguments):

  • download_dir => dirname

  • install_dir => dirname

  • program_dir => dirname

  • software* => str

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

update_all

Usage:

update_all(%args) -> [status, msg, result, meta]

Update all installed software.

This function is not exported.

Arguments ('*' denotes required arguments):

  • download_dir => dirname

  • install_dir => dirname

  • program_dir => dirname

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 (result) 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-instopt.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-instopt.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-instopt

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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