NAME

list-border-style-modules - List BorderStyle modules

VERSION

This document describes version 0.015 of list-border-style-modules (from Perl distribution App-BorderStyleUtils), released on 2022-01-27.

SYNOPSIS

Usage:

OPTIONS

* marks required options.

Main options

--detail, -l: Currently does not do anything yet.

Logging options

--debug: Shortcut for --log-level=debug.
--log-level=s: Set log level.
--quiet: Shortcut for --log-level=error.
--trace: Shortcut for --log-level=trace.
--verbose: Shortcut for --log-level=info.

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:

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]

--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?: Display help message and exit.
--version, -v: Display program's version and exit.

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-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.

tcsh

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).

other shells

For fish and zsh, install shcompgen as described above.

EXAMPLES

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

HOMEPAGE

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

SOURCE

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

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

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.

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

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.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)