.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "String::Trim::More 3pm"
.TH String::Trim::More 3pm "2020-12-29" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
String::Trim::More \- Various string trimming utilities
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.03 of String::Trim::More (from Perl distribution String-Trim-More), released on 2017\-01\-27.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is an alternative to String::Trim (and similar modules, see \*(L"\s-1SEE
ALSO\*(R"\s0). Instead of a single \f(CW\*(C`trim\*(C'\fR function, this module provides several from
which you can choose on, depending on your needs.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "ltrim($str) => \s-1STR\s0"
.IX Subsection "ltrim($str) => STR"
Trim whitespaces (including newlines) at the beginning of string. Equivalent to:
.PP
.Vb 1
\& $str =~ s/\eA\es+//s;
.Ve
.SS "ltrim_lines($str) => \s-1STR\s0"
.IX Subsection "ltrim_lines($str) => STR"
Trim whitespaces (not including newlines) at the beginning of each line of
string. Equivalent to:
.PP
.Vb 1
\& $str =~ s/^\es+//mg;
.Ve
.SS "rtrim($str) => \s-1STR\s0"
.IX Subsection "rtrim($str) => STR"
Trim whitespaces (including newlines) at the end of string. Equivalent to:
.PP
.Vb 1
\& $str =~ s/[ \et]+\ez//s;
.Ve
.SS "rtrim_lines($str) => \s-1STR\s0"
.IX Subsection "rtrim_lines($str) => STR"
Trim whitespaces (not including newlines) at the end of each line of
string. Equivalent to:
.PP
.Vb 1
\& $str =~ s/[ \et]+$//mg;
.Ve
.SS "trim($str) => \s-1STR\s0"
.IX Subsection "trim($str) => STR"
ltrim + rtrim.
.SS "trim_lines($str) => \s-1STR\s0"
.IX Subsection "trim_lines($str) => STR"
ltrim_lines + rtrim_lines.
.SS "trim_blank_lines($str) => \s-1STR\s0"
.IX Subsection "trim_blank_lines($str) => STR"
Trim blank lines at the beginning and the end. Won't trim blank lines in the
middle. Blank lines include lines with only whitespaces in them.
.ie n .SS "ellipsis($str[, $maxlen, $ellipsis]) => \s-1STR\s0"
.el .SS "ellipsis($str[, \f(CW$maxlen\fP, \f(CW$ellipsis\fP]) => \s-1STR\s0"
.IX Subsection "ellipsis($str[, $maxlen, $ellipsis]) => STR"
Return \f(CW$str\fR unmodified if \f(CW$str\fR's length is less than \f(CW$maxlen\fR (default 80).
Otherwise cut \f(CW$str\fR to ($maxlen \- length($ellipsis)) and append \f(CW$ellipsis\fR
(default '...') at the end.
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/String\-Trim\-More>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-String\-Trim\-More>.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=String\-Trim\-More>
.PP
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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For trim functions: String::Trim, Text::Trim, String::Strip,
String::Util.
.PP
For ellipsis/eliding: Text::Elide (elide at word boundaries),
String::Elide::Parts (elide with more options).
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017 by perlancar@cpan.org.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.