xref: /openbsd-src/usr.bin/tftp/tftp.1 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\"	$OpenBSD: tftp.1,v 1.6 2000/03/11 21:40:04 aaron Exp $
2.\"	$NetBSD: tftp.1,v 1.5 1995/08/18 14:45:44 pk Exp $
3.\"
4.\" Copyright (c) 1990, 1993, 1994
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"     @(#)tftp.1	8.2 (Berkeley) 4/18/94
36.\"
37.Dd April 18, 1994
38.Dt TFTP 1
39.Os
40.Sh NAME
41.Nm tftp
42.Nd trivial file transfer program
43.Sh SYNOPSIS
44.Nm tftp
45.Op Ar host
46.Sh DESCRIPTION
47.Nm
48is the user interface to the Internet
49.Tn TFTP
50(Trivial File Transfer Protocol),
51which allows users to transfer files to and from a remote machine.
52The remote
53.Ar host
54may be specified on the command line, in which case
55.Nm
56uses
57.Ar host
58as the default host for future transfers (see the
59.Ic connect
60command below).
61.Sh COMMANDS
62Once
63.Nm
64is running, it issues the prompt
65.Ql tftp>
66and recognizes the following commands:
67.Pp
68.Bl -tag -width verbose -compact
69.It Ic \&? Ar command-name Op Ar ...
70Print help information.
71.Pp
72.It Ic ascii
73Shorthand for
74.Ic mode ascii .
75.Pp
76.It Ic binary
77Shorthand for
78.Ic mode binary .
79.Pp
80.It Ic connect Ar host Op Ar port
81Set the
82.Ar host
83(and optionally
84.Ar port )
85for transfers.
86Note that the
87.Tn TFTP
88protocol, unlike the
89.Tn FTP
90protocol,
91does not maintain connections between transfers; thus, the
92.Ic connect
93command does not actually create a connection,
94but merely remembers what host is to be used for transfers.
95You do not have to use the
96.Ic connect
97command; the remote host can be specified as part of the
98.Ic get
99or
100.Ic put
101commands.
102.Pp
103.It Ic get Ar filename
104.It Ic get Ar remotename localname
105.It Ic get Ar file Op Ar ...
106Get a file or set of files from the specified
107.Ar sources .
108.Ar source
109can be in one of two forms:
110a filename on the remote host, if the host has already been specified,
111or a string of the form
112.Ar hosts:filename
113to specify both a host and filename at the same time.
114If the latter form is used,
115the last hostname specified becomes the default for future transfers.
116.Pp
117.It Ic mode Ar transfer-mode
118Set the mode for transfers;
119.Ar transfer-mode
120may be one of
121.Ic ascii
122or
123.Ic binary .
124The default is
125.Ic ascii .
126.Pp
127.It Ic put Ar file
128.It Ic put Ar localfile remotefile
129.It Ic put Ar file1 file2 ... fileN remote-directory
130Put a file or set of files to the specified
131remote file or directory.
132The destination
133can be in one of two forms:
134a filename on the remote host, if the host has already been specified,
135or a string of the form
136.Ar hosts:filename
137to specify both a host and filename at the same time.
138If the latter form is used,
139the hostname specified becomes the default for future transfers.
140If the remote-directory form is used, the remote host is
141assumed to be a
142.Tn UNIX
143machine.
144.Pp
145.It Ic quit
146Exit
147.Nm tftp .
148An end-of-file also exits.
149.Pp
150.It Ic rexmt Ar retransmission-timeout
151Set the per-packet retransmission timeout, in seconds.
152.Pp
153.It Ic status
154Show current status.
155.Pp
156.It Ic timeout Ar total-transmission-timeout
157Set the total transmission timeout, in seconds.
158.Pp
159.It Ic trace
160Toggle packet tracing.
161.Pp
162.It Ic verbose
163Toggle verbose mode.
164.El
165.Sh SEE ALSO
166.Xr ftp 1
167.Sh HISTORY
168The
169.Nm
170command appeared in
171.Bx 4.3 .
172.Sh BUGS
173Because there is no user login or validation within
174the
175.Tn TFTP
176protocol, the remote site will probably have some
177sort of file access restrictions in place.
178The exact methods are specific to each site and therefore
179difficult to document here.
180