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