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

   1 /* struct options.
   2    Copyright (C) 1996-2006 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 3 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, see <http://www.gnu.org/licenses/>.
  18
  19 In addition, as a special exception, the Free Software Foundation
  20 gives permission to link the code of its release of Wget with the
  21 OpenSSL project's "OpenSSL" library (or with modified versions of it
  22 that use the same license as the "OpenSSL" library), and distribute
  23 the linked executables.  You must obey the GNU General Public License
  24 in all respects for all of the code used other than "OpenSSL".  If you
  25 modify this file, you may extend this exception to your version of the
  26 file, but you are not obligated to do so.  If you do not wish to do
  27 so, delete this exception statement from your version.  */
  28
  29 struct options
  30 {
  31   int verbose;                  /* Are we verbose?  (First set to -1,
  32                                    hence not boolean.) */
  33   bool quiet;                   /* Are we quiet? */
  34   int ntry;                     /* Number of tries per URL */
  35   bool retry_connrefused;       /* Treat CONNREFUSED as non-fatal. */
  36   bool background;              /* Whether we should work in background. */
  37   bool ignore_length;           /* Do we heed content-length at all?  */
  38   bool recursive;               /* Are we recursive? */
  39   bool spanhost;                /* Do we span across hosts in
  40                                    recursion? */
  41   int  max_redirect;            /* Maximum number of times we'll allow
  42                                    a page to redirect. */
  43   bool relative_only;           /* Follow only relative links. */
  44   bool no_parent;               /* Restrict access to the parent
  45                                    directory.  */
  46   int reclevel;                 /* Maximum level of recursion */
  47   bool dirstruct;               /* Do we build the directory structure
  48                                   as we go along? */
  49   bool no_dirstruct;            /* Do we hate dirstruct? */
  50   int cut_dirs;                 /* Number of directory components to cut. */
  51   bool add_hostdir;             /* Do we add hostname directory? */
  52   bool protocol_directories;    /* Whether to prepend "http"/"ftp" to dirs. */
  53   bool noclobber;               /* Disables clobbering of existing
  54                                    data. */
  55   char *dir_prefix;             /* The top of directory tree */
  56   char *lfilename;              /* Log filename */
  57   char *input_filename;         /* Input filename */
  58   bool force_html;              /* Is the input file an HTML file? */
  59
  60   bool spider;                  /* Is Wget in spider mode? */
  61
  62   char **accepts;               /* List of patterns to accept. */
  63   char **rejects;               /* List of patterns to reject. */
  64   char **excludes;              /* List of excluded FTP directories. */
  65   char **includes;              /* List of FTP directories to
  66                                    follow. */
  67   bool ignore_case;             /* Whether to ignore case when
  68                                    matching dirs and files */
  69
  70   char **domains;               /* See host.c */
  71   char **exclude_domains;
  72   bool dns_cache;               /* whether we cache DNS lookups. */
  73
  74   char **follow_tags;           /* List of HTML tags to recursively follow. */
  75   char **ignore_tags;           /* List of HTML tags to ignore if recursing. */
  76
  77   bool follow_ftp;              /* Are FTP URL-s followed in recursive
  78                                    retrieving? */
  79   bool retr_symlinks;           /* Whether we retrieve symlinks in
  80                                    FTP. */
  81   char *output_document;        /* The output file to which the
  82                                    documents will be printed.  */
  83
  84   char *user;                   /* Generic username */
  85   char *passwd;                 /* Generic password */
  86
  87   bool always_rest;             /* Always use REST. */
  88   char *ftp_user;               /* FTP username */
  89   char *ftp_passwd;             /* FTP password */
  90   bool netrc;                   /* Whether to read .netrc. */
  91   bool ftp_glob;                /* FTP globbing */
  92   bool ftp_pasv;                        /* Passive FTP. */
  93
  94   char *http_user;              /* HTTP username. */
  95   char *http_passwd;            /* HTTP password. */
  96   char **user_headers;          /* User-defined header(s). */
  97   bool http_keep_alive;         /* whether we use keep-alive */
  98
  99   bool use_proxy;               /* Do we use proxy? */
 100   bool allow_cache;             /* Do we allow server-side caching? */
 101   char *http_proxy, *ftp_proxy, *https_proxy;
 102   char **no_proxy;
 103   char *base_href;
 104   char *progress_type;          /* progress indicator type. */
 105   char *proxy_user; /*oli*/
 106   char *proxy_passwd;
 107
 108   double read_timeout;          /* The read/write timeout. */
 109   double dns_timeout;           /* The DNS timeout. */
 110   double connect_timeout;       /* The connect timeout. */
 111
 112   bool random_wait;             /* vary from 0 .. wait secs by random()? */
 113   double wait;                  /* The wait period between retrievals. */
 114   double waitretry;             /* The wait period between retries. - HEH */
 115   bool use_robots;              /* Do we heed robots.txt? */
 116
 117   wgint limit_rate;             /* Limit the download rate to this
 118                                    many bps. */
 119   SUM_SIZE_INT quota;           /* Maximum file size to download and
 120                                    store. */
 121
 122   int numurls;                  /* Number of successfully downloaded
 123                                    URLs #### should be removed because
 124                                    it's not a setting, but a global var */
 125
 126   bool server_response;         /* Do we print server response? */
 127   bool save_headers;            /* Do we save headers together with
 128                                    file? */
 129
 130 #ifdef ENABLE_DEBUG
 131   bool debug;                   /* Debugging on/off */
 132 #endif
 133
 134 #ifdef MSDOS
 135   bool wdebug;                  /* Watt-32 tcp/ip debugging on/off */
 136 #endif
 137
 138   bool timestamping;            /* Whether to use time-stamping. */
 139
 140   bool backup_converted;        /* Do we save pre-converted files as *.orig? */
 141   bool backups;                 /* Are numeric backups made? */
 142
 143   char *useragent;              /* User-Agent string, which can be set
 144                                    to something other than Wget. */
 145   char *referer;                /* Naughty Referer, which can be
 146                                    set to something other than
 147                                    NULL. */
 148   bool convert_links;           /* Will the links be converted
 149                                    locally? */
 150   bool remove_listing;          /* Do we remove .listing files
 151                                    generated by FTP? */
 152   bool htmlify;                 /* Do we HTML-ify the OS-dependent
 153                                    listings? */
 154
 155   char *dot_style;
 156   wgint dot_bytes;              /* How many bytes in a printing
 157                                    dot. */
 158   int dots_in_line;             /* How many dots in one line. */
 159   int dot_spacing;              /* How many dots between spacings. */
 160
 161   bool delete_after;            /* Whether the files will be deleted
 162                                    after download. */
 163
 164   bool html_extension;          /* Use ".html" extension on all text/html? */
 165
 166   bool page_requisites;         /* Whether we need to download all files
 167                                    necessary to display a page properly. */
 168   char *bind_address;           /* What local IP address to bind to. */
 169
 170 #ifdef HAVE_SSL
 171   enum {
 172     secure_protocol_auto,
 173     secure_protocol_sslv2,
 174     secure_protocol_sslv3,
 175     secure_protocol_tlsv1
 176   } secure_protocol;            /* type of secure protocol to use. */
 177   bool check_cert;              /* whether to validate the server's cert */
 178   char *cert_file;              /* external client certificate to use. */
 179   char *private_key;            /* private key file (if not internal). */
 180   enum keyfile_type {
 181     keyfile_pem,
 182     keyfile_asn1
 183   } cert_type;                  /* type of client certificate file */
 184   enum keyfile_type
 185     private_key_type;           /* type of private key file */
 186
 187   char *ca_directory;           /* CA directory (hash files) */
 188   char *ca_cert;                /* CA certificate file to use */
 189
 190
 191   char *random_file;            /* file with random data to seed the PRNG */
 192   char *egd_file;               /* file name of the egd daemon socket */
 193 #endif /* HAVE_SSL */
 194
 195   bool cookies;                 /* whether cookies are used. */
 196   char *cookies_input;          /* file we're loading the cookies from. */
 197   char *cookies_output;         /* file we're saving the cookies to. */
 198   bool keep_session_cookies;    /* whether session cookies should be
 199                                    saved and loaded. */
 200
 201   char *post_data;              /* POST query string */
 202   char *post_file_name;         /* File to post */
 203
 204   enum {
 205     restrict_unix,
 206     restrict_windows
 207   } restrict_files_os;          /* file name restriction ruleset. */
 208   bool restrict_files_ctrl;     /* non-zero if control chars in URLs
 209                                    are restricted from appearing in
 210                                    generated file names. */
 211   enum {
 212     restrict_no_case_restriction,
 213     restrict_lowercase,
 214     restrict_uppercase
 215   } restrict_files_case;        /* file name case restriction. */
 216
 217   bool strict_comments;         /* whether strict SGML comments are
 218                                    enforced.  */
 219
 220   bool preserve_perm;           /* whether remote permissions are used
 221                                   or that what is set by umask. */
 222
 223 #ifdef ENABLE_IPV6
 224   bool ipv4_only;               /* IPv4 connections have been requested. */
 225   bool ipv6_only;               /* IPv4 connections have been requested. */
 226 #endif
 227   enum {
 228     prefer_ipv4,
 229     prefer_ipv6,
 230     prefer_none
 231   } prefer_family;              /* preferred address family when more
 232                                    than one type is available */
 233
 234   bool content_disposition;     /* Honor HTTP Content-Disposition header. */
 235 };
 236
 237 extern struct options opt;