sjero.net Git - wget/blob - src/options.h

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