usr.bin/tftp/tftp.1

   1 .\" Copyright (c) 1990, 1993, 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)tftp.1      8.2 (Berkeley) 4/18/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd October 1, 2003
  36 .Dt TFTP 1
  37 .Os
  38 .Sh NAME
  39 .Nm tftp
  40 .Nd trivial file transfer program
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Ar host Op Ar port
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility is the user interface to the Internet
  48 .Tn TFTP
  49 (Trivial File Transfer Protocol),
  50 which allows users to transfer files to and from a remote machine.
  51 The remote
  52 .Ar host
  53 may be specified on the command line, in which case
  54 .Nm
  55 uses
  56 .Ar host
  57 as the default host for future transfers (see the
  58 .Cm connect
  59 command below).
  60 .Sh COMMANDS
  61 Once
  62 .Nm
  63 is running, it issues the prompt
  64 .Dq Li tftp>
  65 and recognizes the following commands:
  66 .Pp
  67 .Bl -tag -width verbose -compact
  68 .It Cm \&? Ar command-name ...
  69 Print help information.
  70 .Pp
  71 .It Cm ascii
  72 Shorthand for "mode ascii"
  73 .Pp
  74 .It Cm binary
  75 Shorthand for "mode binary"
  76 .Pp
  77 .It Cm connect Ar host Op Ar port
  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
  89 .Cm connect
  90 command does not actually create a connection,
  91 but merely remembers what host is to be used for transfers.
  92 You do not have to use the
  93 .Cm connect
  94 command; the remote host can be specified as part of the
  95 .Cm get
  96 or
  97 .Cm put
  98 commands.
  99 .Pp
 100 .It Cm get Oo Ar host : Oc Ns Ar file Op Ar localname
 101 .It Cm get Xo
 102 .Oo Ar host1 : Oc Ns Ar file1
 103 .Oo Ar host2 : Oc Ns Ar file2 ...
 104 .Oo Ar hostN : Oc Ns Ar fileN
 105 .Xc
 106 Get one or more files from the remote host.
 107 When using the
 108 .Ar host
 109 argument, the
 110 .Ar host
 111 will be used as default host for future transfers.
 112 If
 113 .Ar localname
 114 is specified, the file is stored locally as
 115 .Ar localname ,
 116 otherwise the original filename is used.
 117 Note that it is not possible to download two files at a time, only
 118 one, three, or more than three files, at a time.
 119 .Pp
 120 To specify an IPv6 numeric address for a host, wrap it using square
 121 brackets like
 122 .Dq Li [3ffe:2900:e00c:ffee::1234] : Ns Ar file
 123 to disambiguate the
 124 colons used in the IPv6 address from the colon separating the host and
 125 the filename.
 126 .Pp
 127 .It Cm mode Ar transfer-mode
 128 Set the mode for transfers;
 129 .Ar transfer-mode
 130 may be one of
 131 .Em ascii
 132 or
 133 .Em binary .
 134 The default is
 135 .Em ascii .
 136 .Pp
 137 .It Cm put Ar file Op Oo Ar host : Oc Ns Ar remotename
 138 .It Cm put Ar file1 file2 ... fileN Op Oo Ar host : Oc Ns Ar remote-directory
 139 Put a file or set of files to the remote host.
 140 When
 141 .Ar remotename
 142 is specified, the file is stored remotely as
 143 .Ar remotename ,
 144 otherwise the original filename is used.
 145 If the
 146 .Ar remote-directory
 147 argument is used, the remote host is assumed to be a
 148 .Ux
 149 machine.
 150 To specify an IPv6 numeric address for a
 151 .Ar host ,
 152 see the example under the
 153 .Cm get
 154 command.
 155 .Pp
 156 .It Cm quit
 157 Exit
 158 .Nm .
 159 An end of file also exits.
 160 .Pp
 161 .It Cm rexmt Ar retransmission-timeout
 162 Set the per-packet retransmission timeout, in seconds.
 163 .Pp
 164 .It Cm status
 165 Show current status.
 166 .Pp
 167 .It Cm timeout Ar total-transmission-timeout
 168 Set the total transmission timeout, in seconds.
 169 .Pp
 170 .It Cm trace
 171 Toggle packet tracing.
 172 .Pp
 173 .It Cm verbose
 174 Toggle verbose mode.
 175 .El
 176 .Sh HISTORY
 177 The
 178 .Nm
 179 command appeared in
 180 .Bx 4.3 .
 181 .Sh BUGS
 182 Because there is no user-login or validation within
 183 the
 184 .Tn TFTP
 185 protocol, the remote site will probably have some
 186 sort of file-access restrictions in place.
 187 The
 188 exact methods are specific to each site and therefore
 189 difficult to document here.
 190 .Pp
 191 Files larger than 33488896 octets (65535 blocks) cannot be transferred
 192 without client and server supporting blocksize negotiation (RFC1783).