BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / tftp / tftp.1

diff --git a/usr/src/usr.bin/tftp/tftp.1 b/usr/src/usr.bin/tftp/tftp.1
index ab6fa19..c112fe4 100644 (file)
--- a/usr/src/usr.bin/tftp/tftp.1
+++ b/usr/src/usr.bin/tftp/tftp.1
@@ -1,155 +1,173 @@
 .\" Copyright (c) 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"     @(#)tftp.1     5.4 (Berkeley) 6/24/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH TFTP 1 "%Q"
-.UC 6
-.SH NAME
-tftp \- trivial file transfer program
-.SH SYNOPSIS
-.B tftp
-[
-host
-]
-.SH DESCRIPTION
-.I Tftp
-is the user interface to the Internet TFTP
+.\"     @(#)tftp.1     5.4 (Berkeley) 4/22/91
+.\"
+.Dd April 22, 1991
+.Dt TFTP 1
+.Os BSD 4.3
+.Sh NAME
+.Nm tftp
+.Nd trivial file transfer program
+.Sh SYNOPSIS
+.Nm tftp
+.Op Ar host
+.Sh DESCRIPTION
+.Nm Tftp
+is the user interface to the Internet
+.Tn TFTP

 (Trivial File Transfer Protocol),
 which allows users to transfer files to and from a remote machine.
 The remote
 (Trivial File Transfer Protocol),
 which allows users to transfer files to and from a remote machine.
 The remote

-.I host
+.Ar host

 may be specified on the command line, in which case
 may be specified on the command line, in which case

-.I tftp
+.Nm tftp

 uses
 uses

-.I host
+.Ar host

 as the default host for future transfers (see the
 as the default host for future transfers (see the

-.B connect
+.Cm connect

 command below).
 command below).

-.SH COMMANDS
+.Sh COMMANDS

 Once
 Once

-.I tftp
+.Nm tftp

 is running, it issues the prompt
 is running, it issues the prompt

-.B tftp>
+.LI tftp>

 and recognizes the following commands:
 and recognizes the following commands:

-.TP
-\fBconnect\fP \fIhost-name\fP [ \fIport\fP ]
+.Pp
+.Bl -tag -width verbose -compact
+.It Cm \&? Ar command-name ...
+Print help information.
+.Pp
+.It Cm ascii
+Shorthand for "mode ascii"
+.Pp
+.It Cm binary
+Shorthand for "mode binary"
+.Pp
+.It Cm connect Ar host-name Op Ar port

 Set the
 Set the

-.I host
+.Ar host

 (and optionally
 (and optionally

-.IR port )
+.Ar port )

 for transfers.
 for transfers.

-Note that the TFTP protocol, unlike the FTP protocol,
+Note that the
+.Tn TFTP
+protocol, unlike the
+.Tn FTP
+protocol,

 does not maintain connections betweeen transfers; thus, the
 does not maintain connections betweeen transfers; thus, the

-.I connect
+.Cm connect

 command does not actually create a connection,
 but merely remembers what host is to be used for transfers.
 You do not have to use the 
 command does not actually create a connection,
 but merely remembers what host is to be used for transfers.
 You do not have to use the 

-.I connect
+.Cm connect

 command; the remote host can be specified as part of the
 command; the remote host can be specified as part of the

-.I get
+.Cm get

 or
 or

-.I put
+.Cm put

 commands.
 commands.

-.TP
-\fBmode\fP \fItransfer-mode\fP
+.Pp
+.It Cm get Ar filename
+.It Cm get Ar remotename localname
+.It Cm get Ar file1 file2 ...  fileN
+Get a file or set of files from the specified
+.Ar sources .
+.Ar Source
+can be in one of two forms:
+a filename on the remote host, if the host has already been specified,
+or a string of the form
+.Ar hosts:filename
+to specify both a host and filename at the same time.
+If the latter form is used,
+the last hostname specified becomes the default for future transfers.
+.Pp
+.It Cm mode Ar transfer-mode

 Set the mode for transfers; 
 Set the mode for transfers; 

-.I transfer-mode
+.Ar transfer-mode

 may be one of
 may be one of

-.IR ascii
+.Em ascii

 or
 or

-.IR binary .
+.Em binary .

 The default is
 The default is

-.IR ascii .
-.TP
-\fBput\fP \fIfile\fP
-.ns
-.TP
-\fBput\fP \fIlocalfile remotefile\fP
-.ns
-.TP
-\fBput\fP \fIfile1 file2 ... fileN remote-directory\fP
+.Em ascii .
+.Pp
+.It Cm put Ar file
+.It Cm put Ar localfile remotefile
+.It Cm put Ar file1 file2 ... fileN remote-directory

 Put a file or set of files to the specified
 remote file or directory.
 The destination
 can be in one of two forms:
 a filename on the remote host, if the host has already been specified,
 or a string of the form
 Put a file or set of files to the specified
 remote file or directory.
 The destination
 can be in one of two forms:
 a filename on the remote host, if the host has already been specified,
 or a string of the form

-.I host:filename
+.Ar hosts:filename

 to specify both a host and filename at the same time.
 If the latter form is used,
 the hostname specified becomes the default for future transfers.
 If the remote-directory form is used, the remote host is
 assumed to be a
 to specify both a host and filename at the same time.
 If the latter form is used,
 the hostname specified becomes the default for future transfers.
 If the remote-directory form is used, the remote host is
 assumed to be a

-.I UNIX
+.Tn UNIX

 machine.
 machine.

-.TP
-\fBget\fP \fIfilename\fP
-.ns
-.TP
-\fBget\fP \fIremotename\fP \fIlocalname\fP
-.ns
-.TP
-\fBget\fP \fIfile1\fP \fIfile2\fP ... \fIfileN\fP
-Get a file or set of files from the specified
-.IR sources .
-.I Source
-can be in one of two forms:
-a filename on the remote host, if the host has already been specified,
-or a string of the form
-.I host:filename
-to specify both a host and filename at the same time.
-If the latter form is used,
-the last hostname specified becomes the default for future transfers.
-.TP
-.B quit
+.Pp
+.It Cm quit

 Exit
 Exit

-.IR tftp .
+.Nm tftp .

 An end of file also exits.
 An end of file also exits.

-.TP
-.B verbose
-Toggle verbose mode.
-.TP
-.B trace
-Toggle packet tracing.
-.TP
-.B status
-Show current status.
-.TP
-\fBrexmt\fP \fIretransmission-timeout\fP
+.Pp
+.It Cm rexmt Ar retransmission-timeout

 Set the per-packet retransmission timeout, in seconds.
 Set the per-packet retransmission timeout, in seconds.

-.TP
-\fBtimeout\fP \fItotal-transmission-timeout\fP
+.Pp
+.It Cm status
+Show current status.
+.Pp
+.It Cm timeout Ar total-transmission-timeout

 Set the total transmission timeout, in seconds.
 Set the total transmission timeout, in seconds.

-.TP
-.B ascii
-Shorthand for "mode ascii"
-.TP
-.B binary
-Shorthand for "mode binary"
-.TP
-\fB?\fP \ [ \fIcommand-name\fP ... ]
-Print help information.
-.SH BUGS
-.PP
+.Pp
+.It Cm trace
+Toggle packet tracing.
+.Pp
+.It Cm verbose
+Toggle verbose mode.
+.El
+.Sh BUGS
+.Pp

 Because there is no user-login or validation within
 the
 Because there is no user-login or validation within
 the

-.I TFTP
+.Tn TFTP

 protocol, the remote site will probably have some
 sort of file-access restrictions in place.  The
 exact methods are specific to each site and therefore
 difficult to document here.
 protocol, the remote site will probably have some
 sort of file-access restrictions in place.  The
 exact methods are specific to each site and therefore
 difficult to document here.

+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.3 .