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

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