wmget/wmget.1.in

   1 .TH "WMGET" 1 "February 2016" "@VERSION@"
   2 .SH NAME
   3 wmget \- Background download manager in a dockapp
   4 .SH "SYNOPSIS"
   5 .ad l
   6 .hy 0
   7 .HP 6
   8 \fBwmget\fR dock [\fIoptions\fR]
   9 .ad
  10 .hy
  11 .ad l
  12 .hy 0
  13 .HP 6
  14 \fBwmget\fR [\fIoptions\fR] {\fIURL\fR}
  15 .ad
  16 .hy
  17 .ad l
  18 .hy 0
  19 .HP 6
  20 \fBwmget\fR cancel {\fIjob\-id\fR}
  21 .ad
  22 .hy
  23 .ad l
  24 .hy 0
  25 .HP 6
  26 \fBwmget\fR list
  27 .ad
  28 .hy
  29
  30 .SH "DESCRIPTION"
  31
  32 .PP
  33 wmget is a ``dockapp'' which makes it more convenient to retrieve files in the background\&. Dockapps are applications which run in small windows intended to be ``docked'' in window manager\-provided locations\&. wmget was developed primarily under GNU Window Maker, the author's preferred WM, but is known to work under AfterStep as well, and should work with other dockapp\-aware window managers and docks\&.
  34
  35 .PP
  36 It uses the excellent libcurl library, part of the Curl automated\-download program, to perform file retrieval from Web servers, FTP servers, and other sources\&.
  37
  38 .PP
  39 wmget allows you to perform multiple downloads without keeping a terminal open (for FTP or curl or something) or another window on your desktop (e\&.g\&. for Mozilla download progress); download progress is visible any time the Dock is visible\&.
  40
  41 .PP
  42 You start downloads either by ``pasting'' URLs from Web browsers or other applications, or by invoking wmget from the command line (or another script or program) with a source URL\&. The dockapp has a handful of configurable download options, such as target directory, HTTP proxy server, etc\&.
  43
  44 .SH "STARTING UP"
  45
  46 .PP
  47 To start the dockapp, just run \fBwmget dock &\fR\&. If you are running Window Maker, you can then just drag the new appicon onto your Dock, right\-click on an area outside the four progress bars, select Settings, and select Start when Window Maker is started\&.
  48
  49 .PP
  50 If you are running AfterStep, you can add it to your Wharf by adding the following line to your \fI~/GNUstep/Library/AfterStep/wharf\fR file:
  51
  52 .nf
  53
  54         *Wharf wmget \- Swallow "wmget" wmget dock &
  55
  56 .fi
  57
  58 .PP
  59 Other window managers support dockapps in different ways\&. Even in window managers without any special dockapp support, you can run wmget as noted above; it will simply show up as a small window or "icon"\&.
  60
  61 .SH "USING WMGET"
  62
  63 .PP
  64 wmget's user interface is simple: four stacked progress bars, initially empty, representing four possible simultaneous downloads\&. The top bar will say ``wmget'' when there isn't a download running there, but any download will cover that up\&.
  65
  66 .PP
  67 Each running download normally shows up to nine characters of its filename, overlaid with a progress bar\&. You can click on any progress bar to reveal a percentage display and a stop button; clicking on the percentage display switches back, while clicking on the stop button stops the download\&. There is currently no confirmation; it just stops\&.
  68
  69 .PP
  70 You can ``request'' downloads at any time\&. If all four places show running downloads, additional requests will queue up, waiting for one to complete; wmget will never be downloading more than four files at a time\&.
  71
  72 .PP
  73 By default, wmget figures out a reasonable filename for any requested downloads, writes them to your home directory, and won't overwrite an existing file by the same name\&. All of these, along with a few other options, are configurable\&. See below\&.
  74
  75 .SS "Requesting Downloads with the Mouse"
  76
  77 .PP
  78 The easiest way to request a download is by copying and pasting a link\&. wmget lets you paste a URL by middle\-clicking anywhere on any of its status bars\&. Simply copy a link from some other source (for example, by right\-clicking on a link in Mozilla or Netscape and picking Copy Link Location), and middle\-click on one of the progress meter boxes in wmget\&.
  79
  80 .SS "Requesting Downloads from the Command Line"
  81
  82 .PP
  83 The \fBwmget\fR command also lets you directly request downloads from the command line, or from within a script or another program\&. The syntax is \fBwmget \fIURL\fR\fR, plus any of the options documented below\&.
  84
  85 .PP
  86 Once you run this command, you'll either get an error message or a ``job ID''\&. The job ID is only useful in conjunction with the \fBwmget cancel\fR command\&.
  87
  88 .SS "Download Failures"
  89
  90 .PP
  91 Downloads can fail for a variety of reasons, from running out of disk space to modem hangups\&. Since wmget is designed not to interrupt your workflow or exceed its little square window, it responds to any download error by aborting the download and writing an error file to your download directory\&. This error file has the name \fIfile\&.ERROR\fR, where \fIfile\fR is the name of the actual download target\&. This error file is a plain text file containing information on what you were downloading and what went wrong\&.
  92
  93 .SS "Viewing and Canceling Downloads"
  94
  95 .PP
  96 As noted above, you can see the currently\-running downloads in the four progress boxes on the dockapp\&. Clicking on a bar reveals a stop button, and clicking on that stop button cancels the download (but leaves the partially\-downloaded file on your computer)\&.
  97
  98 .PP
  99 At any time, you can also run the \fBwmget list\fR command, which displays all the running downloads as well as any queued\-up requests\&. The listing contains entries like this:
 100
 101 .IP
 102 .nf
 103 Job 10 [linux\-2\&.6]: 1658544/33073407 RUNNING
 104 ftp://ftp\&.kernel\&.org/pub/linux/kernel/v2\&.6/linux\-2\&.6\&.0\-test6\&.tar\&.bz2
 105 => /home/aaron/DOWNLOAD/linux\-2\&.6\&.0\-test6\&.tar\&.bz2
 106
 107 .fi
 108
 109 .PP
 110 What you see in that (admittedly dense) listing are the job ID, the name of the download as displayed on the dockapp (surrounded in brackets), the progress in bytes, the total bytes to download, the current status, the source URL, and the target file on your computer\&. Whew\&.
 111
 112 .PP
 113 You can cancel any requested or running download from the command line by specifying \fBwmget cancel \fIjob\-id\fR\fR\&.
 114
 115 .SH "COMMAND-LINE OPTIONS AND THE CONFIGURATION FILE"
 116
 117 .PP
 118 wmget supports a handful of configuration options\&. You can specify defaults for all downloads by putting them in a configuration file or adding command\-line options to the \fBwmget dock\fR command at startup, or you can specify options for one specific download by adding options to the \fBwmget \fIURL\fR\fR command when you request them\&. There isn't any way to specify options on URLs you paste with the mouse\&. Dockapp command\-line arguments override config\-file settings, and per\-URL settings override dockapp settings\&.
 119
 120 .PP
 121 The configuration file is an optional file named \fI\&.wmgetrc\fR in your home directory\&. If it's there, it's parsed by the dockapp at startup\&. The syntax is simple: one option per line, all options consisting of a name and possibly a value\&. Blank lines are okay, and lines starting with # are ignored (so you can disable options easily)\&. Option names are just the same as the command\-line option names given below, except you don't put the dashes (``\-\-'') and you can't use the one\-letter abbreviations\&.
 122
 123 .TP
 124 \-\-version, \-v
 125 Regardless of any other options, this prints out version and copyright information and exits\&.
 126
 127 .TP
 128 \-\-help, \-h
 129 Regardless of any other options, this prints out a help message and exits\&.
 130
 131 .TP
 132 \-\-silent, \-s
 133 Suppress any output text other than error messages\&.
 134
 135 .TP
 136 \-\-verbose, \-V
 137 Write extra debugging information; not very useful unless you're debugging or extending the software\&.
 138
 139 .TP
 140 \-\-output \fIpathname\fR, \-o \fIpathname\fR
 141 Specifies where to write downloaded files\&. In the config file or on the dockapp command line, this can only be used to specify your default download directory; it must be an existing directory, and if it's not absolute then it is assumed to be relative to your home directory\&. On a specific download request, this can provide an alternate save directory or even an alternate filename; in that case, a non\-absolute path is relative to the default download directory\&.
 142
 143 .TP
 144 \-\-display \fIname\fR, \-d \fIname\fR
 145 Display the first nine characters of \fIname\fR in the progress display for this file\&. (Only valid on specific download requests, not on the dockapp or in the config file\&.)
 146
 147 .TP
 148 \-\-overwrite, \-O
 149 Allow wmget to overwrite an existing file when downloading\&. Normally, it will refuse to do so\&.
 150
 151 .TP
 152 \-\-continue, \-C
 153 When fetching a file that already exists locally, assume the local copy was an aborted download and try to download just the remainder\&.
 154
 155 .TP
 156 \-\-auth \fIusername\fR:\fIpassword\fR, \-a \fIusername\fR:\fIpassword\fR
 157 Provides login information for the server from which you're downloading\&.
 158
 159 .TP
 160 \-\-proxy \fIserver\fR:\fIport\fR, \-p \fIserver\fR:\fIport\fR, \-\-proxy_auth \fIuser\fR:\fIpassword\fR, \-P \fIuser\fR:\fIpassword\fR
 161 Specifies a proxy server and optionally a proxy\-server username/password pair for getting past firewalls\&.
 162
 163 .TP
 164 \-\-follow \fIN\fR, \-f \fIN\fR
 165 Specifies how many HTTP redirects to follow when resolving a page; by default, wmget is configured to follow up to 5\&. Set this to 0 to disable redirection\&. (In any real\-world situation, if you're getting redirected more than 5 times, there's a problem\&.\&.\&.)
 166
 167 .TP
 168 \-\-user\-agent \fIstring\fR, \-U \fIstring\fR
 169 Specifies which User\-Agent string to provide to servers when performing HTTP downloads\&. The default User\-Agent names both the wmget and libcurl versions in use\&.
 170
 171 .TP
 172 \-\-ascii, \-B
 173 Force FTP downloads to use ASCII mode; normally, they use binary mode\&. If you're downloading text documents, ASCII mode will take care of any necessary conversions between the text formats of the server and your computer\&.
 174
 175 .TP
 176 \-\-referer \fIstring\fR, \-e \fIstring\fR
 177 Provides a ``referer'' string to the Web server\&.
 178
 179 .TP
 180 \-\-interface \fIinterface\fR, \-\-n \fIinterface\fR
 181 Names a specific network interface to use (e\&.g\&., eth0 for the first Ethernet interface on a Linux system)\&. Rarely needed\&.
 182
 183 .TP
 184 \-\-headers, \-h
 185 When performing an HTTP retrieval, include the HTTP message header in the saved file\&. This is only really useful for testing\&.
 186
 187 .SH "FILES"
 188
 189 .TP
 190 \fI~/\&.wmgetrc\fR
 191 The (optional) configuration file for the wmget dockapp\&. Settings in this file are used to specify defaults for the dockapp when it starts; see the section on configuration and command\-line options for more details\&.
 192
 193 .TP
 194 \fI~/\&.wmget\&.iq\fR
 195 A Unix\-domain socket created by the wmget dockapp to accept requests from wmget commands\&. Created at startup automatically\&.
 196
 197 .SH AUTHOR
 198 Aaron Trickey.