]> sjero.net Git - wget/blob - src/options.h
[svn] Merge of fix for bugs 20341 and 20410.
[wget] / src / options.h
1 /* struct options.
2    Copyright (C) 1996-2006 Free Software Foundation, Inc.
3
4 This file is part of GNU Wget.
5
6 GNU Wget is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
10
11 GNU Wget is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with Wget.  If not, see <http://www.gnu.org/licenses/>.
18
19 In addition, as a special exception, the Free Software Foundation
20 gives permission to link the code of its release of Wget with the
21 OpenSSL project's "OpenSSL" library (or with modified versions of it
22 that use the same license as the "OpenSSL" library), and distribute
23 the linked executables.  You must obey the GNU General Public License
24 in all respects for all of the code used other than "OpenSSL".  If you
25 modify this file, you may extend this exception to your version of the
26 file, but you are not obligated to do so.  If you do not wish to do
27 so, delete this exception statement from your version.  */
28
29 struct options
30 {
31   int verbose;                  /* Are we verbose?  (First set to -1,
32                                    hence not boolean.) */
33   bool quiet;                   /* Are we quiet? */
34   int ntry;                     /* Number of tries per URL */
35   bool retry_connrefused;       /* Treat CONNREFUSED as non-fatal. */
36   bool background;              /* Whether we should work in background. */
37   bool ignore_length;           /* Do we heed content-length at all?  */
38   bool recursive;               /* Are we recursive? */
39   bool spanhost;                        /* Do we span across hosts in
40                                    recursion? */
41   bool relative_only;           /* Follow only relative links. */
42   bool no_parent;               /* Restrict access to the parent
43                                    directory.  */
44   int reclevel;                 /* Maximum level of recursion */
45   bool dirstruct;               /* Do we build the directory structure
46                                   as we go along? */
47   bool no_dirstruct;            /* Do we hate dirstruct? */
48   int cut_dirs;                 /* Number of directory components to cut. */
49   bool add_hostdir;             /* Do we add hostname directory? */
50   bool protocol_directories;    /* Whether to prepend "http"/"ftp" to dirs. */
51   bool noclobber;               /* Disables clobbering of existing
52                                    data. */
53   char *dir_prefix;             /* The top of directory tree */
54   char *lfilename;              /* Log filename */
55   char *input_filename;         /* Input filename */
56   bool force_html;              /* Is the input file an HTML file? */
57
58   bool spider;                  /* Is Wget in spider mode? */
59
60   char **accepts;               /* List of patterns to accept. */
61   char **rejects;               /* List of patterns to reject. */
62   char **excludes;              /* List of excluded FTP directories. */
63   char **includes;              /* List of FTP directories to
64                                    follow. */
65   bool ignore_case;             /* Whether to ignore case when
66                                    matching dirs and files */
67
68   char **domains;               /* See host.c */
69   char **exclude_domains;
70   bool dns_cache;               /* whether we cache DNS lookups. */
71
72   char **follow_tags;           /* List of HTML tags to recursively follow. */
73   char **ignore_tags;           /* List of HTML tags to ignore if recursing. */
74
75   bool follow_ftp;              /* Are FTP URL-s followed in recursive
76                                    retrieving? */
77   bool retr_symlinks;           /* Whether we retrieve symlinks in
78                                    FTP. */
79   char *output_document;        /* The output file to which the
80                                    documents will be printed.  */
81
82   char *user;                   /* Generic username */
83   char *passwd;                 /* Generic password */
84   
85   bool always_rest;             /* Always use REST. */
86   char *ftp_user;               /* FTP username */
87   char *ftp_passwd;             /* FTP password */
88   bool netrc;                   /* Whether to read .netrc. */
89   bool ftp_glob;                /* FTP globbing */
90   bool ftp_pasv;                        /* Passive FTP. */
91
92   char *http_user;              /* HTTP username. */
93   char *http_passwd;            /* HTTP password. */
94   char **user_headers;          /* User-defined header(s). */
95   bool http_keep_alive;         /* whether we use keep-alive */
96
97   bool use_proxy;               /* Do we use proxy? */
98   bool allow_cache;             /* Do we allow server-side caching? */
99   char *http_proxy, *ftp_proxy, *https_proxy;
100   char **no_proxy;
101   char *base_href;
102   char *progress_type;          /* progress indicator type. */
103   char *proxy_user; /*oli*/
104   char *proxy_passwd;
105
106   double read_timeout;          /* The read/write timeout. */
107   double dns_timeout;           /* The DNS timeout. */
108   double connect_timeout;       /* The connect timeout. */
109
110   bool random_wait;             /* vary from 0 .. wait secs by random()? */
111   double wait;                  /* The wait period between retrievals. */
112   double waitretry;             /* The wait period between retries. - HEH */
113   bool use_robots;              /* Do we heed robots.txt? */
114
115   wgint limit_rate;             /* Limit the download rate to this
116                                    many bps. */
117   SUM_SIZE_INT quota;           /* Maximum file size to download and
118                                    store. */
119
120   int numurls;                  /* Number of successfully downloaded
121                                    URLs #### should be removed because
122                                    it's not a setting, but a global var */
123
124   bool server_response;         /* Do we print server response? */
125   bool save_headers;            /* Do we save headers together with
126                                    file? */
127
128 #ifdef ENABLE_DEBUG
129   bool debug;                   /* Debugging on/off */
130 #endif
131
132   bool timestamping;            /* Whether to use time-stamping. */
133
134   bool backup_converted;        /* Do we save pre-converted files as *.orig? */
135   bool backups;                 /* Are numeric backups made? */
136
137   char *useragent;              /* User-Agent string, which can be set
138                                    to something other than Wget. */
139   char *referer;                /* Naughty Referer, which can be
140                                    set to something other than
141                                    NULL. */
142   bool convert_links;           /* Will the links be converted
143                                    locally? */
144   bool remove_listing;          /* Do we remove .listing files
145                                    generated by FTP? */
146   bool htmlify;                 /* Do we HTML-ify the OS-dependent
147                                    listings? */
148
149   char *dot_style;
150   wgint dot_bytes;              /* How many bytes in a printing
151                                    dot. */
152   int dots_in_line;             /* How many dots in one line. */
153   int dot_spacing;              /* How many dots between spacings. */
154
155   bool delete_after;            /* Whether the files will be deleted
156                                    after download. */
157
158   bool html_extension;          /* Use ".html" extension on all text/html? */
159
160   bool page_requisites;         /* Whether we need to download all files
161                                    necessary to display a page properly. */
162   char *bind_address;           /* What local IP address to bind to. */
163
164 #ifdef HAVE_SSL
165   enum {
166     secure_protocol_auto,
167     secure_protocol_sslv2,
168     secure_protocol_sslv3,
169     secure_protocol_tlsv1
170   } secure_protocol;            /* type of secure protocol to use. */
171   bool check_cert;              /* whether to validate the server's cert */
172   char *cert_file;              /* external client certificate to use. */
173   char *private_key;            /* private key file (if not internal). */
174   enum keyfile_type {
175     keyfile_pem,
176     keyfile_asn1
177   } cert_type;                  /* type of client certificate file */
178   enum keyfile_type
179     private_key_type;           /* type of private key file */
180
181   char *ca_directory;           /* CA directory (hash files) */
182   char *ca_cert;                /* CA certificate file to use */
183
184
185   char *random_file;            /* file with random data to seed the PRNG */
186   char *egd_file;               /* file name of the egd daemon socket */
187 #endif /* HAVE_SSL */
188
189   bool cookies;                 /* whether cookies are used. */
190   char *cookies_input;          /* file we're loading the cookies from. */
191   char *cookies_output;         /* file we're saving the cookies to. */
192   bool keep_session_cookies;    /* whether session cookies should be
193                                    saved and loaded. */
194
195   char *post_data;              /* POST query string */
196   char *post_file_name;         /* File to post */
197
198   enum {
199     restrict_unix,
200     restrict_windows
201   } restrict_files_os;          /* file name restriction ruleset. */
202   bool restrict_files_ctrl;     /* non-zero if control chars in URLs
203                                    are restricted from appearing in
204                                    generated file names. */
205   enum {
206     restrict_no_case_restriction,
207     restrict_lowercase,
208     restrict_uppercase
209   } restrict_files_case;        /* file name case restriction. */
210
211   bool strict_comments;         /* whether strict SGML comments are
212                                    enforced.  */
213
214   bool preserve_perm;           /* whether remote permissions are used
215                                   or that what is set by umask. */
216
217 #ifdef ENABLE_IPV6
218   bool ipv4_only;               /* IPv4 connections have been requested. */
219   bool ipv6_only;               /* IPv4 connections have been requested. */
220 #endif
221   enum {
222     prefer_ipv4,
223     prefer_ipv6,
224     prefer_none
225   } prefer_family;              /* preferred address family when more
226                                    than one type is available */
227   
228   bool content_disposition;     /* Honor HTTP Content-Disposition header. */
229 };
230
231 extern struct options opt;