Steven Haryanto

NAME

Data::Unixish::linum - Add line numbers

VERSION

version 1.41

SYNOPSIS

In Perl:

 use Data::Unixish qw(aduxa);
 my @res = aduxa('linum', "a", "b ", "c\nd ", undef, ["e"]);
 # => ("   1|a", "   2| b", "   3c|\n   4|d ", undef, ["e"])

In command line:

 % echo -e "a\nb\n \nd" | dux linum
    1|a
    2|b
     |
    4|d

SEE ALSO

lins, rins

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.

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

Arguments ('*' denotes required arguments):

  • blank_empty_lines => bool (default: 1)

    Example when set to false:

        1|use Foo::Bar;
        2|
        3|sub blah {
        4|    my %args = @_;

    Example when set to true:

        1|use Foo::Bar;
         |
        3|sub blah {
        4|    my %args = @_;
  • format => str (default: "%4s|")

    Sprintf-style format to use.

    Example: %04d|.

  • in => any

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

  • out => any

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

  • start => int (default: 1)

    Number to start from.

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.