Document the term_width argument to the constructor.

[term-progressbar.git] / lib / Term / ProgressBar.pm

diff --git a/lib/Term/ProgressBar.pm b/lib/Term/ProgressBar.pm
index 01a4bd25171d0136bad4bc99fc0cddb36b062e01..eecbaa35daa6162c9cfd67875f871be5abc88fd6 100644 (file)
--- a/lib/Term/ProgressBar.pm
+++ b/lib/Term/ProgressBar.pm
@@ -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