1 .\" Copyright (c) 1996 Jordan Hubbard (jkh@FreeBSD.org)
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY JORDAN HUBBARD ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $FreeBSD: src/lib/libftpio/ftpio.3,v 1.21.2.9 2002/12/29 16:35:35 schweikh Exp $
26 .\" $DragonFly: src/lib/libftpio/ftpio.3,v 1.4 2007/09/14 19:47:03 swildner Exp $
47 .Nd FTPIO user library
53 .Fn ftpLogin "char *host" "char *user" "char *passwd" "int ftp_port" "int verbose" "int *retcode"
55 .Fn ftpChdir "FILE *stream" "char *dirname"
57 .Fn ftpErrno "FILE *stream"
59 .Fn ftpErrString "int errno"
61 .Fn ftpGetModtime "FILE *stream" "char *file"
63 .Fn ftpGetSize "FILE *stream" "char *file"
65 .Fn ftpGet "FILE *stream" "char *file" "off_t *seekto"
67 .Fn ftpPut "FILE *stream" "char *file"
69 .Fn ftpAscii "FILE *stream"
71 .Fn ftpBinary "FILE *stream"
73 .Fn ftpPassive "FILE *stream" "int status"
75 .Fn ftpVerbose "FILE *stream" "int status"
77 .Fn ftpGetURL "char *url" "char *user" "char *passwd" "int *retcode"
79 .Fn ftpPutURL "char *url" "char *user" "char *passwd" "int *retcode"
81 .Fn ftpLoginAf "char *host" "int af" "char *user" "char *passwd" "int ftp_port" "int verbose" "int *retcode"
83 .Fn ftpGetURLAf "char *url" "int af" "char *user" "char *passwd" "int *retcode"
85 .Fn ftpPutURLAf "char *url" "int af" "char *user" "char *passwd" "int *retcode"
87 These functions implement a high-level library for managing FTP connections.
90 attempts to log in using the supplied
96 defaults to the standard ftp port of 21) and
98 fields. If it is successful, a
99 standard stream descriptor is returned which should be passed to
100 subsequent FTP operations.
101 On failure, NULL is returned and
103 will have the error code returned by the foreign server.
106 attempts to issue a server CD command to the directory named in
108 On success, zero is returned. On failure, the error code from the server.
111 returns the server failure code for the last operation (useful for seeing
112 more about what happened if you're familiar with FTP error codes).
114 returns a human readable version of the supplied server failure code.
117 attempts to retrieve the file named by the
119 argument (which is assumed to be relative to the FTP server's current directory,
122 and returns a new FILE* pointer for the file or NULL on failure. If
124 is non-NULL, the contents of the integer it points to will be used
125 as a restart point for the file, that is to say that the stream
128 bytes into the file gotten (this is handy for restarting failed
129 transfers efficiently). If the seek operation fails, the value
135 returns the last modification time of the file named by the
137 argument. If the file could not be opened or stat'd, 0 is returned.
140 returns the size in bytes of the file named by the
142 argument. If the file could not be opened or stat'd, -1 is returned.
145 attempts to create a new file named by the
147 argument (which is assumed to be relative to the FTP server's current directory,
152 pointer for the file or NULL on failure.
155 sets ASCII mode for the current server connection named by
159 sets binary mode for the current server connection named by
163 sets passive mode (for firewalls) for the current server connection named by
169 sets the verbosity mode for the current server connection named by
175 attempts to retrieve the file named by the supplied
177 and can be considered equivalent to the combined
182 operations except that no server
184 is ever returned - the connection to the server closes when
185 the file has been completely read. Use the lower-level routines
186 if multiple gets are required as it will be far more efficient.
189 attempts to create the file named by the supplied
191 and can be considered equivalent to the combined
196 operations except that no server stream is ever returned - the connection
197 to the server closes when the file has been completely written. Use the
198 lower-level routines if multiple puts are required as it will be far more
208 except that they are able to specify address family
211 .Bl -tag -width FTP_PASSIVE_MODE -offset 3n
213 Maximum time, in seconds, to wait for a response
214 from the peer before aborting an
217 .It Ev FTP_PASSIVE_MODE
218 If defined, forces the use of passive mode, unless equal
219 to ``NO'' or ``no'' in which case active mode is forced.
220 If defined, the setting of this variable always overrides any calls to
224 Started life as Poul-Henning Kamp's ftp driver for the system installation
225 utility, later significantly mutated into a more general form as an
226 extension of stdio by Jordan Hubbard. Also incorporates some ideas and
227 extensions from Jean-Marc Zucconi.
230 .An Poul-Henning Kamp
232 .An Jean-Marc Zucconi
234 I'm sure you can get this thing's internal state machine confused if
235 you really work at it, but so far it's proven itself pretty robust in