list-border-style-modules - List BorderStyle modules
This document describes version 0.015 of list-border-style-modules (from Perl distribution App-BorderStyleUtils), released on 2022-01-27.
Usage:
% list-border-style-modules [--debug|--log-level=level|--quiet|--trace|--verbose] [--detail|-l|--no-detail|--nodetail] [--format=name|--json] [--(no)naked-res] [--page-result[=program]|--view-result[=program]]
* marks required options.
*
Currently does not do anything yet.
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Choose output format, e.g. json, text.
Default value:
undef
Set output format to json.
When outputing as JSON, strip result envelope.
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]
Filter output through a pager.
View output using a viewer.
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C list-border-style-modules list-border-style-modules
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.
To activate tcsh completion for this script, put:
complete list-border-style-modules 'p/*/`list-border-style-modules`/'
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).
For fish and zsh, install shcompgen as described above.
List style names:
% list-border-style-modules ASCII::None ASCII::SingleLine ASCII::SingleLineDoubleAfterHeader ASCII::SingleLineHorizontalOnly ASCII::SingleLineInnerOnly ASCII::SingleLineOuterOnly ASCII::SingleLineVerticalOnly ASCII::Space ASCII::SpaceInnerOnly BoxChar::None BoxChar::SingleLine BoxChar::SingleLineHorizontalOnly BoxChar::SingleLineInnerOnly BoxChar::SingleLineOuterOnly BoxChar::SingleLineVerticalOnly BoxChar::Space BoxChar::SpaceInnerOnly Test::CustomChar Test::Labeled Test::Random Text::ANSITable::OldCompat::Default::bold Text::ANSITable::OldCompat::Default::brick Text::ANSITable::OldCompat::Default::bricko Text::ANSITable::OldCompat::Default::csingle Text::ANSITable::OldCompat::Default::double Text::ANSITable::OldCompat::Default::none_ascii Text::ANSITable::OldCompat::Default::none_boxchar Text::ANSITable::OldCompat::Default::none_utf8 Text::ANSITable::OldCompat::Default::single_ascii Text::ANSITable::OldCompat::Default::single_boxchar Text::ANSITable::OldCompat::Default::single_utf8 Text::ANSITable::OldCompat::Default::singleh_ascii Text::ANSITable::OldCompat::Default::singleh_boxchar Text::ANSITable::OldCompat::Default::singleh_utf8 Text::ANSITable::OldCompat::Default::singlei_ascii Text::ANSITable::OldCompat::Default::singlei_boxchar Text::ANSITable::OldCompat::Default::singlei_utf8 Text::ANSITable::OldCompat::Default::singleo_ascii Text::ANSITable::OldCompat::Default::singleo_boxchar Text::ANSITable::OldCompat::Default::singleo_utf8 Text::ANSITable::OldCompat::Default::singlev_ascii Text::ANSITable::OldCompat::Default::singlev_boxchar Text::ANSITable::OldCompat::Default::singlev_utf8 Text::ANSITable::OldCompat::Default::space_ascii Text::ANSITable::OldCompat::Default::space_boxchar Text::ANSITable::OldCompat::Default::space_utf8 Text::ANSITable::OldCompat::Default::spacei_ascii Text::ANSITable::OldCompat::Default::spacei_boxchar Text::ANSITable::OldCompat::Default::spacei_utf8 UTF8::Brick UTF8::BrickOuterOnly UTF8::DoubleLine UTF8::None UTF8::SingleLine UTF8::SingleLineBold UTF8::SingleLineBoldHeader UTF8::SingleLineCurved UTF8::SingleLineDoubleAfterHeader UTF8::SingleLineHorizontalOnly UTF8::SingleLineInnerOnly UTF8::SingleLineOuterOnly UTF8::SingleLineVerticalOnly UTF8::Space UTF8::SpaceInnerOnly
Please visit the project's homepage at https://metacpan.org/release/App-BorderStyleUtils.
Source repository is at https://github.com/perlancar/perl-App-BorderStyleUtils.
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2021 by perlancar <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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-BorderStyleUtils
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.
To install App::BorderStyleUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::BorderStyleUtils
CPAN shell
perl -MCPAN -e shell install App::BorderStyleUtils
For more information on module installation, please visit the detailed CPAN module installation guide.