From dc3f4060619d9e8d9003fababa5db02949fbbf90 Mon Sep 17 00:00:00 2001 From: hniksic Date: Fri, 23 Nov 2001 09:04:26 -0800 Subject: [PATCH] [svn] Download the new `--progress' option. --- doc/ChangeLog | 5 +++++ doc/wget.texi | 54 ++++++++++++++++++++++++++++----------------------- 2 files changed, 35 insertions(+), 24 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 7a954325..901aa4b4 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2001-11-23 Hrvoje Niksic + + * wget.texi (Download Options): Document the new `--progress' + option. + 2001-11-22 Hrvoje Niksic * wget.texi (Proxies): Fix typo. diff --git a/doc/wget.texi b/doc/wget.texi index 9bbefa72..7419c0d1 100644 --- a/doc/wget.texi +++ b/doc/wget.texi @@ -15,8 +15,8 @@ @end iftex @c This should really be auto-generated! -@set VERSION 1.7.1 -@set UPDATED June 2001 +@set VERSION 1.8-dev +@set UPDATED November 2001 @dircategory Net Utilities @dircategory World Wide Web @@ -611,26 +611,31 @@ Another instance where you'll get a garbled file if you try to use Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http} servers that support the @code{Range} header. +@cindex progress indicator @cindex dot style -@cindex retrieval tracing style -@item --dot-style=@var{style} -Set the retrieval style to @var{style}. Wget traces the retrieval of -each document by printing dots on the screen, each dot representing a -fixed amount of retrieved data. Any number of dots may be separated in -a @dfn{cluster}, to make counting easier. This option allows you to -choose one of the pre-defined styles, determining the number of bytes -represented by a dot, the number of dots in a cluster, and the number of -dots on the line. - -With the @code{default} style each dot represents 1K, there are ten dots -in a cluster and 50 dots in a line. The @code{binary} style has a more -``computer''-like orientation---8K dots, 16-dots clusters and 48 dots -per line (which makes for 384K lines). The @code{mega} style is -suitable for downloading very large files---each dot represents 64K -retrieved, there are eight dots in a cluster, and 48 dots on each line -(so each line contains 3M). The @code{micro} style is exactly the -reverse; it is suitable for downloading small files, with 128-byte dots, -8 dots per cluster, and 48 dots (6K) per line. +@item --progress=@var{type} +Select the type of the progress indicator you wish to use. Legal +indicators are ``dot'' and ``bar''. + +The ``dot'' indicator is used by default. It traces the retrieval by +printing dots on the screen, each dot representing a fixed amount of +downloaded data. + +When using the dotted retrieval, you may also set the @dfn{style} by +specifying the type as @samp{dot:@var{style}}. Different styles assign +different meaning to one dot. With the @code{default} style each dot +represents 1K, there are ten dots in a cluster and 50 dots in a line. +The @code{binary} style has a more ``computer''-like orientation---8K +dots, 16-dots clusters and 48 dots per line (which makes for 384K +lines). The @code{mega} style is suitable for downloading very large +files---each dot represents 64K retrieved, there are eight dots in a +cluster, and 48 dots on each line (so each line contains 3M). + +Specifying @samp{--progress=bar} will draw a nice ASCII progress bar +graphics (a.k.a ``thermometer'' display) to indicate retrieval. If the +output is not a TTY, this option will be ignored, and Wget will revert +to the dot indicator. If you want to force the bar indicator, use +@samp{--progress=bar:force}. @item -N @itemx --timestamping @@ -1977,9 +1982,6 @@ the retrieval (50 by default). @item dot_spacing = @var{n} Specify the number of dots in a single cluster (10 by default). -@item dot_style = @var{string} -Specify the dot retrieval @dfn{style}, as with @samp{--dot-style}. - @item exclude_directories = @var{string} Specify a comma-separated list of directories you wish to exclude from download---the same as @samp{-X} (@pxref{Directory-Based Limits}). @@ -2085,6 +2087,10 @@ and @samp{.pm} (Perl module) files download files using @samp{wget Set your @sc{ftp} password to @var{password}. Without this setting, the password defaults to @samp{username@@hostname.domainname}. +@item progress = @var{string} +Set the type of the progress indicator. Legal types are ``dot'' and +``bar''. + @item proxy_user = @var{string} Set proxy authentication user name to @var{string}, like @samp{--proxy-user}. -- 2.39.2