sjero.net Git - wget/blob - 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   bool spider;                  /* Is Wget in spider mode? */
  63
  64   char **accepts;               /* List of patterns to accept. */
  65   char **rejects;               /* List of patterns to reject. */
  66   char **excludes;              /* List of excluded FTP directories. */
  67   char **includes;              /* List of FTP directories to
  68                                    follow. */
  69   bool ignore_case;             /* Whether to ignore case when
  70                                    matching dirs and files */
  71
  72   char **domains;               /* See host.c */
  73   char **exclude_domains;
  74   bool dns_cache;               /* whether we cache DNS lookups. */
  75
  76   char **follow_tags;           /* List of HTML tags to recursively follow. */
  77   char **ignore_tags;           /* List of HTML tags to ignore if recursing. */
  78
  79   bool follow_ftp;              /* Are FTP URL-s followed in recursive
  80                                    retrieving? */
  81   bool retr_symlinks;           /* Whether we retrieve symlinks in
  82                                    FTP. */
  83   char *output_document;        /* The output file to which the
  84                                    documents will be printed.  */
  85
  86   char *user;                   /* Generic username */
  87   char *passwd;                 /* Generic password */
  88
  89   bool always_rest;             /* Always use REST. */
  90   char *ftp_user;               /* FTP username */
  91   char *ftp_passwd;             /* FTP password */
  92   bool netrc;                   /* Whether to read .netrc. */
  93   bool ftp_glob;                /* FTP globbing */
  94   bool ftp_pasv;                        /* Passive FTP. */
  95
  96   char *http_user;              /* HTTP username. */
  97   char *http_passwd;            /* HTTP password. */
  98   char **user_headers;          /* User-defined header(s). */
  99   bool http_keep_alive;         /* whether we use keep-alive */
 100
 101   bool use_proxy;               /* Do we use proxy? */
 102   bool allow_cache;             /* Do we allow server-side caching? */
 103   char *http_proxy, *ftp_proxy, *https_proxy;
 104   char **no_proxy;
 105   char *base_href;
 106   char *progress_type;          /* progress indicator type. */
 107   char *proxy_user; /*oli*/
 108   char *proxy_passwd;
 109
 110   double read_timeout;          /* The read/write timeout. */
 111   double dns_timeout;           /* The DNS timeout. */
 112   double connect_timeout;       /* The connect timeout. */
 113
 114   bool random_wait;             /* vary from 0 .. wait secs by random()? */
 115   double wait;                  /* The wait period between retrievals. */
 116   double waitretry;             /* The wait period between retries. - HEH */
 117   bool use_robots;              /* Do we heed robots.txt? */
 118
 119   wgint limit_rate;             /* Limit the download rate to this
 120                                    many bps. */
 121   SUM_SIZE_INT quota;           /* Maximum file size to download and
 122                                    store. */
 123
 124   int numurls;                  /* Number of successfully downloaded
 125                                    URLs #### should be removed because
 126                                    it's not a setting, but a global var */
 127
 128   bool server_response;         /* Do we print server response? */
 129   bool save_headers;            /* Do we save headers together with
 130                                    file? */
 131
 132 #ifdef ENABLE_DEBUG
 133   bool debug;                   /* Debugging on/off */
 134 #endif
 135
 136 #ifdef MSDOS
 137   bool wdebug;                  /* Watt-32 tcp/ip debugging on/off */
 138 #endif
 139
 140   bool timestamping;            /* Whether to use time-stamping. */
 141
 142   bool backup_converted;        /* Do we save pre-converted files as *.orig? */
 143   bool backups;                 /* Are numeric backups made? */
 144
 145   char *useragent;              /* User-Agent string, which can be set
 146                                    to something other than Wget. */
 147   char *referer;                /* Naughty Referer, which can be
 148                                    set to something other than
 149                                    NULL. */
 150   bool convert_links;           /* Will the links be converted
 151                                    locally? */
 152   bool remove_listing;          /* Do we remove .listing files
 153                                    generated by FTP? */
 154   bool htmlify;                 /* Do we HTML-ify the OS-dependent
 155                                    listings? */
 156
 157   char *dot_style;
 158   wgint dot_bytes;              /* How many bytes in a printing
 159                                    dot. */
 160   int dots_in_line;             /* How many dots in one line. */
 161   int dot_spacing;              /* How many dots between spacings. */
 162
 163   bool delete_after;            /* Whether the files will be deleted
 164                                    after download. */
 165
 166   bool html_extension;          /* Use ".html" extension on all text/html? */
 167
 168   bool page_requisites;         /* Whether we need to download all files
 169                                    necessary to display a page properly. */
 170   char *bind_address;           /* What local IP address to bind to. */
 171
 172 #ifdef HAVE_SSL
 173   enum {
 174     secure_protocol_auto,
 175     secure_protocol_sslv2,
 176     secure_protocol_sslv3,
 177     secure_protocol_tlsv1
 178   } secure_protocol;            /* type of secure protocol to use. */
 179   bool check_cert;              /* whether to validate the server's cert */
 180   char *cert_file;              /* external client certificate to use. */
 181   char *private_key;            /* private key file (if not internal). */
 182   enum keyfile_type {
 183     keyfile_pem,
 184     keyfile_asn1
 185   } cert_type;                  /* type of client certificate file */
 186   enum keyfile_type
 187     private_key_type;           /* type of private key file */
 188
 189   char *ca_directory;           /* CA directory (hash files) */
 190   char *ca_cert;                /* CA certificate file to use */
 191
 192
 193   char *random_file;            /* file with random data to seed the PRNG */
 194   char *egd_file;               /* file name of the egd daemon socket */
 195 #endif /* HAVE_SSL */
 196
 197   bool cookies;                 /* whether cookies are used. */
 198   char *cookies_input;          /* file we're loading the cookies from. */
 199   char *cookies_output;         /* file we're saving the cookies to. */
 200   bool keep_session_cookies;    /* whether session cookies should be
 201                                    saved and loaded. */
 202
 203   char *post_data;              /* POST query string */
 204   char *post_file_name;         /* File to post */
 205
 206   enum {
 207     restrict_unix,
 208     restrict_windows
 209   } restrict_files_os;          /* file name restriction ruleset. */
 210   bool restrict_files_ctrl;     /* non-zero if control chars in URLs
 211                                    are restricted from appearing in
 212                                    generated file names. */
 213   enum {
 214     restrict_no_case_restriction,
 215     restrict_lowercase,
 216     restrict_uppercase
 217   } restrict_files_case;        /* file name case restriction. */
 218
 219   bool strict_comments;         /* whether strict SGML comments are
 220                                    enforced.  */
 221
 222   bool preserve_perm;           /* whether remote permissions are used
 223                                   or that what is set by umask. */
 224
 225 #ifdef ENABLE_IPV6
 226   bool ipv4_only;               /* IPv4 connections have been requested. */
 227   bool ipv6_only;               /* IPv4 connections have been requested. */
 228 #endif
 229   enum {
 230     prefer_ipv4,
 231     prefer_ipv6,
 232     prefer_none
 233   } prefer_family;              /* preferred address family when more
 234                                    than one type is available */
 235
 236   bool content_disposition;     /* Honor HTTP Content-Disposition header. */
 237   bool auth_without_challenge;  /* Issue Basic authentication creds without
 238                                   waiting for a challenge. */
 239
 240 #ifdef __VMS
 241   int ftp_stmlf;                /* Force Stream_LF format for binary FTP. */
 242 #endif /* def __VMS */
 243
 244 };
 245
 246 extern struct options opt;