NAME
list-weaver-roles - List installed Pod::Weaver roles
VERSION
This document describes version 0.05 of list-weaver-roles (from Perl distribution App-WeaverUtils), released on 2016-01-18.
SYNOPSIS
% list-weaver-rolesOPTIONS
* marks required options.
Configuration options
- --config-path=filename
-
Set path to configuration file.
Can be specified multiple times.
- --config-profile=s
-
Set configuration profile to use.
- --no-config
-
Do not use any configuration file.
Environment options
Output options
- --format=s
-
Choose output format, e.g. json, text.
Default value:
undef - --json
-
Set output format to json.
- --naked-res
-
When outputing as JSON, strip result envelope.
Default value:
0By 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]
Other options
COMPLETION
This script has shell tab completion capability with support for several shells.
bash
To activate bash completion for this script, put:
complete -C list-weaver-roles list-weaver-rolesin 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 shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.
tcsh
To activate tcsh completion for this script, put:
complete list-weaver-roles 'p/*/`list-weaver-roles`/'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 file, which by default is searched at ~/.config/list-weaver-roles.conf, ~/list-weaver-roles.conf or /etc/list-weaver-roles.conf (can be changed by specifying --config-path). All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
Configuration file is in the format of IOD, which is basically INI with some extra features.
You can put multiple profiles in a single file by using section names like [profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
List of available configuration parameters:
format (see --format)
naked_res (see --naked-res)ENVIRONMENT
LIST_WEAVER_ROLES_OPT => str
Specify additional command-line options
FILES
~/.config/list-weaver-roles.conf
~/list-weaver-roles.conf
/etc/list-weaver-roles.conf
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-WeaverUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-WeaverUtils.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-WeaverUtils
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) 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.