From da2ac85f4063a8990f68dfadcfd47e53c0b63bf1 Mon Sep 17 00:00:00 2001 From: Micah Cowan Date: Sun, 26 Jul 2009 21:50:19 -0700 Subject: [PATCH] Documentation fixes for IRI options, and rename --locale -> --local-encoding. --- doc/ChangeLog | 6 +++ doc/wget.texi | 91 +++++++++++++++++++-------------- src/ChangeLog | 6 +++ src/init.c | 2 +- src/main.c | 8 ++- tests/ChangeLog | 7 +++ tests/Test-ftp-iri-disabled.px | 2 +- tests/Test-ftp-iri-fallback.px | 2 +- tests/Test-ftp-iri-recursive.px | 2 +- tests/Test-ftp-iri.px | 2 +- tests/Test-idn-cmd.px | 2 +- tests/Test-idn-robots.px | 2 +- 12 files changed, 85 insertions(+), 47 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 862ed129..d67305e3 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2009-07-26 Micah Cowan + + * wget.texi (Download Options): Change --iri item to --no-iri; + rename --locale to --local-encoding. + (Wgetrc Commands): Document iri, local_encoding, remote_encoding. + 2009-07-06 Micah Cowan * wget.texi (Logging and Input File Options): Alter description of diff --git a/doc/wget.texi b/doc/wget.texi index f040e8dc..7af747dd 100644 --- a/doc/wget.texi +++ b/doc/wget.texi @@ -683,30 +683,6 @@ Another instance where you'll get a garbled file if you try to use Note that @samp{-c} only works with @sc{ftp} servers and with @sc{http} servers that support the @code{Range} header. -@cindex iri support -@cindex idn support -@item --iri - -Turn on internationalized URI (IRI) support. Use @samp{--no-iri} to -turn it off. IRI support is activated by default. - -You can set the default state of IRI support using @code{iri} command in -@file{.wgetrc}. That setting may be overridden from the command line. - -@cindex local encoding -@cindex locale -@item --locale=@var{encoding} - -Force Wget to use @var{encoding} as the default system encoding. That affects -how Wget converts URLs specified as arguments from locale to @sc{utf-8} for -IRI support. - -Wget use the function @code{nl_langinfo()} and then the @code{CHARSET} -environment variable to get the locale. If it fails, @sc{ascii} is used. - -You can set the default locale using the @code{locale} command in -@file{.wgetrc}. That setting may be overridden from the command line. - @cindex progress indicator @cindex dot style @item --progress=@var{type} @@ -738,21 +714,6 @@ command line. The exception is that, when the output is not a TTY, the ``dot'' progress will be favored over ``bar''. To force the bar output, use @samp{--progress=bar:force}. -@cindex remote encoding -@item --remote-encoding=@var{encoding} - -Force Wget to use encoding as the default remote server encoding. That -affects how Wget converts URIs found in files from remote encoding to -@sc{utf-8} during a recursive fetch. This options is only useful for -IRI support, for the interpretation of non-@sc{ascii} characters. - -For HTTP, remote encoding can be found in HTTP @code{Content-Type} -header and in HTML @code{Content-Type http-equiv} meta tag. - -You can set the default encoding using the @code{remoteencoding} -command in @file{.wgetrc}. That setting may be overridden from the -command line. - @item -N @itemx --timestamping Turn on time-stamping. @xref{Time-Stamping}, for details. @@ -1044,6 +1005,46 @@ options for @sc{http} connections. @item --ask-password Prompt for a password for each connection established. Cannot be specified when @samp{--password} is being used, because they are mutually exclusive. + +@cindex iri support +@cindex idn support +@item --no-iri + +Turn off internationalized URI (IRI) support. Use @samp{--iri} to +turn it on. IRI support is activated by default. + +You can set the default state of IRI support using the @code{iri} +command in @file{.wgetrc}. That setting may be overridden from the +command line. + +@cindex local encoding +@item --local-encoding=@var{encoding} + +Force Wget to use @var{encoding} as the default system encoding. That affects +how Wget converts URLs specified as arguments from locale to @sc{utf-8} for +IRI support. + +Wget use the function @code{nl_langinfo()} and then the @code{CHARSET} +environment variable to get the locale. If it fails, @sc{ascii} is used. + +You can set the default local encoding using the @code{local_encoding} +command in @file{.wgetrc}. That setting may be overridden from the +command line. + +@cindex remote encoding +@item --remote-encoding=@var{encoding} + +Force Wget to use @var{encoding} as the default remote server encoding. +That affects how Wget converts URIs found in files from remote encoding +to @sc{utf-8} during a recursive fetch. This options is only useful for +IRI support, for the interpretation of non-@sc{ascii} characters. + +For HTTP, remote encoding can be found in HTTP @code{Content-Type} +header and in HTML @code{Content-Type http-equiv} meta tag. + +You can set the default encoding using the @code{remoteencoding} +command in @file{.wgetrc}. That setting may be overridden from the +command line. @end table @node Directory Options, HTTP Options, Download Options, Invoking @@ -2857,6 +2858,10 @@ Ignore certain @sc{html} tags when doing a recursive retrieval, like Specify a comma-separated list of directories you wish to follow when downloading---the same as @samp{-I @var{string}}. +@item iri = on/off +When set to on, enable internationalized URI (IRI) support; the same as +@samp{--iri}. + @item inet4_only = on/off Force connecting to IPv4 addresses, off by default. You can put this in the global init file to disable Wget's attempts to resolve and @@ -2878,6 +2883,10 @@ The same as @samp{--limit-rate=@var{rate}}. @item load_cookies = @var{file} Load cookies from @var{file}. See @samp{--load-cookies @var{file}}. +@item local_encoding = @var{encoding} +Force Wget to use @var{encoding} as the default system encoding. See +@samp{--local-encoding}. + @item logfile = @var{file} Set logfile to @var{file}, the same as @samp{-o @var{file}}. @@ -2997,6 +3006,10 @@ the @sc{http} spec who got the spelling of ``referrer'' wrong.) Follow only relative links---the same as @samp{-L} (@pxref{Relative Links}). +@item remote_encoding = @var{encoding} +Force Wget to use @var{encoding} as the default remote server encoding. +See @samp{--remote-encoding}. + @item remove_listing = on/off If set to on, remove @sc{ftp} listings downloaded by Wget. Setting it to off is the same as @samp{--no-remove-listing}. diff --git a/src/ChangeLog b/src/ChangeLog index fa5e7b32..0568b4b3 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,9 @@ +2009-07-26 Micah Cowan + + * main.c (option_data): Rename --locale option to --local-encoding + (print_help): Document --no-iri, --local-encoding, and + --remote-encoding, within usage message. + 2009-07-23 Micah Cowan * progress.c (get_eta): Change "Translation note" in comment to diff --git a/src/init.c b/src/init.c index d7479069..d14ccfe4 100644 --- a/src/init.c +++ b/src/init.c @@ -184,7 +184,7 @@ static const struct { { "keepsessioncookies", &opt.keep_session_cookies, cmd_boolean }, { "limitrate", &opt.limit_rate, cmd_bytes }, { "loadcookies", &opt.cookies_input, cmd_file }, - { "locale", &opt.locale, cmd_string }, + { "localencoding", &opt.locale, cmd_string }, { "logfile", &opt.lfilename, cmd_file }, { "login", &opt.ftp_user, cmd_string },/* deprecated*/ { "maxredirect", &opt.max_redirect, cmd_number }, diff --git a/src/main.c b/src/main.c index e3b92fb0..a896b835 100644 --- a/src/main.c +++ b/src/main.c @@ -215,7 +215,7 @@ static struct cmdline_option option_data[] = { "level", 'l', OPT_VALUE, "reclevel", -1 }, { "limit-rate", 0, OPT_VALUE, "limitrate", -1 }, { "load-cookies", 0, OPT_VALUE, "loadcookies", -1 }, - { "locale", 0, OPT_VALUE, "locale", -1 }, + { "local-encoding", 0, OPT_VALUE, "localencoding", -1 }, { "max-redirect", 0, OPT_VALUE, "maxredirect", -1 }, { "mirror", 'm', OPT_BOOLEAN, "mirror", -1 }, { "no", 'n', OPT__NO, NULL, required_argument }, @@ -501,6 +501,12 @@ Download:\n"), --password=PASS set both ftp and http password to PASS.\n"), N_("\ --ask-password prompt for passwords.\n"), + N_("\ + --no-iri turn off IRI support.\n"), + N_("\ + --local-encoding=ENC use ENC as the local encoding for IRIs.\n"), + N_("\ + --remote-encoding=ENC use ENC as the default remote encoding.\n"), "\n", N_("\ diff --git a/tests/ChangeLog b/tests/ChangeLog index ff970ac1..d1a8af8b 100644 --- a/tests/ChangeLog +++ b/tests/ChangeLog @@ -1,3 +1,10 @@ +2009-07-26 Micah Cowan + + * Test-ftp-iri.px, Test-ftp-iri-fallback.px, + Test-ftp-iri-recursive.px, Test-ftp-iri-disabled.px, + Test-idn-cmd.px, Test-idn-robots.px: Adjust wget invocations, + replacing --locale with --local-encoding. + 2009-07-07 Steven Schubiger * Makefile.am: Add IDN/IRI test files and Test-meta-robots.px diff --git a/tests/Test-ftp-iri-disabled.px b/tests/Test-ftp-iri-disabled.px index 76330b1a..17bb85c8 100755 --- a/tests/Test-ftp-iri-disabled.px +++ b/tests/Test-ftp-iri-disabled.px @@ -28,7 +28,7 @@ my %urls = ( }, ); -my $cmdline = $WgetTest::WGETPATH . " --no-iri --locale=iso-8859-1 -S ftp://localhost:{{port}}/fran${ccedilla_l1}ais.txt"; +my $cmdline = $WgetTest::WGETPATH . " --no-iri --local-encoding=iso-8859-1 -S ftp://localhost:{{port}}/fran${ccedilla_l1}ais.txt"; my $expected_error_code = 0; diff --git a/tests/Test-ftp-iri-fallback.px b/tests/Test-ftp-iri-fallback.px index 091fd008..f4857213 100755 --- a/tests/Test-ftp-iri-fallback.px +++ b/tests/Test-ftp-iri-fallback.px @@ -24,7 +24,7 @@ my %urls = ( }, ); -my $cmdline = $WgetTest::WGETPATH . " --locale=iso-8859-1 -S ftp://localhost:{{port}}/fran${ccedilla_l1}ais.txt"; +my $cmdline = $WgetTest::WGETPATH . " --local-encoding=iso-8859-1 -S ftp://localhost:{{port}}/fran${ccedilla_l1}ais.txt"; my $expected_error_code = 0; diff --git a/tests/Test-ftp-iri-recursive.px b/tests/Test-ftp-iri-recursive.px index 95e9f312..5bbc8808 100755 --- a/tests/Test-ftp-iri-recursive.px +++ b/tests/Test-ftp-iri-recursive.px @@ -24,7 +24,7 @@ my %urls = ( }, ); -my $cmdline = $WgetTest::WGETPATH . " --locale=iso-8859-1 -r -nH -S ftp://localhost:{{port}}/"; +my $cmdline = $WgetTest::WGETPATH . " --local-encoding=iso-8859-1 -r -nH -S ftp://localhost:{{port}}/"; my $expected_error_code = 0; diff --git a/tests/Test-ftp-iri.px b/tests/Test-ftp-iri.px index 78e2622c..7bedb891 100755 --- a/tests/Test-ftp-iri.px +++ b/tests/Test-ftp-iri.px @@ -25,7 +25,7 @@ my %urls = ( }, ); -my $cmdline = $WgetTest::WGETPATH . " --locale=iso-8859-1 -S ftp://localhost:{{port}}/fran${ccedilla_l1}ais.txt"; +my $cmdline = $WgetTest::WGETPATH . " --local-encoding=iso-8859-1 -S ftp://localhost:{{port}}/fran${ccedilla_l1}ais.txt"; my $expected_error_code = 0; diff --git a/tests/Test-idn-cmd.px b/tests/Test-idn-cmd.px index 2f979624..822803ae 100755 --- a/tests/Test-idn-cmd.px +++ b/tests/Test-idn-cmd.px @@ -28,7 +28,7 @@ my %urls = ( ); my $cmdline = $WgetTest::WGETPATH . " --debug --iri -rH" - . " -e http_proxy=localhost:{{port}} --locale=EUC-JP $euc_jp_hostname"; + . " -e http_proxy=localhost:{{port}} --local-encoding=EUC-JP $euc_jp_hostname"; my $expected_error_code = 0; diff --git a/tests/Test-idn-robots.px b/tests/Test-idn-robots.px index bc9084ef..ff5033f0 100755 --- a/tests/Test-idn-robots.px +++ b/tests/Test-idn-robots.px @@ -48,7 +48,7 @@ my %urls = ( ); my $cmdline = $WgetTest::WGETPATH . " --debug --iri -rH" - . " -e http_proxy=localhost:{{port}} --locale=EUC-JP" + . " -e http_proxy=localhost:{{port}} --local-encoding=EUC-JP" . " http://$euc_jp_hostname/"; my $expected_error_code = 0; -- 2.39.2