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