Base revisions
[ntk/apt.git] / doc / ftp.conf.5
1 .\" This manpage is copyright (C) 1998 Branden Robinson <branden@debian.org>
2 .\" and Manoj Srivastava <srivasta@datasync.com>.
3 .\"
4 .\" This is free software; you may redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as
6 .\" published by the Free Software Foundation; either version 2,
7 .\" or (at your option) any later version.
8 .\"
9 .\" This is distributed in the hope that it will be useful, but
10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 .\" GNU General Public License for more details.
13 .\"
14 .\" You should have received a copy of the GNU General Public
15 .\" License along with APT; if not, write to the Free Software
16 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17 .\" 02111-1307 USA
18 .TH ftp.conf 5 "16 June 1998" "Debian GNU/Linux"
19 .SH NAME
20 ftp.conf \- configuration file for APT FTP method
21 .SH DESCRIPTION
22 The ftp.conf file determines the behavior of the FTP method for the APT
23 packaging tool. The syntax of the file is
24 .IR variable = value .
25 Quotes are not required around
26 .IR value s.
27 Comments start with a '#' and end at the next newline. Blank lines are
28 ignored. The following
29 .I variables
30 are understood:
31 .IP Firewall
32 is the hostname of a machine which acts as an FTP firewall. This can be
33 overridden by an environment variable
34 .IR FTP_FIREWALL .
35 If specified, and the given hostname cannot be directly contacted, a connection
36 is made to the firewall machine and the string
37 .B @hostname
38 is appended to the login identifier. This type of setup is also known as an
39 FTP proxy.
40 .IP ProxyLogName
41 is a parameter used by some firewall FTP proxies. It is used to authorize
42 the user specified by
43 .I ProxyLogName
44 to send data beyond the
45 .I Firewall
46 machine.
47 .IP ProxyPassword
48 is the password used to authenticate
49 .I ProxyLogName
50 on the
51 .I Firewall
52 machine.
53 .IP TimeOut
54 sets a timeout value in seconds (the default is sixty seconds).
55 .IP Passive
56 is either
57 .B true
58 or
59 .BR false .
60 If true, then all data transfers will be done using passive mode. This is
61 required for some dumb FTP servers and firewall configurations. It can
62 also be overridden by the environment variable
63 .IR FTP_PASSIVE .
64 .IP Verbose
65 is either
66 .B true
67 or
68 .B false,
69 and makes the FTP method output more data than it normally does.
70 .IP Debug
71 is either
72 .B true
73 or
74 .B false,
75 and makes the FTP method output debugging information. This variable is
76 not currently implemented.
77 .IP MaxReTry
78 sets the number of times a connection is re-tried before giving up (the
79 default is twice).
80 .SH SEE ALSO
81 .BR apt (8),
82 .BR apt-get (8)
83 .SH BUGS
84 See <http://www.debian.org/Bugs/db/pa/lapt.html>. If you wish to report a
85 bug in
86 .BR apt-get ,
87 please see
88 .I /usr/doc/debian/bug-reporting.txt
89 or the
90 .BR bug (1)
91 command.
92 .SH AUTHOR
93 APT was written by the APT team <apt@packages.debian.org>.