/ 
Data-Unixish-1.44
River stage two • 9 direct dependents • 49 total dependents
/ Data::Unixish::wrap

NAME

Data::Unixish::wrap - Wrap text

VERSION

version 1.44

RELEASE DATE

2014-04-24

SYNOPSIS

In Perl:

use Data::Unixish qw(lduxl);
$wrapped = lduxl([wrap => {width=>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

FUNCTIONS

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

Wrap text.

Arguments ('*' denotes required arguments):

  • ansi => bool (default: 0)

    Whether to handle ANSI escape codes.

  • in => any

    Input stream (e.g. array or filehandle).

  • mb => bool (default: 0)

    Whether to handle wide characters.

  • out => any

    Output stream (e.g. array or filehandle).

  • width => int (default: 80)

    Target column width.

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.

SEE ALSO

fmt(1)

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/sharyanto/perl-Data-Unixish.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Unixish

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.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 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.