The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Data::Unixish::wrap - Wrap text

VERSION

version 1.29

SYNOPSIS

In Perl:

 use Data::Unixish::List qw(dux);
 $wrapped = dux([wrap => {columns=>20}], "xxxx xxxx xxxx xxxx xxxx"); # "xxxx xxxx xxxx xxxx\nxxxx"

In command line:

 % echo -e "xxxx xxxx xxxx xxxx xxxx" | dux wrap -c 20
 xxxx xxxx xxxx xxxx
 xxxx

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Steven Haryanto.

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

DESCRIPTION

FUNCTIONS

None are exported by default, but they are exportable.

wrap(%args) -> [status, msg, result, meta]

Wrap text.

Currently implemented using Text::Wrap standard Perl module.

Arguments ('*' denotes required arguments):

  • ansi => bool (default: 0)

    Whether to handle ANSI escape codes.

  • columns => int (default: 80)

    Target column width.

  • in => any

  • mb => bool (default: 0)

    Whether to handle wide characters.

  • out => any

Return value:

Returns an enveloped result (an array). First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.