view release on metacpan or  search on metacpan

lib/App/cat/v.pod  view on Meta::CPAN

    cat-v --esc=s --repeat +esc

=item B<--repeat>=I<name>[,I<name>...]

Specifies the character type for outputting the original character at
the same time as the converted character.  The default setting is
C<nl,np>.  The following will correctly output the original ANSI
sequence with the escape character visualized.

    cat-v -c esc --repeat esc,nl

If I<name> begins with C<+>, add that character in addition to the
existing configuration.

    cat-v -c esc --repeat +esc

=item B<-o>, B<-oo>, B<--original>

If the converted string is different from the original string, the
original string is output before the converted string is output.  If
specified twice, the original string is always printed.

You can use this output with L<App::cdif>'s C<--line-by-line>
(C<--lxl>) option.

=item B<-t>[I<n>], B<--expand>[=I<n>]

=item B<-T>, B<--no-expand>

Tab characters are expanded by default.  To explicitly disable it, use
the B<-T> or B<--no-expand> option.

If an optional number is given for the B<-t> option, it is treated as
a tab width.  The following two commands are equivalent:

    cat-v -t4
    cat-v -t --tabstop=4

By default, the style C<needle> is applied, which can be changed with
C<--tabstyle>. If the C<--tabstyle> option is specified with no
arguments, a list of available styles is displayed.

You can disable tab expansion by default by putting the following
setting in your C<~/.cat-vrc> file.

    option default --no-expand

In such cases, tab expansion can be temporarily enabled by the C<-t>
option.

=item B<--tabstop>=# (DEFAULT: 8)

Set tab width.

=item B<--tabhead>=#

=item B<--tabspace>=#

Set tab head and following space characters.  If the option value is
longer than single character, it is evaluated as unicode name.

=item B<--tabstyle>, B<--ts>

=item B<--tabstyle>=I<style>, B<--ts>=...

=item B<--tabstyle>=I<head-style>,I<space-style> B<--ts>=...

Set the style how tab is expanded.  Select C<symbol> or C<shade> for
example.  If two style names are combined, like
C<squat-arrow,middle-dot>, use C<squat-arrow> for tabhead and
C<middle-dot> for tabspace.

Show available style list if called without parameter.  Styles are
defined in L<Text::ANSI::Fold> library.

=item B<-C>=I<color>, B<--color>=I<color>

Replaced characters are displayed in the color specified by the
I<color>.  This option is not suitable for output containing ANSI
color sequences.

=item B<-E>, B<--escape-backslash>

Convert backslash character to the escaped form C<\\>.

Although backslash is not a control character, this way the result of
converting other control characters to escape expressions can be fully
interpreted as string literal of various programming language.

The following command reproduces the complete contents of the original
file.

    echo -ne "$(cat-v -Ence FILE)"

=back

=head1 INSTALL

=head2 CPANMINUS

From CPAN archive:

    cpanm App::cat::v

From GIT repository:

    cpanm https://github.com/tecolicom/App-cat-v.git

=head1 SEE ALSO

=over 4

=item L<https://github.com/tecolicom/App-cat-v.git>

Git repository.

=item L<App::optex::util::filter>

The predecessor of the C<cat-v> command was originally created as the 
filter module of the L<App::optex> command.