[int13] Guard against BIOSes that "fix" the drive count
[people/sha0/gpxe.git] / contrib / tftp / tftp.1
1 .\" Copyright (c) 1986 The Regents of the University of California.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms are permitted
5 .\" provided that the above copyright notice and this paragraph are
6 .\" duplicated in all such forms and that any documentation,
7 .\" advertising materials, and other materials related to such
8 .\" distribution and use acknowledge that the software was developed
9 .\" by the University of California, Berkeley.  The name of the
10 .\" University may not be used to endorse or promote products derived
11 .\" from this software without specific prior written permission.
12 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
13 .\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
14 .\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
15 .\"
16 .\"     @(#)tftp.1      5.3 (Berkeley) 9/20/88
17 .\"
18 .TH TFTP 1 "September 20, 1988"
19 .UC 6
20 .SH NAME
21 tftp \- trivial file transfer program
22 .SH SYNOPSIS
23 .B tftp
24 [
25 host
26 ]
27 .SH DESCRIPTION
28 .I Tftp
29 is the user interface to the Internet TFTP
30 (Trivial File Transfer Protocol),
31 which allows users to transfer files to and from a remote machine.
32 The remote
33 .I host
34 may be specified on the command line, in which case
35 .I tftp
36 uses
37 .I host
38 as the default host for future transfers (see the
39 .B connect
40 command below).
41 .SH COMMANDS
42 Once
43 .I tftp
44 is running, it issues the prompt
45 .B tftp>
46 and recognizes the following commands:
47 .TP
48 \fBconnect\fP \fIhost-name\fP [ \fIport\fP ]
49 Set the
50 .I host
51 (and optionally
52 .IR port )
53 for transfers.
54 Note that the TFTP protocol, unlike the FTP protocol,
55 does not maintain connections betweeen transfers; thus, the
56 .I connect
57 command does not actually create a connection,
58 but merely remembers what host is to be used for transfers.
59 You do not have to use the 
60 .I connect
61 command; the remote host can be specified as part of the
62 .I get
63 or
64 .I put
65 commands.
66 .TP
67 \fBmode\fP \fItransfer-mode\fP
68 Set the mode for transfers; 
69 .I transfer-mode
70 may be one of
71 .IR ascii
72 or
73 .IR binary .
74 The default is
75 .IR ascii .
76 .TP
77 \fBput\fP \fIfile\fP
78 .ns
79 .TP
80 \fBput\fP \fIlocalfile remotefile\fP
81 .ns
82 .TP
83 \fBput\fP \fIfile1 file2 ... fileN remote-directory\fP
84 Put a file or set of files to the specified
85 remote file or directory.
86 The destination
87 can be in one of two forms:
88 a filename on the remote host, if the host has already been specified,
89 or a string of the form
90 .I host:filename
91 to specify both a host and filename at the same time.
92 If the latter form is used,
93 the hostname specified becomes the default for future transfers.
94 If the remote-directory form is used, the remote host is
95 assumed to be a
96 .I UNIX
97 machine.
98 .TP
99 \fBget\fP \fIfilename\fP
100 .ns
101 .TP
102 \fBget\fP \fIremotename\fP \fIlocalname\fP
103 .ns
104 .TP
105 \fBget\fP \fIfile1\fP \fIfile2\fP ... \fIfileN\fP
106 Get a file or set of files from the specified
107 .IR sources .
108 .I Source
109 can be in one of two forms:
110 a filename on the remote host, if the host has already been specified,
111 or a string of the form
112 .I host:filename
113 to specify both a host and filename at the same time.
114 If the latter form is used,
115 the last hostname specified becomes the default for future transfers.
116 .TP
117 .B quit
118 Exit
119 .IR tftp .
120 An end of file also exits.
121 .TP
122 .B verbose
123 Toggle verbose mode.
124 .TP
125 .B trace
126 Toggle packet tracing.
127 .TP
128 .B status
129 Show current status.
130 .TP
131 \fBrexmt\fP \fIretransmission-timeout\fP
132 Set the per-packet retransmission timeout, in seconds.
133 .TP
134 \fBtimeout\fP \fItotal-transmission-timeout\fP
135 Set the total transmission timeout, in seconds.
136 .TP
137 .B ascii
138 Shorthand for "mode ascii"
139 .TP
140 .B binary
141 Shorthand for "mode binary"
142 .TP
143 \fBblocksize\fP \fItransfer-blocksize\fP
144 Set the blocksize that is used for transfers. This assumes that the
145 server knows about RFC1782 and RFC1783 extensions to the TFTP
146 protocol; automatic fallback is supported and will result in a default
147 blocksize of 512 octets.
148 .TP
149 \fB?\fP \ [ \fIcommand-name\fP ... ]
150 Print help information.
151 .SH BUGS
152 .PP
153 Because there is no user-login or validation within
154 the
155 .I TFTP
156 protocol, the remote site will probably have some
157 sort of file-access restrictions in place.  The
158 exact methods are specific to each site and therefore
159 difficult to document here.