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

   1 /* struct options.
   2    Copyright (C) 1995, 1996, 1997 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
  18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, 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
  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   bool timestamping;            /* Whether to use time-stamping. */
 135
 136   bool backup_converted;        /* Do we save pre-converted files as *.orig? */
 137   bool backups;                 /* Are numeric backups made? */
 138
 139   char *useragent;              /* User-Agent string, which can be set
 140                                    to something other than Wget. */
 141   char *referer;                /* Naughty Referer, which can be
 142                                    set to something other than
 143                                    NULL. */
 144   bool convert_links;           /* Will the links be converted
 145                                    locally? */
 146   bool remove_listing;          /* Do we remove .listing files
 147                                    generated by FTP? */
 148   bool htmlify;                 /* Do we HTML-ify the OS-dependent
 149                                    listings? */
 150
 151   char *dot_style;
 152   wgint dot_bytes;              /* How many bytes in a printing
 153                                    dot. */
 154   int dots_in_line;             /* How many dots in one line. */
 155   int dot_spacing;              /* How many dots between spacings. */
 156
 157   bool delete_after;            /* Whether the files will be deleted
 158                                    after download. */
 159
 160   bool html_extension;          /* Use ".html" extension on all text/html? */
 161
 162   bool page_requisites;         /* Whether we need to download all files
 163                                    necessary to display a page properly. */
 164   char *bind_address;           /* What local IP address to bind to. */
 165
 166 #ifdef HAVE_SSL
 167   enum {
 168     secure_protocol_auto,
 169     secure_protocol_sslv2,
 170     secure_protocol_sslv3,
 171     secure_protocol_tlsv1
 172   } secure_protocol;            /* type of secure protocol to use. */
 173   bool check_cert;              /* whether to validate the server's cert */
 174   char *cert_file;              /* external client certificate to use. */
 175   char *private_key;            /* private key file (if not internal). */
 176   enum keyfile_type {
 177     keyfile_pem,
 178     keyfile_asn1
 179   } cert_type;                  /* type of client certificate file */
 180   enum keyfile_type
 181     private_key_type;           /* type of private key file */
 182
 183   char *ca_directory;           /* CA directory (hash files) */
 184   char *ca_cert;                /* CA certificate file to use */
 185
 186
 187   char *random_file;            /* file with random data to seed the PRNG */
 188   char *egd_file;               /* file name of the egd daemon socket */
 189 #endif /* HAVE_SSL */
 190
 191   bool cookies;                 /* whether cookies are used. */
 192   char *cookies_input;          /* file we're loading the cookies from. */
 193   char *cookies_output;         /* file we're saving the cookies to. */
 194   bool keep_session_cookies;    /* whether session cookies should be
 195                                    saved and loaded. */
 196
 197   char *post_data;              /* POST query string */
 198   char *post_file_name;         /* File to post */
 199
 200   enum {
 201     restrict_unix,
 202     restrict_windows
 203   } restrict_files_os;          /* file name restriction ruleset. */
 204   bool restrict_files_ctrl;     /* non-zero if control chars in URLs
 205                                    are restricted from appearing in
 206                                    generated file names. */
 207
 208   bool strict_comments;         /* whether strict SGML comments are
 209                                    enforced.  */
 210
 211   bool preserve_perm;           /* whether remote permissions are used
 212                                   or that what is set by umask. */
 213
 214 #ifdef ENABLE_IPV6
 215   bool ipv4_only;               /* IPv4 connections have been requested. */
 216   bool ipv6_only;               /* IPv4 connections have been requested. */
 217 #endif
 218   enum {
 219     prefer_ipv4,
 220     prefer_ipv6,
 221     prefer_none
 222   } prefer_family;              /* preferred address family when more
 223                                    than one type is available */
 224 };
 225
 226 extern struct options opt;