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, 2011 Free Software Foundation,
   4    Inc.
   5
   6 This file is part of GNU Wget.
   7
   8 GNU Wget is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 3 of the License, or
  11 (at your option) any later version.
  12
  13 GNU Wget is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with Wget.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 Additional permission under GNU GPL version 3 section 7
  22
  23 If you modify this program, or any covered work, by linking or
  24 combining it with the OpenSSL project's OpenSSL library (or a
  25 modified version of that library), containing parts covered by the
  26 terms of the OpenSSL or SSLeay licenses, the Free Software Foundation
  27 grants you additional permission to convey the resulting work.
  28 Corresponding Source for a non-source form of such a combination
  29 shall include the source code for the parts of OpenSSL used as well
  30 as that of the covered work.  */
  31
  32 struct options
  33 {
  34   int verbose;                  /* Are we verbose?  (First set to -1,
  35                                    hence not boolean.) */
  36   bool quiet;                   /* Are we quiet? */
  37   int ntry;                     /* Number of tries per URL */
  38   bool retry_connrefused;       /* Treat CONNREFUSED as non-fatal. */
  39   bool background;              /* Whether we should work in background. */
  40   bool ignore_length;           /* Do we heed content-length at all?  */
  41   bool recursive;               /* Are we recursive? */
  42   bool spanhost;                /* Do we span across hosts in
  43                                    recursion? */
  44   int  max_redirect;            /* Maximum number of times we'll allow
  45                                    a page to redirect. */
  46   bool relative_only;           /* Follow only relative links. */
  47   bool no_parent;               /* Restrict access to the parent
  48                                    directory.  */
  49   int reclevel;                 /* Maximum level of recursion */
  50   bool dirstruct;               /* Do we build the directory structure
  51                                   as we go along? */
  52   bool no_dirstruct;            /* Do we hate dirstruct? */
  53   int cut_dirs;                 /* Number of directory components to cut. */
  54   bool add_hostdir;             /* Do we add hostname directory? */
  55   bool protocol_directories;    /* Whether to prepend "http"/"ftp" to dirs. */
  56   bool noclobber;               /* Disables clobbering of existing
  57                                    data. */
  58   bool unlink;                  /* remove file before clobbering */
  59   char *dir_prefix;             /* The top of directory tree */
  60   char *lfilename;              /* Log filename */
  61   char *input_filename;         /* Input filename */
  62   char *choose_config;          /* Specified config file */
  63   bool noconfig;
  64   bool force_html;              /* Is the input file an HTML file? */
  65
  66   char *default_page;           /* Alternative default page (index file) */
  67
  68   bool spider;                  /* Is Wget in spider mode? */
  69
  70   char **accepts;               /* List of patterns to accept. */
  71   char **rejects;               /* List of patterns to reject. */
  72   char **excludes;              /* List of excluded FTP directories. */
  73   char **includes;              /* List of FTP directories to
  74                                    follow. */
  75   bool ignore_case;             /* Whether to ignore case when
  76                                    matching dirs and files */
  77
  78   char *acceptregex_s;          /* Patterns to accept (a regex string). */
  79   char *rejectregex_s;          /* Patterns to reject (a regex string). */
  80   void *acceptregex;            /* Patterns to accept (a regex struct). */
  81   void *rejectregex;            /* Patterns to reject (a regex struct). */
  82   enum {
  83 #ifdef HAVE_LIBPCRE
  84     regex_type_pcre,
  85 #endif
  86     regex_type_posix
  87   } regex_type;   /* The regex library. */
  88   void *(*regex_compile_fun)(const char *);  /* Function to compile a regex. */
  89   bool (*regex_match_fun)(const void *, const char *);  /* Function to match a string to a regex. */
  90
  91   char **domains;               /* See host.c */
  92   char **exclude_domains;
  93   bool dns_cache;               /* whether we cache DNS lookups. */
  94
  95   char **follow_tags;           /* List of HTML tags to recursively follow. */
  96   char **ignore_tags;           /* List of HTML tags to ignore if recursing. */
  97
  98   bool follow_ftp;              /* Are FTP URL-s followed in recursive
  99                                    retrieving? */
 100   bool retr_symlinks;           /* Whether we retrieve symlinks in
 101                                    FTP. */
 102   char *output_document;        /* The output file to which the
 103                                    documents will be printed.  */
 104   char *warc_filename;          /* WARC output filename */
 105   char *warc_tempdir;   /* WARC temp dir */
 106   char *warc_cdx_dedup_filename;        /* CDX file to be used for deduplication. */
 107   wgint warc_maxsize;           /* WARC max archive size */
 108   bool warc_compression_enabled;  /* For GZIP compression. */
 109   bool warc_digests_enabled;  /* For SHA1 digests. */
 110   bool warc_cdx_enabled;      /* Create CDX files? */
 111   bool warc_keep_log;         /* Store the log file in a WARC record. */
 112   char **warc_user_headers;             /* User-defined WARC header(s). */
 113
 114   char *user;                   /* Generic username */
 115   char *passwd;                 /* Generic password */
 116   bool ask_passwd;              /* Ask for password? */
 117
 118   bool always_rest;             /* Always use REST. */
 119   char *ftp_user;               /* FTP username */
 120   char *ftp_passwd;             /* FTP password */
 121   bool netrc;                   /* Whether to read .netrc. */
 122   bool ftp_glob;                /* FTP globbing */
 123   bool ftp_pasv;                        /* Passive FTP. */
 124
 125   char *http_user;              /* HTTP username. */
 126   char *http_passwd;            /* HTTP password. */
 127   char **user_headers;          /* User-defined header(s). */
 128   bool http_keep_alive;         /* whether we use keep-alive */
 129
 130   bool use_proxy;               /* Do we use proxy? */
 131   bool allow_cache;             /* Do we allow server-side caching? */
 132   char *http_proxy, *ftp_proxy, *https_proxy;
 133   char **no_proxy;
 134   char *base_href;
 135   char *progress_type;          /* progress indicator type. */
 136   char *proxy_user; /*oli*/
 137   char *proxy_passwd;
 138
 139   double read_timeout;          /* The read/write timeout. */
 140   double dns_timeout;           /* The DNS timeout. */
 141   double connect_timeout;       /* The connect timeout. */
 142
 143   bool random_wait;             /* vary from 0 .. wait secs by random()? */
 144   double wait;                  /* The wait period between retrievals. */
 145   double waitretry;             /* The wait period between retries. - HEH */
 146   bool use_robots;              /* Do we heed robots.txt? */
 147
 148   wgint limit_rate;             /* Limit the download rate to this
 149                                    many bps. */
 150   SUM_SIZE_INT quota;           /* Maximum file size to download and
 151                                    store. */
 152
 153   bool server_response;         /* Do we print server response? */
 154   bool save_headers;            /* Do we save headers together with
 155                                    file? */
 156   bool content_on_error;        /* Do we output the content when the HTTP
 157                                    status code indicates a server error */
 158
 159   bool debug;                   /* Debugging on/off */
 160
 161 #ifdef USE_WATT32
 162   bool wdebug;                  /* Watt-32 tcp/ip debugging on/off */
 163 #endif
 164
 165   bool timestamping;            /* Whether to use time-stamping. */
 166
 167   bool backup_converted;        /* Do we save pre-converted files as *.orig? */
 168   int backups;                  /* Are numeric backups made? */
 169
 170   char *useragent;              /* User-Agent string, which can be set
 171                                    to something other than Wget. */
 172   char *referer;                /* Naughty Referer, which can be
 173                                    set to something other than
 174                                    NULL. */
 175   bool convert_links;           /* Will the links be converted
 176                                    locally? */
 177   bool remove_listing;          /* Do we remove .listing files
 178                                    generated by FTP? */
 179   bool htmlify;                 /* Do we HTML-ify the OS-dependent
 180                                    listings? */
 181
 182   char *dot_style;
 183   wgint dot_bytes;              /* How many bytes in a printing
 184                                    dot. */
 185   int dots_in_line;             /* How many dots in one line. */
 186   int dot_spacing;              /* How many dots between spacings. */
 187
 188   bool delete_after;            /* Whether the files will be deleted
 189                                    after download. */
 190
 191   bool adjust_extension;                /* Use ".html" extension on all text/html? */
 192
 193   bool page_requisites;         /* Whether we need to download all files
 194                                    necessary to display a page properly. */
 195   char *bind_address;           /* What local IP address to bind to. */
 196
 197 #ifdef HAVE_SSL
 198   enum {
 199     secure_protocol_auto,
 200     secure_protocol_sslv2,
 201     secure_protocol_sslv3,
 202     secure_protocol_tlsv1,
 203     secure_protocol_pfs
 204   } secure_protocol;            /* type of secure protocol to use. */
 205   bool check_cert;              /* whether to validate the server's cert */
 206   char *cert_file;              /* external client certificate to use. */
 207   char *private_key;            /* private key file (if not internal). */
 208   enum keyfile_type {
 209     keyfile_pem,
 210     keyfile_asn1
 211   } cert_type;                  /* type of client certificate file */
 212   enum keyfile_type
 213     private_key_type;           /* type of private key file */
 214
 215   char *ca_directory;           /* CA directory (hash files) */
 216   char *ca_cert;                /* CA certificate file to use */
 217
 218   char *random_file;            /* file with random data to seed the PRNG */
 219   char *egd_file;               /* file name of the egd daemon socket */
 220   bool https_only;              /* whether to follow HTTPS only */
 221 #endif /* HAVE_SSL */
 222
 223   bool cookies;                 /* whether cookies are used. */
 224   char *cookies_input;          /* file we're loading the cookies from. */
 225   char *cookies_output;         /* file we're saving the cookies to. */
 226   bool keep_session_cookies;    /* whether session cookies should be
 227                                    saved and loaded. */
 228
 229   char *post_data;              /* POST query string */
 230   char *post_file_name;         /* File to post */
 231   char *method;                 /* HTTP Method to use in Header */
 232   char *body_data;              /* HTTP Method Data String */
 233   char *body_file;              /* HTTP Method File */
 234
 235   enum {
 236     restrict_unix,
 237     restrict_windows
 238   } restrict_files_os;          /* file name restriction ruleset. */
 239   bool restrict_files_ctrl;     /* non-zero if control chars in URLs
 240                                    are restricted from appearing in
 241                                    generated file names. */
 242   bool restrict_files_nonascii; /* non-zero if bytes with values greater
 243                                    than 127 are restricted. */
 244   enum {
 245     restrict_no_case_restriction,
 246     restrict_lowercase,
 247     restrict_uppercase
 248   } restrict_files_case;        /* file name case restriction. */
 249
 250   bool strict_comments;         /* whether strict SGML comments are
 251                                    enforced.  */
 252
 253   bool preserve_perm;           /* whether remote permissions are used
 254                                   or that what is set by umask. */
 255
 256 #ifdef ENABLE_IPV6
 257   bool ipv4_only;               /* IPv4 connections have been requested. */
 258   bool ipv6_only;               /* IPv4 connections have been requested. */
 259 #endif
 260   enum {
 261     prefer_ipv4,
 262     prefer_ipv6,
 263     prefer_none
 264   } prefer_family;              /* preferred address family when more
 265                                    than one type is available */
 266
 267   bool content_disposition;     /* Honor HTTP Content-Disposition header. */
 268   bool auth_without_challenge;  /* Issue Basic authentication creds without
 269                                    waiting for a challenge. */
 270
 271   bool enable_iri;
 272   char *encoding_remote;
 273   char *locale;
 274
 275   bool trustservernames;
 276 #ifdef __VMS
 277   int ftp_stmlf;                /* Force Stream_LF format for binary FTP. */
 278 #endif /* def __VMS */
 279
 280   bool useservertimestamps;     /* Update downloaded files' timestamps to
 281                                    match those on server? */
 282
 283   bool show_all_dns_entries; /* Show all the DNS entries when resolving a
 284                                 name. */
 285   bool report_bps;              /*Output bandwidth in bits format*/
 286 };
 287
 288 extern struct options opt;