/ 
App-PDRUtils-0.122
River stage one • 2 direct dependents • 3 total dependents
/ pdrutil

NAME

pdrutil - Collection of utilities for perl dist repos

VERSION

This document describes version 0.122 of pdrutil (from Perl distribution App-PDRUtils), released on 2021-05-25.

SYNOPSIS

Usage:

% pdrutil add-prereq [--config-path=path | -c] [--config-profile=profile |
    -P] [--debug] [--format=name] [--json] [--log-level=level]
    [--(no)naked-res] [--no-config | -C] [--no-env]
    [--page-result[=program]] [--phase=s] [--quiet] [--rel=s] [--trace]
    [--verbose] [--view-result[=program]] <module> [module_version]
% pdrutil dec-prereq-version-by [--config-path=path | -c]
    [--config-profile=profile | -P] [--debug] [--format=name] [--json]
    [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
    [--page-result[=program]] [--quiet] [--trace] [--verbose]
    [--view-result[=program]] <module> <by>
% pdrutil dec-prereq-version-to [--config-path=path | -c]
    [--config-profile=profile | -P] [--debug] [--format=name] [--json]
    [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
    [--page-result[=program]] [--quiet] [--trace] [--verbose]
    [--view-result[=program]] <module> <module_version>
% pdrutil inc-prereq-version-by [--config-path=path | -c]
    [--config-profile=profile | -P] [--debug] [--format=name] [--json]
    [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
    [--page-result[=program]] [--quiet] [--trace] [--verbose]
    [--view-result[=program]] <module> <by>
% pdrutil inc-prereq-version-to [--config-path=path | -c]
    [--config-profile=profile | -P] [--debug] [--format=name] [--json]
    [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
    [--page-result[=program]] [--quiet] [--trace] [--verbose]
    [--view-result[=program]] <module> <module_version>
% pdrutil list-prereqs [--config-path=path | -c] [--config-profile=profile
    | -P] [--debug] [--detail] [--format=name] [--json] [-l]
    [--log-level=level] [--module=s] [--(no)naked-res] [--no-config | -C]
    [--no-detail] [--no-env] [--nodetail] [--page-result[=program]]
    [--phase=s] [--quiet] [--rel=s] [--trace] [--verbose]
    [--view-result[=program]]
% pdrutil remove-prereq [--config-path=path | -c]
    [--config-profile=profile | -P] [--debug] [--format=name] [--json]
    [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
    [--page-result[=program]] [--quiet] [--trace] [--verbose]
    [--view-result[=program]] <module>
% pdrutil set-prereq-version-to [--config-path=path | -c]
    [--config-profile=profile | -P] [--debug] [--format=name] [--json]
    [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
    [--page-result[=program]] [--quiet] [--trace] [--verbose]
    [--view-result[=program]] <module> <module_version>
% pdrutil sort-prereqs [--config-path=path | -c] [--config-profile=profile
    | -P] [--debug] [--format=name] [--json] [--log-level=level]
    [--(no)naked-res] [--no-config | -C] [--no-env]
    [--page-result[=program]] [--quiet] [--spacing=s] [--trace]
    [--verbose] [--view-result[=program]]

DESCRIPTION

This utility operates on a single Perl distribution repository.

SUBCOMMANDS

add-prereq

Add a prereq.

dec-prereq-version-by

Decrease prereq version by a certain decrement.

dec-prereq-version-to

Decrease prereq version to a specified version.

inc-prereq-version-by

Increase prereq version by a certain increment.

inc-prereq-version-to

Increase prereq version to a specified version.

list-prereqs

List prereqs from `[Prereqs/*]` sections.

This command list prerequisites found in [Prereqs/*] sections in your dist.ini.

remove-prereq

Add a prereq.

set-prereq-version-to

Set prereq version to a specified version.

sort-prereqs

Sort lines in `[Prereqs/*]` sections.

This command can sort [Prereqs/*] sections in your dist.ini according to this rule (TODO: allow customized rule): perl comes first, then pragmas sorted ascibetically and case-insensitively (e.g. strict, utf8, warnings), then other modules sorted ascibetically and case-insensitively.

Can detect one-spacing or two-spacing. Detects directives and comments.

OPTIONS

* marks required options.

Common options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

Set configuration profile to use.

--debug

Shortcut for --log-level=debug.

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--help, -h, -?

Display help message and exit.

--json

Set output format to json.

--log-level=s

Set log level.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--no-config, -C

Do not use any configuration file.

--no-env

Do not read environment for default options.

--page-result

Filter output through a pager.

--quiet

Shortcut for --log-level=error.

--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

--view-result

View output using a viewer.

Options for subcommand add-prereq

--module-version=s

Default value:

0

Can also be specified as the 2nd command-line argument.

--module=s*

Can also be specified as the 1st command-line argument.

--phase=s

Select prereq phase.

Default value:

"runtime"
--rel=s

Select prereq relationship.

Default value:

"requires"

Options for subcommand dec-prereq-version-by

--by=s*

Can also be specified as the 2nd command-line argument.

--module=s*

Can also be specified as the 1st command-line argument.

Options for subcommand dec-prereq-version-to

--module-version=s*

Can also be specified as the 2nd command-line argument.

--module=s*

Can also be specified as the 1st command-line argument.

Options for subcommand inc-prereq-version-by

--by=s*

Can also be specified as the 2nd command-line argument.

--module=s*

Can also be specified as the 1st command-line argument.

Options for subcommand inc-prereq-version-to

--module-version=s*

Can also be specified as the 2nd command-line argument.

--module=s*

Can also be specified as the 1st command-line argument.

Options for subcommand list-prereqs

--detail, -l
--module=s

Module name.

--phase=s

Valid values:

["configure","build","test","runtime","develop"]
--rel=s

Valid values:

["requires","recommends","suggests","conflicts"]

Options for subcommand remove-prereq

--module=s*

Can also be specified as the 1st command-line argument.

Options for subcommand set-prereq-version-to

--module-version=s*

Can also be specified as the 2nd command-line argument.

--module=s*

Can also be specified as the 1st command-line argument.

Options for subcommand sort-prereqs

--spacing=s

Set spacing explicitly.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C pdrutil pdrutil

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete pdrutil 'p/*/`pdrutil`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/pdrutil.conf, ~/pdrutil.conf, or /etc/pdrutil.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

[plugin=DumpArgs]
-event=before_validate_args
-prio=99

[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

Common for all subcommands

format (see --format)
log_level (see --log-level)
naked_res (see --naked-res)

Configuration for subcommand add-prereq

module (see --module)
module_version (see --module-version)
phase (see --phase)
rel (see --rel)

Configuration for subcommand dec-prereq-version-by

by (see --by)
module (see --module)

Configuration for subcommand dec-prereq-version-to

module (see --module)
module_version (see --module-version)

Configuration for subcommand inc-prereq-version-by

by (see --by)
module (see --module)

Configuration for subcommand inc-prereq-version-to

module (see --module)
module_version (see --module-version)

Configuration for subcommand list-prereqs

detail (see --detail)
module (see --module)
phase (see --phase)
rel (see --rel)

Configuration for subcommand remove-prereq

module (see --module)

Configuration for subcommand set-prereq-version-to

module (see --module)
module_version (see --module-version)

Configuration for subcommand sort-prereqs

spacing (see --spacing)

ENVIRONMENT

PDRUTIL_OPT => str

Specify additional command-line options.

FILES

~/.config/pdrutil.conf

~/pdrutil.conf

/etc/pdrutil.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-PDRUtils.

SOURCE

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

BUGS

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

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

pdrutil-multi which operates on several Perl distribution repositories at once.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2019, 2018, 2017, 2016 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.