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