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
 134 #ifdef ENABLE_DEBUG
 135   bool debug;                   /* Debugging on/off */
 136 #endif
 137
 138 #ifdef USE_WATT32
 139   bool wdebug;                  /* Watt-32 tcp/ip debugging on/off */
 140 #endif
 141
 142   bool timestamping;            /* Whether to use time-stamping. */
 143
 144   bool backup_converted;        /* Do we save pre-converted files as *.orig? */
 145   bool backups;                 /* Are numeric backups made? */
 146
 147   char *useragent;              /* User-Agent string, which can be set
 148                                    to something other than Wget. */
 149   char *referer;                /* Naughty Referer, which can be
 150                                    set to something other than
 151                                    NULL. */
 152   bool convert_links;           /* Will the links be converted
 153                                    locally? */
 154   bool remove_listing;          /* Do we remove .listing files
 155                                    generated by FTP? */
 156   bool htmlify;                 /* Do we HTML-ify the OS-dependent
 157                                    listings? */
 158
 159   char *dot_style;
 160   wgint dot_bytes;              /* How many bytes in a printing
 161                                    dot. */
 162   int dots_in_line;             /* How many dots in one line. */
 163   int dot_spacing;              /* How many dots between spacings. */
 164
 165   bool delete_after;            /* Whether the files will be deleted
 166                                    after download. */
 167
 168   bool adjust_extension;                /* Use ".html" extension on all text/html? */
 169
 170   bool page_requisites;         /* Whether we need to download all files
 171                                    necessary to display a page properly. */
 172   char *bind_address;           /* What local IP address to bind to. */
 173
 174 #ifdef HAVE_SSL
 175   enum {
 176     secure_protocol_auto,
 177     secure_protocol_sslv2,
 178     secure_protocol_sslv3,
 179     secure_protocol_tlsv1
 180   } secure_protocol;            /* type of secure protocol to use. */
 181   bool check_cert;              /* whether to validate the server's cert */
 182   char *cert_file;              /* external client certificate to use. */
 183   char *private_key;            /* private key file (if not internal). */
 184   enum keyfile_type {
 185     keyfile_pem,
 186     keyfile_asn1
 187   } cert_type;                  /* type of client certificate file */
 188   enum keyfile_type
 189     private_key_type;           /* type of private key file */
 190
 191   char *ca_directory;           /* CA directory (hash files) */
 192   char *ca_cert;                /* CA certificate file to use */
 193
 194
 195   char *random_file;            /* file with random data to seed the PRNG */
 196   char *egd_file;               /* file name of the egd daemon socket */
 197 #endif /* HAVE_SSL */
 198
 199   bool cookies;                 /* whether cookies are used. */
 200   char *cookies_input;          /* file we're loading the cookies from. */
 201   char *cookies_output;         /* file we're saving the cookies to. */
 202   bool keep_session_cookies;    /* whether session cookies should be
 203                                    saved and loaded. */
 204
 205   char *post_data;              /* POST query string */
 206   char *post_file_name;         /* File to post */
 207
 208   enum {
 209     restrict_unix,
 210     restrict_windows
 211   } restrict_files_os;          /* file name restriction ruleset. */
 212   bool restrict_files_ctrl;     /* non-zero if control chars in URLs
 213                                    are restricted from appearing in
 214                                    generated file names. */
 215   bool restrict_files_nonascii; /* non-zero if bytes with values greater
 216                                    than 127 are restricted. */
 217   enum {
 218     restrict_no_case_restriction,
 219     restrict_lowercase,
 220     restrict_uppercase
 221   } restrict_files_case;        /* file name case restriction. */
 222
 223   bool strict_comments;         /* whether strict SGML comments are
 224                                    enforced.  */
 225
 226   bool preserve_perm;           /* whether remote permissions are used
 227                                   or that what is set by umask. */
 228
 229 #ifdef ENABLE_IPV6
 230   bool ipv4_only;               /* IPv4 connections have been requested. */
 231   bool ipv6_only;               /* IPv4 connections have been requested. */
 232 #endif
 233   enum {
 234     prefer_ipv4,
 235     prefer_ipv6,
 236     prefer_none
 237   } prefer_family;              /* preferred address family when more
 238                                    than one type is available */
 239
 240   bool content_disposition;     /* Honor HTTP Content-Disposition header. */
 241   bool auth_without_challenge;  /* Issue Basic authentication creds without
 242                                    waiting for a challenge. */
 243
 244   bool enable_iri;
 245   char *encoding_remote;
 246   char *locale;
 247
 248   bool trustservernames;
 249 #ifdef __VMS
 250   int ftp_stmlf;                /* Force Stream_LF format for binary FTP. */
 251 #endif /* def __VMS */
 252
 253   bool useservertimestamps;     /* Update downloaded files' timestamps to
 254                                    match those on server? */
 255
 256 };
 257
 258 extern struct options opt;