1Wget-Pavuk.HOWTO
2****************
3
4This file contains base information for wget users who are starting using
5pavuk.
6
7I am not very authoritative person to write this kind of document.I am not
8regulary using wget, so some of informations contained in this document may
9be confused. I just was asked to provide such kind of informations, so I am
10trying to write it.
11
12I will appreciate any corrections and contributions to this document.
13
14* Stevo Ondrejicka
15
16
17Mapping of wget options to pavuk options
18----------------------------------------
19
20It is not possible to map exectly all options, because wget have some features
21which pavuk lacks and vice versa. Also some of options doesn't behave exactly
22same in pavuk.
23
24_________________________________________________________________________
25| Wget                             | Pavuk                              |
26|-----------------------------------------------------------------------|
27| * version information                                                 |
28| -V, --version                    | -v                                 |
29|-----------------------------------------------------------------------|
30| * options help                                                        |
31| -h, --help                       | -h                                 |
32|-----------------------------------------------------------------------|
33| * puting job at background                                            |
34| -b, --background                 | -bg                                |
35|-----------------------------------------------------------------------|
36| * log messages                                                        |
37| -a, --append-file=FILE           | -log_file FILE                     |
38| -o, --output-file=FILE           | no option to force overwrite of    |
39|                                  | log file, always appending         |
40|-----------------------------------------------------------------------|
41| * debuging                                                            |
42| -d, --debug                      | -debug -debug_level LEVEL          |
43|                                  | pavuk allows to focus on interested|
44|                                  | messages by selecting of debug     |
45|                                  | level - html,protos,protoc,protod  |
46|                                  |         procs,locks,net,misc,user  |
47|                                  |         mtlock,mtthr               |
48|-----------------------------------------------------------------------|
49| * verbosity of messages                                               |
50| -q, --quiet                      | -quiet                             |
51| -v, --verbose                    | -verbose                           |
52| -nv, --non-verbose               | this option doesn't have any       |
53|                                  | meaning for pavuk, because pavuk   |
54|                                  | have better tunning of verbosity   |
55|                                  | using -debug_level option          |
56|-----------------------------------------------------------------------|
57| * input of starting URLs from file                                    |
58| -i, --input-file=FILE            | -urls_file FILE                    |
59|-----------------------------------------------------------------------|
60| * force processing of all files as HTML file                          |
61| -F,  --force-html                | no similar option, pavuk rely on   |
62|                                  | proper MIME types sent by servers. |
63|                                  | For local files pavuk tries to     |
64|                                  | guess HTML files by extensions or  |
65|                                  | by contents                        |
66|-----------------------------------------------------------------------|
67| * number of attempts to get document after fail                       |
68| -t, --tries=NUMBER               | -retry NUMBER                      |
69| 0 means unlimited                | 0 means unlimited                  |
70|-----------------------------------------------------------------------|
71| * writing document to specified file                                  |
72| -O, --output-document=FILE       | -store_name FILE                   |
73|-----------------------------------------------------------------------|
74| * reusing of already downloaded file                                  |
75| -nc, --no-clobber                | this is default pavuk behavior     |
76|                                  | and can't be turned off            |
77|-----------------------------------------------------------------------|
78| * resuming of broken downloads                                        |
79| -c, --continue                   | this is pavuk default behaviour    |
80|                                  | pavuk always prefix document names |
81|                                  | with ".in_" and just after download|
82|                                  | is finished it renames file to     |
83|                                  | regular name, this way it can      |
84|                                  | properly detect and restart broken |
85|                                  | downloads                          |
86|-----------------------------------------------------------------------|
87| * progress meter                                                      |
88| --dot-style=STYLE                | pavuk have only one style of       |
89|                                  | progress (numeric) and it can be   |
90|                                  | only turned on/off using -progress |
91|                                  | and -noprogress option (default is |
92|                                  | turned off)                        |
93|-----------------------------------------------------------------------|
94| * synchronizing                                                       |
95| -N, --timestamping               | -mode sync                         |
96|-----------------------------------------------------------------------|
97| * output of protocol level communication with servers                 |
98| -S, --server-response            | -debug -debug_level LEVEL          |
99|                                  | LEVEL protos - for server responses|
100|                                  | LEVEL protoc - for pavuk requests  |
101|                                  | LEVEL protod - POST data sent in   |
102|                                  |                HTTP POST request   |
103|                                  | you can activate multiple debug    |
104|                                  | levels - for example :             |
105|                                  |  -debug_level protos,protoc        |
106|-----------------------------------------------------------------------|
107| * checking of URLs validity                                           |
108| --spider                         | something similar cand be achived  |
109|                                  | by -mode remind option.             |
110|                                  | it reports broken and modified     |
111|                                  | links not everything               |
112|                                  | you must use also -remind_cmd      |
113|                                  | option to set program which will   |
114|                                  | process output (default is mailx)  |
115|-----------------------------------------------------------------------|
116| * communication timeout                                               |
117| -T, --timeout=SECONDS            | -timeout MINUTES                   |
118|-----------------------------------------------------------------------|
119| * delaying of transfers                                               |
120| -w, --wait=SECONDS               | -sleep SECONDS                     |
121|-----------------------------------------------------------------------|
122| * enabling/disabling connections through proxy                        |
123| -Y, --proxy=on/off               | no similar option, if proxy is     |
124|                                  | specified, it is always used       |
125|-----------------------------------------------------------------------|
126| * retrieval quota                                                     |
127| -Q, --quota=NUMBER               | -trans_quota NUMBER                |
128| wget stops download just after   | pavuk stops download right after   |
129| file download is finished after  | transfer quota is exeede (also in  |
130| quota is exeeded                 | midle of transfer)                 |
131|-----------------------------------------------------------------------|
132| * adjusting of local directory layout of downloaded files             |
133| -nd, --no-directories            | -fnrules F "*" "%n"                |
134| -x, --force-directories          | this is default for pavuk          |
135| -nH, --no-host-directories       | -base_level 2                      |
136|                                  | or -fnrules F "*" "%d/%n"          |
137| -P, --directory-prefix=PREFIX    | -cdir PREFIX                       |
138| --cut-dirs=NUMBER                | -base_level NUMBER+1               |
139|-----------------------------------------------------------------------|
140| * authorization for accessing documents                               |
141| --http-user=USER                 | -auth_name USER                    |
142| --http-passwd=PASS               | -auth_passwd PASS                  |
143|-----------------------------------------------------------------------|
144| * caching of documents on proxy server                                |
145| -C, --cache=on/off               | -cache -nocache                    |
146|-----------------------------------------------------------------------|
147| * workaround for buggy HTTP servers with bad Content-Length header    |
148| --ignore-length                  | -check_size/-nocheck_size          |
149|-----------------------------------------------------------------------|
150| * adding custom fields to HTTP request header                         |
151| --header=STRING                  | -httpad STRING                     |
152|-----------------------------------------------------------------------|
153| * proxy authorization                                                 |
154| --proxy-user=USER                | -http_proxy_user USER              |
155| --proxy-passwd=PASS              | -http_proxy_pass PASS              |
156|-----------------------------------------------------------------------|
157| * storing HTTP response headers                                       |
158| -s, --save-headers               | pavuk never stores HTTP responses  |
159|                                  | within documents, it provides      |
160|                                  | -store_info, to store this         |
161|                                  | information in sepearate files in  |
162|                                  | .pavuk_info directory              |
163|-----------------------------------------------------------------------|
164| * spoofing of User-Agent: request field                               |
165| -U, --user-agent=AGENT           | -identity AGENT                    |
166|-----------------------------------------------------------------------|
167| * preserving of symbolic links when transfering through FTP           |
168| --retr-symlinks                  | -preserve_slinks/-nopreserve_slinks|
169|-----------------------------------------------------------------------|
170| * globbing in FTP transfers                                           |
171| -g, --glob=on/off                | no exactly similar functionality   |
172|                                  | pavuk allow to specify wildcard    |
173|                                  | patterns and regular expressions   |
174|                                  | with options                       |
175|                                  | -pattern, -rpattern, -skip_pattern |
176|                                  | -skip_rpattern, -url_patter,       |
177|                                  | -url_rpattern, -skip_url_pattern   |
178|                                  | -skip_url_rpatter                  |
179|                                  | this patterns arre applied on all  |
180|                                  | URLs not just FTP URLs             |
181|-----------------------------------------------------------------------|
182| * setting of FTP data connection type                                 |
183| --passive-ftp                    | -ftp_active/-ftp_passive           |
184|-----------------------------------------------------------------------|
185| * recursing through WWW                                               |
186| -r, --recursive                  | this is default pavuk behaviour    |
187|-----------------------------------------------------------------------|
188| * limiting recursion level                                            |
189| -l, --level=NUMBER               | -lmax NUMBER                       |
190| 0 unlimited                      | 0 unlimited                        |
191|-----------------------------------------------------------------------|
192| * prefetching files to proxy                                          |
193| --delete-after                   | -mode dontstore                    |
194|-----------------------------------------------------------------------|
195| * converting links in HTML documents                                  |
196| -k, --convert-links              | default pavuk behaviour, it is     |
197|                                  | possible to set how to convert the |
198|                                  | as default pavuk maintain          |
199|                                  | consistency of links inside HTML   |
200|                                  | documents, so all links are always |
201|                                  | valid and when documents is stored |
202|                                  | to local tree, pavuk overwrites    |
203|                                  | links in all HTML documents which  |
204|                                  | points to it.                      |
205|                                  | default behaviour is possible to   |
206|                                  | change with options:               |
207|                                  | -all_to_local, -sel_to_local,      |
208|                                  | -all_to_remote                     |
209|-----------------------------------------------------------------------|
210| * mirroring                                                           |
211| -m, --mirror                     | -mode sync                         |
212|-----------------------------------------------------------------------|
213| * directory listings handling                                         |
214| -nr, --dont-remove-listing       | -store_index/-nostore_index        |
215|                                  | pavuk as default converts all      |
216|                                  | directory listing to HTML files and|
217|                                  | as default are this files stored.  |
218|-----------------------------------------------------------------------|
219| * allowing/disallowing of specified suffixes (file extensions)        |
220| -A, --accept=LIST                | -asfx LIST                         |
221| -R, --reject=LIST                | -dsfx LIST                         |
222|-----------------------------------------------------------------------|
223| * allowing/disallowing of specified domains                           |
224| -D, --domains=LIST               | -adomain LIST                      |
225| --exclude-domains=LIST           | -ddomain LIST                      |
226|-----------------------------------------------------------------------|
227| * following of relative only URLs                                     |
228| -L, --relative                   | no similar option                  |
229|-----------------------------------------------------------------------|
230| * enabling of transfers from FTP servers                              |
231| --follow-ftp                     | -FTP/-noFTP                        |
232|-----------------------------------------------------------------------|
233| * spaning to other servers                                            |
234| -H, --span-hosts                 | this is default pavuk behaviour    |
235|                                  | it is possible to change it with   |
236|                                  | -dont_leave_site/-leave_site       |
237|-----------------------------------------------------------------------|
238| * allowing/disallowing of specified directories (prefixes)            |
239| -I, --include-directories=LIST   | -aprefix LIST                      |
240| -X, --exclude-directories=LIST   | -dprefix LIST                      |
241|-----------------------------------------------------------------------|
242| * DNS lookup                                                          |
243| -nh, --no-host-lookup            | no similar option                  |
244|                                  | pavuk always caches DNS request in |
245|                                  | local hash table                   |
246|-----------------------------------------------------------------------|
247| * disable ascending to parent directories                             |
248| -np, --no-parent                 | -dont_leave_dir/-leave_dir         |
249|-----------------------------------------------------------------------|
250
251
252This document I wrote looking at "wget --help" output and sometimes checking
253info documentation of wget. The version of wget I have is "GNU Wget 1.5.3"
254as distributed with RedHat 6.2 .
255If you find any bugs/mistakes/typos/... please tell me and I will try to
256correct it.
257
258
259