• NAME
• VERSION
• FUNCTIONS
  • indent($indent, $str, \%opts) => STR
• SEE ALSO
• HOMEPAGE
• SOURCE
• BUGS
• AUTHOR
• COPYRIGHT AND LICENSE

NAME

String::Indent - String indenting routines

VERSION

This document describes version 0.03 of String::Indent (from Perl distribution String-Indent), released on 2015-03-06.

FUNCTIONS

indent($indent, $str, \%opts) => STR

Indent every line in $str with $indent. Example:

 indent('  ', "one\ntwo\nthree") # "  one\n  two\n  three"

%opts is optional. Known options:

• indent_blank_lines => bool (default: 1)

  If set to false, does not indent blank lines (i.e., lines containing only zero or more whitespaces).

• first_line_indent => str

  If set, then the first line will be set to this instead of the normal indent.

• subsequent_lines_indent => str

  If set, then all lines but the first line will be set to this instead of the normal indent.

SEE ALSO

Indent::String, String::Nudge

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-String-Indent.

BUGS

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

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

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by perlancar@cpan.org.

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