Annotation of src/usr.bin/tftp/tftp.1, Revision 1.8
1.8 ! jmc 1: .\" $OpenBSD: tftp.1,v 1.7 2003/06/03 02:56:18 millert Exp $
1.1 deraadt 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.
1.7 millert 15: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 16: .\" may be used to endorse or promote products derived from this software
17: .\" without specific prior written permission.
18: .\"
19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29: .\" SUCH DAMAGE.
30: .\"
31: .\" @(#)tftp.1 8.2 (Berkeley) 4/18/94
32: .\"
33: .Dd April 18, 1994
34: .Dt TFTP 1
1.4 aaron 35: .Os
1.1 deraadt 36: .Sh NAME
37: .Nm tftp
38: .Nd trivial file transfer program
39: .Sh SYNOPSIS
40: .Nm tftp
41: .Op Ar host
1.8 ! jmc 42: .Op Ar port
1.1 deraadt 43: .Sh DESCRIPTION
1.6 aaron 44: .Nm
1.1 deraadt 45: is the user interface to the Internet
46: .Tn TFTP
47: (Trivial File Transfer Protocol),
48: which allows users to transfer files to and from a remote machine.
49: The remote
50: .Ar host
1.8 ! jmc 51: and
! 52: .Ar port
1.1 deraadt 53: may be specified on the command line, in which case
1.6 aaron 54: .Nm
1.8 ! jmc 55: uses them as the default for future transfers (see the
1.3 aaron 56: .Ic connect
1.1 deraadt 57: command below).
58: .Sh COMMANDS
59: Once
1.6 aaron 60: .Nm
1.1 deraadt 61: is running, it issues the prompt
62: .Ql tftp>
63: and recognizes the following commands:
64: .Pp
65: .Bl -tag -width verbose -compact
1.3 aaron 66: .It Ic \&? Ar command-name Op Ar ...
1.1 deraadt 67: Print help information.
68: .Pp
1.3 aaron 69: .It Ic ascii
70: Shorthand for
1.8 ! jmc 71: .Ic mode Ar ascii .
1.3 aaron 72: .Pp
73: .It Ic binary
74: Shorthand for
1.8 ! jmc 75: .Ic mode Ar binary .
1.1 deraadt 76: .Pp
1.3 aaron 77: .It Ic connect Ar host Op Ar port
1.1 deraadt 78: Set the
79: .Ar host
80: (and optionally
81: .Ar port )
82: for transfers.
83: Note that the
84: .Tn TFTP
85: protocol, unlike the
86: .Tn FTP
87: protocol,
88: does not maintain connections between transfers; thus, the
1.3 aaron 89: .Ic connect
1.1 deraadt 90: command does not actually create a connection,
91: but merely remembers what host is to be used for transfers.
1.4 aaron 92: You do not have to use the
1.3 aaron 93: .Ic connect
1.1 deraadt 94: command; the remote host can be specified as part of the
1.3 aaron 95: .Ic get
1.1 deraadt 96: or
1.3 aaron 97: .Ic put
1.1 deraadt 98: commands.
99: .Pp
1.8 ! jmc 100: .It Xo
! 101: .Ic get Oo Ar host Ns : Oc Ns
! 102: .Ar file Op Ar localname
! 103: .Xc
! 104: .It Xo
! 105: .Ic get Oo Ar host1 Ns : Oc Ns
! 106: .Ar file1
! 107: .Oo Ar host2 Ns : Oc Ns
! 108: .Ar file2
! 109: .Ar ...
! 110: .Oo Ar hostN Ns : Oc Ns
! 111: .Ar fileN
! 112: .Xc
! 113: Get a file or set of files from the remote host.
! 114: When using the
! 115: .Ar host
! 116: argument, the
! 117: .Ar host
! 118: will be used as the default host for future transfers.
! 119: If
! 120: .Ar localname
! 121: is specified,
! 122: the file is stored locally as
! 123: .Ar localname ,
! 124: otherwise the original filename is used.
! 125: .Pp
! 126: Note that it is not possible to download two files at the same time;
! 127: only one, three, or more than three files
! 128: can be downloaded at the same time.
1.1 deraadt 129: .Pp
1.3 aaron 130: .It Ic mode Ar transfer-mode
1.4 aaron 131: Set the mode for transfers;
1.1 deraadt 132: .Ar transfer-mode
133: may be one of
1.8 ! jmc 134: .Ar ascii
1.1 deraadt 135: or
1.8 ! jmc 136: .Ar binary .
1.1 deraadt 137: The default is
1.8 ! jmc 138: .Ar ascii .
1.1 deraadt 139: .Pp
1.8 ! jmc 140: .It Xo
! 141: .Ic put Ar file
! 142: .Oo Oo Ar host Ns : Oc Ns
! 143: .Ar remotename Oc
! 144: .Xc
! 145: .It Xo
! 146: .Ic put Ar file1 file2 ... fileN
! 147: .Oo Oo Ar host Ns : Oc Ns
! 148: .Ar remote-directory Oc
! 149: .Xc
! 150: Put a file or set of files to the remote host.
! 151: When using the
! 152: .Ar host
! 153: argument, the
! 154: .Ar host
! 155: will be used as the default host for future transfers.
! 156: If
! 157: .Ar remotename
! 158: is specified, the file is stored remotely as
! 159: .Ar remotename ,
! 160: otherwise the original filename is used.
! 161: If the
! 162: .Ar remote-directory
! 163: argument is used, the remote host is assumed to be a
1.1 deraadt 164: .Tn UNIX
165: machine.
166: .Pp
1.8 ! jmc 167: Note that files may only be written to if they already exist on the
! 168: remote host and are publicly writable.
! 169: See
! 170: .Xr tftpd 8
! 171: for further details.
! 172: .Pp
1.3 aaron 173: .It Ic quit
1.1 deraadt 174: Exit
175: .Nm tftp .
1.3 aaron 176: An end-of-file also exits.
1.1 deraadt 177: .Pp
1.3 aaron 178: .It Ic rexmt Ar retransmission-timeout
1.1 deraadt 179: Set the per-packet retransmission timeout, in seconds.
180: .Pp
1.3 aaron 181: .It Ic status
1.1 deraadt 182: Show current status.
183: .Pp
1.3 aaron 184: .It Ic timeout Ar total-transmission-timeout
1.1 deraadt 185: Set the total transmission timeout, in seconds.
186: .Pp
1.3 aaron 187: .It Ic trace
1.1 deraadt 188: Toggle packet tracing.
189: .Pp
1.3 aaron 190: .It Ic verbose
1.1 deraadt 191: Toggle verbose mode.
192: .El
1.5 aaron 193: .Sh SEE ALSO
1.8 ! jmc 194: .Xr ftp 1 ,
! 195: .Xr tftpd 8
1.5 aaron 196: .Sh HISTORY
197: The
198: .Nm
199: command appeared in
200: .Bx 4.3 .
1.1 deraadt 201: .Sh BUGS
1.3 aaron 202: Because there is no user login or validation within
1.1 deraadt 203: the
204: .Tn TFTP
205: protocol, the remote site will probably have some
1.6 aaron 206: sort of file access restrictions in place.
207: The exact methods are specific to each site and therefore
1.1 deraadt 208: difficult to document here.
1.8 ! jmc 209: .Pp
! 210: Files larger than 33488896 octets (65535 blocks) cannot be transferred
! 211: without client and server supporting blocksize negotiation (RFC 1783).
! 212: .Pp
! 213: Many tftp clients will not transfer files over 16744448 octets (32767 blocks).
![[BACK]](/icons/back.gif){kind=icon}
Return to tftp.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / tftp