FTP man page updates

Author: jgg
Date: 1999-03-15 23:05:49 GMT
FTP man page updates

2 files changed, 50 insertions, 15 deletions

diff --git a/doc/apt.conf.5.yo b/doc/apt.conf.5.yo
index 46220db5c..145be2294 100644
--- a/doc/apt.conf.5.yo
+++ b/doc/apt.conf.5.yo
@@ -105,6 +105,23 @@ remote server is not RFC conforming or buggy (such as Squid 2.0.2)
 Acquire::http::Pipeline-Depth can be a value from 0 to 5 indicating how many
 outstanding requests APT should send.
 
+dit(bf(ftp))
+FTP URis; ftp::Proxy is the default proxy server to use. It is in the 
+standard form of em(http://[[user][:pass]@]host[:port]/) and is overriden
+by the ftp_proxy environment variable. To use a ftp proxy you will have to
+set the ftp::ProxyLogin script in the configuration file. This entry 
+specifies the commands to send to tell the proxy server what to connect
+to. Please see em(/usr/doc/apt/examples/apt.conf) for an example of how 
+to do this. The subsitution variables available are $(PROXY_USER),
+$(PROXY_PASS), $(SITE_USER), $(SITE_PASS), $(SITE), and $(SITE_PORT). 
+Each is taken from it's respective URI component.
+
+Several settings are provided to control passive mode. Generally it is safe
+to leave passive mode on, it works in nearly every environment. However some
+situations require that passive mode be disabled and port mode ftp used
+instead. This can be done globally, for connections that go through a proxy
+or for a specific host (See the sample config file for examples)
+
 dit(bf(cdrom))
 CDROM URIs; the only setting for CDROM URIs is the mount point, cdrom::Mount
 which must be the mount point for the CDROM drive as specified in /etc/fstab.
@@ -180,7 +197,8 @@ Most of the options in the bf(debug) section are not interesting to the
 normal user, however bf(Debug::pkgProblemResolver) shows interesting
 output about the decisions dist-upgrade makes. bf(Debug::NoLocking)
 disables file locking so apt can do some operations as non-root and
-bf(Debug::pkgDPkgPM) will print out the command line for each dpkg invokation.
+bf(Debug::pkgDPkgPM) will print out the command line for each dpkg 
+invokation.
 
 manpagesection(EXAMPLES)
 bf(/usr/doc/apt/examples/apt.conf) contains a sample configuration file
diff --git a/doc/examples/apt.conf b/doc/examples/apt.conf
index d0078cddd..3895a57b5 100644
--- a/doc/examples/apt.conf
+++ b/doc/examples/apt.conf
@@ -1,4 +1,4 @@
-// $Id: apt.conf,v 1.27 1999/03/15 08:10:39 jgg Exp $
+// $Id: apt.conf,v 1.28 1999/03/15 23:05:49 jgg Exp $
 /* This file is an index of all APT configuration directives. It should
    NOT actually be used as a real config file, though it is a completely
    valid file.
@@ -16,15 +16,17 @@
 */
 
 // Options for APT in general
-APT {
+APT 
+{
   Architecture "i386";
   
   // Options for apt-get
-  Get {
+  Get 
+  {
      Download-Only "false";
      Simulate "false";
      Assume-Yes "false";
-     Force-Yes "false";  // I would never set this.
+     Force-Yes "false";             // I would never set this.
      Fix-Broken "false";  
      Fix-Missing "false";     
      Show-Upgraded "false";
@@ -32,11 +34,13 @@ APT {
      Print-URIs "false";
   };
 
-  Cache {
+  Cache 
+  {
      Important "false";
   };
-  
-  CDROM {
+
+  CDROM 
+  {
      Rename "false";
      NoMount "false";
      Fast "false";
@@ -45,7 +49,7 @@ APT {
 
   // Some general options
   Ingore-Hold "false";
-  Immediate-Configure "true";        // DO NOT turn this off, see the man page
+  Immediate-Configure "true";      // DO NOT turn this off, see the man page
 };
 
 // Options for the downloading routines
@@ -72,7 +76,8 @@ Acquire
     Proxy "ftp://127.0.0.1/";
     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 
-    // Required script to perform proxy login
+    /* Required script to perform proxy login. This example should work
+       for tisfwtk */
     ProxyLogin
     {
        "USER $(PROXY_USER)";
@@ -82,9 +87,12 @@ Acquire
     };
     
     Timeout "120";
+    
+    /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
+       is prefered if possible */
     Passive "true";
     Proxy::Passive "true";
-    Passive::http.us.debian.org "true"; // Specific per-host setting       
+    Passive::http.us.debian.org "true"; // Specific per-host setting
   };
   
   cdrom
@@ -130,28 +138,37 @@ Dir
 };
 
 // Things that effect the APT dselect method
-DSelect {
+DSelect 
+{
    Clean "auto";   // always|auto|prompt|never
    Options "-f";
    UpdateOptions "";
    PromptAfterUpdate "no";
 }
 
-DPkg {
+DPkg 
+{
+   // Probably don't want to set this one..
    Options {"--force-downgrade";}
+   
+   // Auto re-mounting of a readonly /usr
    Pre-Invoke {"mount -o remount,rw /usr";};
    Post-Invoke {"mount -o remount,ro /usr";};
+   
+   // Prevents daemons from getting cwd as something mountable (default)
    Run-Directory "/";
 }
 
 /* Options you can set to see some debugging text They corrispond to names
    of classes in the source code */
-Debug {
+Debug 
+{
   pkgProblemResolver "false";
   pkgAcquire "false";
   pkgAcquire::Worker "false";
   pkgDPkgPM "false";
   
   pkgInitialize "false";   // This one will dump the configuration space
-  NoLocking "false";   
+  NoLocking "false";
+  Acquire::Ftp "false";    // Show ftp command traffic
 }