NAME

indent - Indent text

VERSION

This document describes version 0.002 of indent (from Perl distribution App-indent), released on 2024-01-25.

SYNOPSIS

indent [OPTION]... [FILE]...

DESCRIPTION

This is a simple utility to indent lines of text. By default it indents lines with four spaces. You can specity a different indent characters:

% someprog ... | indent -i "xxxx"

You can set a different indent for first line (-f), first line of paragraph (-p), and subsequent lines (-s). Finally, you can also opt to not indent blank lines. Here's an example with how the resulting text might look like:

% someprog ... | indent -i "iiii" -f "ffff" -p "pppp" -s "ssss" -B

ffffThis is the first line of text.
ssssThis is the second line. The following will be a blank line.

ppppThis is the start of the second paragraph.

ppppThe third paragraph.
ssssSecond line of third paragraph.
ssssThird of third.

EXIT CODES

0 on success.

99 on command-line options error.

OPTIONS

  • --first-line, -f

    Give a different indent for first line.

  • --first-line-of-para, -p

    Give a different indent for first line of each paragrah. Paragraphs are separated by blank lines.

  • --subsequent-lines, -s

    Give a different indent for subsequent lines.

  • --no-indent-blank-lines, -B

    Do not indent blank lines.

FAQ

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-App-indent.

SEE ALSO

Somewhat related: textwrap et al from App::TextWrapUtils

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-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.