Documentation tweaks to Text::Tabs
Gisle Aas [Sun, 18 Apr 2010 20:58:02 +0000 (22:58 +0200)]
cpan/Text-Tabs/lib/Text/Tabs.pm

index d3c06a0..49ec775 100644 (file)
@@ -95,12 +95,16 @@ Text::Tabs -- expand and unexpand tabs per the unix expand(1) and unexpand(1)
 
 =head1 SYNOPSIS
 
-  use Text::Tabs;
+  use Text::Tabs qw(expand unexpand);
 
-  $tabstop = 4;  # default = 8
   @lines_without_tabs = expand(@lines_with_tabs);
   @lines_with_tabs = unexpand(@lines_without_tabs);
 
+  {
+      local $Text::Tabs::tabstop = 4;  # default is 8
+      @lines_without_tabs = expand(@lines_with_tabs);
+  }
+
 =head1 DESCRIPTION
 
 Text::Tabs does about what the unix utilities expand(1) and unexpand(1) 
@@ -109,6 +113,12 @@ the appropriate number of spaces.  Given a line with or without tabs in
 it, unexpand will add tabs when it can save bytes by doing so (just
 like C<unexpand -a>).  Invisible compression with plain ASCII! 
 
+The global variable C<$Text::Tabs::tabstop> controls how many columns
+positions apart each tabstop are.  The default is 8.
+
+The functions expand(), unexpand() as well as the variable $tabstop
+are exported by default.
+
 =head1 EXAMPLE
 
   #!perl