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: src/usr.bin/tftp/tftp.1,v 1.4.2.7 2002/06/21 15:29:33 charnier Exp $
  34 .\"
  35 .Dd April 18, 1994
  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
  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-name 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 Ar filename
 101 .It Cm get Ar remotename localname
 102 .It Cm get Ar file1 file2 ...  fileN
 103 Get a file or set of files from the specified
 104 .Ar sources .
 105 .Ar Source
 106 can be in one of two forms:
 107 a filename on the remote host, if the host has already been specified,
 108 or a string of the form
 109 .Ar hosts:filename
 110 to specify both a host and filename at the same time.
 111 If the latter form is used,
 112 the last hostname specified becomes the default for future transfers.
 113 .Pp
 114 .It Cm mode Ar transfer-mode
 115 Set the mode for transfers;
 116 .Ar transfer-mode
 117 may be one of
 118 .Em ascii
 119 or
 120 .Em binary .
 121 The default is
 122 .Em ascii .
 123 .Pp
 124 .It Cm put Ar file
 125 .It Cm put Ar localfile remotefile
 126 .It Cm put Ar file1 file2 ... fileN remote-directory
 127 Put a file or set of files to the specified
 128 remote file or directory.
 129 The destination
 130 can be in one of two forms:
 131 a filename on the remote host, if the host has already been specified,
 132 or a string of the form
 133 .Ar hosts:filename
 134 to specify both a host and filename at the same time.
 135 If the latter form is used,
 136 the hostname specified becomes the default for future transfers.
 137 If the remote-directory form is used, the remote host is
 138 assumed to be a
 139 .Tn UNIX
 140 machine.
 141 If you need to specify IPv6 numeric address to
 142 .Ar hosts ,
 143 wrap them using square bracket like
 144 .Ar [hosts]:filename
 145 to disambiguate the colon.
 146 .Pp
 147 .It Cm quit
 148 Exit
 149 .Nm .
 150 An end of file also exits.
 151 .Pp
 152 .It Cm rexmt Ar retransmission-timeout
 153 Set the per-packet retransmission timeout, in seconds.
 154 .Pp
 155 .It Cm status
 156 Show current status.
 157 .Pp
 158 .It Cm timeout Ar total-transmission-timeout
 159 Set the total transmission timeout, in seconds.
 160 .Pp
 161 .It Cm trace
 162 Toggle packet tracing.
 163 .Pp
 164 .It Cm verbose
 165 Toggle verbose mode.
 166 .El
 167 .Sh BUGS
 168 Because there is no user-login or validation within
 169 the
 170 .Tn TFTP
 171 protocol, the remote site will probably have some
 172 sort of file-access restrictions in place.  The
 173 exact methods are specific to each site and therefore
 174 difficult to document here.
 175 .Pp
 176 Files larger than 33488896 octets (65535 blocks) cannot be transferred
 177 without client and server supporting blocksize negotiation (RFC1783).
 178 .Sh HISTORY
 179 The
 180 .Nm
 181 command appeared in
 182 .Bx 4.3 .