]> sjero.net Git - wget/blob - src/options.h
[svn] Add the --user, --password, --ftp-user and --ftp-password options.
[wget] / src / options.h
1 /* struct options.
2    Copyright (C) 1995, 1996, 1997 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 2 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, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20 In addition, as a special exception, the Free Software Foundation
21 gives permission to link the code of its release of Wget with the
22 OpenSSL project's "OpenSSL" library (or with modified versions of it
23 that use the same license as the "OpenSSL" library), and distribute
24 the linked executables.  You must obey the GNU General Public License
25 in all respects for all of the code used other than "OpenSSL".  If you
26 modify this file, you may extend this exception to your version of the
27 file, but you are not obligated to do so.  If you do not wish to do
28 so, delete this exception statement from your version.  */
29
30 struct options
31 {
32   int verbose;                  /* Are we verbose? */
33   int quiet;                    /* Are we quiet? */
34   int ntry;                     /* Number of tries per URL */
35   int retry_connrefused;        /* Treat CONNREFUSED as non-fatal. */
36   int background;               /* Whether we should work in background. */
37   int kill_longer;              /* Do we reject messages with *more*
38                                    data than specified in
39                                    content-length? */
40   int ignore_length;            /* Do we heed content-length at all?  */
41   int recursive;                /* Are we recursive? */
42   int spanhost;                 /* Do we span across hosts in
43                                    recursion? */
44   int relative_only;            /* Follow only relative links. */
45   int no_parent;                /* Restrict access to the parent
46                                    directory.  */
47   int reclevel;                 /* Maximum level of recursion */
48   int dirstruct;                /* Do we build the directory structure
49                                   as we go along? */
50   int no_dirstruct;             /* Do we hate dirstruct? */
51   int cut_dirs;                 /* Number of directory components to cut. */
52   int add_hostdir;              /* Do we add hostname directory? */
53   int protocol_directories;     /* Whether to prepend "http"/"ftp" to dirs. */
54   int noclobber;                /* Disables clobbering of existing
55                                    data. */
56   char *dir_prefix;             /* The top of directory tree */
57   char *lfilename;              /* Log filename */
58   char *input_filename;         /* Input filename */
59   int force_html;               /* Is the input file an HTML file? */
60
61   int spider;                   /* Is Wget in spider mode? */
62
63   char **accepts;               /* List of patterns to accept. */
64   char **rejects;               /* List of patterns to reject. */
65   char **excludes;              /* List of excluded FTP directories. */
66   char **includes;              /* List of FTP directories to
67                                    follow. */
68
69   char **domains;               /* See host.c */
70   char **exclude_domains;
71   int dns_cache;                /* whether we cache DNS lookups. */
72
73   char **follow_tags;           /* List of HTML tags to recursively follow. */
74   char **ignore_tags;           /* List of HTML tags to ignore if recursing. */
75
76   int follow_ftp;               /* Are FTP URL-s followed in recursive
77                                    retrieving? */
78   int retr_symlinks;            /* Whether we retrieve symlinks in
79                                    FTP. */
80   char *output_document;        /* The output file to which the
81                                    documents will be printed.  */
82
83   char *user;                   /* Generic username */
84   char *passwd;                 /* Generic password */
85   
86   int always_rest;              /* Always use REST. */
87   char *ftp_user;               /* FTP username */
88   char *ftp_passwd;             /* FTP password */
89   int netrc;                    /* Whether to read .netrc. */
90   int ftp_glob;                 /* FTP globbing */
91   int ftp_pasv;                 /* Passive FTP. */
92
93   char *http_user;              /* HTTP username. */
94   char *http_passwd;            /* HTTP password. */
95   char **user_headers;          /* User-defined header(s). */
96   int http_keep_alive;          /* whether we use keep-alive */
97
98   int use_proxy;                /* Do we use proxy? */
99   int allow_cache;              /* Do we allow server-side caching? */
100   char *http_proxy, *ftp_proxy, *https_proxy;
101   char **no_proxy;
102   char *base_href;
103   char *progress_type;          /* progress indicator type. */
104   char *proxy_user; /*oli*/
105   char *proxy_passwd;
106
107   double read_timeout;          /* The read/write timeout. */
108   double dns_timeout;           /* The DNS timeout. */
109   double connect_timeout;       /* The connect timeout. */
110
111   int random_wait;              /* vary from 0 .. wait secs by random()? */
112   double wait;                  /* The wait period between retrievals. */
113   double waitretry;             /* The wait period between retries. - HEH */
114   int use_robots;               /* Do we heed robots.txt? */
115
116   wgint limit_rate;             /* Limit the download rate to this
117                                    many bps. */
118   LARGE_INT quota;              /* Maximum file size to download and
119                                    store. */
120   int numurls;                  /* Number of successfully downloaded
121                                    URLs */
122
123   int server_response;          /* Do we print server response? */
124   int save_headers;             /* Do we save headers together with
125                                    file? */
126
127 #ifdef ENABLE_DEBUG
128   int debug;                    /* Debugging on/off */
129 #endif
130
131   int timestamping;             /* Whether to use time-stamping. */
132
133   int backup_converted;         /* Do we save pre-converted files as *.orig? */
134   int backups;                  /* Are numeric backups made? */
135
136   char *useragent;              /* Naughty User-Agent, which can be
137                                    set to something other than
138                                    Wget. */
139   char *referer;                /* Naughty Referer, which can be
140                                    set to something other than
141                                    NULL. */
142   int convert_links;            /* Will the links be converted
143                                    locally? */
144   int remove_listing;           /* Do we remove .listing files
145                                    generated by FTP? */
146   int 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   int delete_after;             /* Whether the files will be deleted
156                                    after download. */
157
158   int html_extension;           /* Use ".html" extension on all text/html? */
159
160   int 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   int 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   int   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   int   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   int restrict_files_ctrl;      /* non-zero if control chars in URLs
203                                    are restricted from appearing in
204                                    generated file names. */
205
206   int strict_comments;          /* whether strict SGML comments are
207                                    enforced.  */
208
209   int preserve_perm;           /* whether remote permissions are used
210                                   or that what is set by umask. */
211
212 #ifdef ENABLE_IPV6
213   int ipv4_only;                /* IPv4 connections have been requested. */
214   int ipv6_only;                /* IPv4 connections have been requested. */
215 #endif
216   enum {
217     prefer_ipv4,
218     prefer_ipv6,
219     prefer_none
220   } prefer_family;              /* preferred address family when more
221                                    than one type is available */
222 };
223
224 extern struct options opt;