Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Text::Truncate(3)     User Contributed Perl Documentation    Text::Truncate(3)

NAME
       Text::Truncate -	Perl module with simple	string truncating routine.

SYNOPSIS
	 use Text::Truncate;

	 my $long_string = "This is a very long	string";

	 # outputs "This is..."
	 print truncstr( $long_string, 10);

	 # outputs "This is a-"
	 print truncstr( $long_string, 10, "-");

	 # outputs "This is a "
	 print truncstr( $long_string, 10, "");

	 # outputs "This is---"
	 $Text::Truncate::DEFAULT_MARKER = "---";
	 print truncstr( $long_string, 10);

DESCRIPTION
       This is a simple, no-brainer subroutine to truncate a string and	add an
       optional	cutoff marker (defaults	to ``...'').

       (Yes, this is a really brain-dead sort of thing to make a module	out
       of, but then again, I use it so often that it might as well be in a
       module.)

       The synopsis gives examples of how to use it.

   EXPORT
       The following functions are exported:

       truncstr
	     $rstring =	truncstr( $istring, $cutoff_length );

	     $rstring =	truncstr( $istring, $cutoff_length, $continued_symbol );

	   If the $istring is longer than the $cutoff_length, then the string
	   will	be truncated to	$cutoff_length characters, including the
	   $continued_symbol (which defaults to	``...''	if none	is specified).

	   The default $continued_symbol can be	changed	in
	   $Text::Truncate::DEFAULT_MARKER.

SEE ALSO
	L<String::Truncate>, L<Text::Elide>

REPOSITORY
	https://github.com/ileiva/Text-Truncate

AUTHOR
       Robert Rothenberg <rrwo at cpan.org> This is now	being mantained	by
       Israel Leiva <ilv@cpan.org>

LICENSE
       Unrestricted. This module is in the public domain. No copyright is
       claimed.

perl v5.32.1			  2014-02-25		     Text::Truncate(3)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | REPOSITORY | AUTHOR | LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Text::Truncate&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help