You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by ja...@apache.org on 2018/08/18 07:44:18 UTC

svn commit: r1838313 - /httpd/httpd/trunk/docs/manual/mod/mod_proxy_ftp.xml

Author: jailletc36
Date: Sat Aug 18 07:44:17 2018
New Revision: 1838313

URL: http://svn.apache.org/viewvc?rev=1838313&view=rev
Log:
- Add some links.
- Remove the space in "character set" in the syntax of ProxyFtpDirCharset to avoid confusion (it is 1 parameter only)
- Use the correct syntax for the "default" values, so that they are parsed and correctly displayed in 'quickreference'
- Remove extra [] when directive's parameter are required

- correct the default password: apache-proxy@ instead of apache_proxy@.
This was silently changed in r88745, 17 years ago!

Modified:
    httpd/httpd/trunk/docs/manual/mod/mod_proxy_ftp.xml

Modified: httpd/httpd/trunk/docs/manual/mod/mod_proxy_ftp.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_proxy_ftp.xml?rev=1838313&r1=1838312&r2=1838313&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_proxy_ftp.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_proxy_ftp.xml Sat Aug 18 07:44:17 2018
@@ -52,12 +52,13 @@
     download via FTP?</title>
       <p>You probably don't have that particular file type defined as
       <code>application/octet-stream</code> in your proxy's mime.types
-      configuration file. A useful line can be</p>
+      configuration file. A useful line can be:</p>
 
       <example>
 <pre>application/octet-stream   bin dms lha lzh exe class tgz taz</pre>
       </example>
-    <p>Alternatively you may prefer to default everything to binary:</p>
+      <p>Alternatively you may prefer to use the <directive module="core">ForceType</directive>
+      directive to default everything to binary:</p>
       <example>
         <highlight language="config">
 ForceType application/octet-stream
@@ -66,7 +67,7 @@ ForceType application/octet-stream
     </section> <!-- /mimetypes -->
 
     <section id="type"><title>How can I force an FTP ASCII download of
-    File <var>xxx</var>?</title>
+    file <var>xxx</var>?</title>
       <p>In the rare situation where you must download a specific file using the
       FTP <code>ASCII</code> transfer method (while the default transfer is in
       <code>binary</code> mode), you can override <module>mod_proxy</module>'s
@@ -76,7 +77,7 @@ ForceType application/octet-stream
     </section> <!-- /type -->
 
     <section id="ftpnonget"><title>How can I do FTP upload?</title>
-    <p>Currently, only GET is supported for FTP in mod_proxy.  You can
+    <p>Currently, only GET is supported for FTP in <module>mod_proxy</module>.  You can
     of course use HTTP upload (POST or PUT) through an Apache proxy.</p>
     </section>
 
@@ -108,7 +109,7 @@ ForceType application/octet-stream
 
       <example>
         user: anonymous<br />
-        password: apache_proxy@
+        password: apache-proxy@
       </example>
 
       <p>This works for all popular FTP servers which are configured for
@@ -153,15 +154,15 @@ ForceType application/octet-stream
         a directory, or contains wildcard characters ("*?[{~"), then it
         guesses that a listing is wanted instead of a download.</p>
       <p>You can disable the special handling of names with wildcard characters.
-        See the <directive>ProxyFtpListOnWildcard</directive> directive.
+        See the <directive module="mod_proxy_ftp">ProxyFtpListOnWildcard</directive> directive.
       </p>
     </section> <!-- /wildcard -->
 
 <directivesynopsis>
 <name>ProxyFtpListOnWildcard</name>
 <description>Whether wildcards in requested filenames trigger a file listing</description>
-<syntax>ProxyFtpListOnWildcard [on|off]</syntax>
-<default>on</default>
+<syntax>ProxyFtpListOnWildcard on|off</syntax>
+<default>ProxyFtpListOnWildcard on</default>
 <contextlist><context>server config</context><context>virtual host</context>
   <context>directory</context></contextlist>
 <compatibility>Available in Apache 2.3.3 and later</compatibility>
@@ -171,7 +172,8 @@ ForceType application/octet-stream
     controls whether wildcard characters ("*?[{~") in requested
     filenames cause <module>mod_proxy_ftp</module> to return a listing
     of files instead of downloading a file.  By default (value on),
-    they do.  Set to "off" to allow downloading files even if they
+    they do.</p>
+    <p>Set to "off" to allow downloading files even if they
     have wildcard characters in their names.</p>
 </usage>
 </directivesynopsis>
@@ -179,8 +181,8 @@ ForceType application/octet-stream
 <directivesynopsis>
 <name>ProxyFtpEscapeWildcards</name>
 <description>Whether wildcards in requested filenames are escaped when sent to the FTP server</description>
-<syntax>ProxyFtpEscapeWildcards [on|off]</syntax>
-<default>on</default>
+<syntax>ProxyFtpEscapeWildcards on|off</syntax>
+<default>ProxyFtpEscapeWildcards on</default>
 <contextlist><context>server config</context><context>virtual host</context>
   <context>directory</context></contextlist>
 <compatibility>Available in Apache 2.3.3 and later</compatibility>
@@ -191,7 +193,7 @@ ForceType application/octet-stream
     filenames are escaped with backslash before sending them to the
     FTP server.  That is the default behavior, but many FTP servers
     don't know about the escaping and try to serve the literal filenames
-    they were sent, including the backslashes in the names.  </p>
+    they were sent, including the backslashes in the names.</p>
     <p>Set to "off" to allow downloading files with wildcards
     in their names from FTP servers that don't understand wildcard
     escaping.</p>
@@ -201,7 +203,7 @@ ForceType application/octet-stream
 <directivesynopsis>
 <name>ProxyFtpDirCharset</name>
 <description>Define the character set for proxied FTP listings</description>
-<syntax>ProxyFtpDirCharset <var>character set</var></syntax>
+<syntax>ProxyFtpDirCharset <var>character_set</var></syntax>
 <default>ProxyFtpDirCharset ISO-8859-1</default>
 <contextlist><context>server config</context><context>virtual host</context>
 <context>directory</context></contextlist>