/ 
App-ansifold-1.01
River stage zero No dependents
/ ansifold

NAME

ansifold - fold command handling ANSI terminal sequences

SYNOPSIS

ansifold [ options ]

-w#, --width=#                Folding width (default 70)
     --boundary=word          Fold on word boundary
     --padding                Padding to margin space
     --padchar=_              Padding character
     --ambiguous=narrow|wide  Unicode ambiguous character handling
-p,  --paragraph              Print extra newline
     --separate=string        Set separator string (default newline)
-n                            Short cut for --separate ''
     --linebreak=mode         Line-break adjustment rule (default all)
     --runin                  Run-in width (default 4)
     --runout                 Run-out width (default 4)
-s,  --smart                  Short cut for --boundary=word --linebreak=all

DESCRIPTION

ansifold is almost fold compatible command utilizing Text::ANSI::Fold module, which enables to handle ANSI terminal sequences and Unicode multibyte characters properly.

It folds lines in 70 column by default. Use option -w to change the folding width.

$ ansifold -w132

Unlike original fold(1) command, multiple numbers can be specified like:

$ LANG=C date | ansifold -w 3,1,3,1,2 | cat -n
     1  Wed
     2   
     3  Dec
     4   
     5  19

Negative number fields are discarded.

$ LANG=C date | ansifold -w 3,-1,3,-1,2
Wed
Dec
19

Option -n (or --separate '') eliminates newlines between columns.

$ LANG=C date | ansifold -w 3,-1,3,-1,2 -n
WedDec19

Single field is used repeatedly for the same line, but multiple fields are not. Put comma at the end of single field to discard the rest:

ansifold -w 80,

Number description is handled by Getopt::EX::Numbers module, and consists of start, end, step and length elements. For example,

$ echo AABBBBCCCCCCDDDDDDDDEEEEEEEEEE | ansifold -w 2:10:2

is equivalent to:

$ echo AABBBBCCCCCCDDDDDDDDEEEEEEEEEE | ansifold -w 2,4,6,8,10

and produces output like this:

AA
BBBB
CCCCCC
DDDDDDDD
EEEEEEEEEE

LINE BREAKING

Option --boundary=word prohibit to break line within alphanumeric word. This version supports line break adjustment, mainly to perform Japanese ``KINSOKU'' processing. Use --linebreak=all to enable it.

When --linebreak option is enabled, if the cut-off text start with space or prohibited characters (e.g. closing parenthesis), they are ran-in at the end of current line as much as possible.

If the trimmed text end with prohibited characters (e.g. opening parenthesis), they are ran-out to the head of next line, provided it fits to maximum width.

Option --linebreak takes a value of all, runin, runout or none. Default value is none.

Maximum width of run-in/run-out characters are defined by --runin and --runout option. Default values are 4.

Option --smart (or simply -s) is shortcut for "--boundary=word --linebreak=all" and enables all smart text formatting capability.

SEE ALSO

github

github

Getopt::EX::Numbers

https://www.w3.org/TR/2009/NOTE-jlreq-20090604/, Requirements for Japanese Text Layout, W3C Working Group Note 4 June 2009

LICENSE

Copyright (C) 2018- Kazumasa Utashiro

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

AUTHOR

Kazumasa Utashiro