Document the term_width argument to the constructor.
authorOvid <curtis_ovid_poe@yahoo.com>
Fri, 12 Jul 2013 10:48:37 +0000 (12:48 +0200)
committerOvid <curtis_ovid_poe@yahoo.com>
Fri, 12 Jul 2013 10:48:37 +0000 (12:48 +0200)
lib/Term/ProgressBar.pm

index 01a4bd2..eecbaa3 100644 (file)
@@ -358,6 +358,12 @@ The filehandle to output to.  Defaults to stderr.  Do not try to use
 *foo{THING} syntax if you want Term capabilities; it does not work.  Pass in a
 globref instead.
 
+=item term_width
+
+Sometimes we can't correctly determine the terminal width. You can use this
+parameter to force a term width of a particular size. Use a positive integer,
+please :)
+
 =item ETA
 
 A total time estimation to use.  If enabled, a time finished estimation is