Substantially revamp the man pages, revert to "man" macro set.

tftp/tftp.1

@@ -1,8 +1,10 @@
-.\"	$OpenBSD: tftp.1,v 1.4 1999/06/05 01:21:43 aaron Exp $
+.\" -*- nroff -*- --------------------------------------------------------- *
-.\"	$NetBSD: tftp.1,v 1.5 1995/08/18 14:45:44 pk Exp $
+.\" $Id$
-.\"
+.\"  
 .\" Copyright (c) 1990, 1993, 1994
-.\"	The Regents of the University of California.  All rights reserved.
+.\"     The Regents of the University of California.  All rights reserved.
+.\"
+.\" Copyright 2001 H. Peter Anvin - All Rights Reserved
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
@@ -12,11 +14,7 @@
 .\" 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
+.\" 3. Neither the name of the University nor the names of its contributors
-.\"    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.
 .\"
@@ -32,146 +30,148 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\"     @(#)tftp.1	8.2 (Berkeley) 4/18/94
+.\"----------------------------------------------------------------------- */
-.\"
+.TH TFTP 1 "13 November 2001" "tftp-hpa" "UNIX User's Manual"
-.Dd April 18, 1994
+.SH NAME
-.Dt TFTP 1
+.B tftp
-.Os
+\- IPv4 Trivial File Transfer Protocol client
-.Sh NAME
+.SH SYNOPSIS
-.Nm tftp
+.B tftp
-.Nd trivial file transfer program
+.RI [ options... ]
-.Sh SYNOPSIS
+.RI [ host ]
-.Nm tftp
+.br
-.Op Ar host
+.SH DESCRIPTION
-.Sh DESCRIPTION
+.B tftp
-.Nm tftp
+is a client for the IPv4 Trivial file Transfer Protocol, which can be
-is the user interface to the Internet
+used to transfer files to and from remote machines, including some
-.Tn TFTP
+very minimalistic, usually embedded, systems.  The remote
-(Trivial File Transfer Protocol),
+.I host
-which allows users to transfer files to and from a remote machine.
-The remote
-.Ar host
 may be specified on the command line, in which case
-.Nm tftp
+.B tftp
 uses
-.Ar host
+.I host
 as the default host for future transfers (see the
-.Ic connect
+.B connect
-command below).
+command below.)
-.Sh COMMANDS
+.SH OPTIONS
+.TP
+.B \-v
+Default to verbose mode.
+.TP
+.B \-V
+Print the version number to standard output, then exit gracefully.
+.SH COMMANDS
 Once
-.Nm tftp
+.B tftp
 is running, it issues the prompt
-.Ql tftp>
+\f(CWtftp>\fP
 and recognizes the following commands:
-.Pp
+.TP
-.Bl -tag -width verbose -compact
+\fB?\fP \fIcommand-name...\fP
-.It Ic \&? Ar command-name Op Ar ...
+.TP
-Print help information.
+\fBhelp\fP \fIcommand-name...\fP
-.Pp
+Print help information
-.It Ic ascii
+.TP
+.B ascii
 Shorthand for
-.Ic mode ascii .
+.BR "mode ascii" .
-.Pp
+.TP
-.It Ic binary
+.B binary
 Shorthand for
-.Ic mode binary .
+.BR "mode binary" .
-.Pp
+.TP
-.It Ic connect Ar host Op Ar port
+\fBconnect\fP \fIhost [port]\fP
 Set the
-.Ar host
+.I host
 (and optionally
-.Ar port )
+.IR 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 between transfers; thus, the
-.Ic connect
+.B connect
-command does not actually create a connection,
+command does not actually create a connection, but merely remembers
-but merely remembers what host is to be used for transfers.
+what host is to be used for transfers.  You do not have to use the
-You do not have to use the
+.B connect
-.Ic connect
 command; the remote host can be specified as part of the
-.Ic get
+.B get
 or
-.Ic put
+.B put
 commands.
-.Pp
+.TP
-.It Ic get Ar filename
+\fBget\fP \fIfile\fP
-.It Ic get Ar remotename localname
+.sp -.6l
-.It Ic get Ar file Op Ar ...
+.TP
-Get a file or set of files from the specified
+\fBget\fP \fIremotefile localfile\fP
-.Ar sources .
+.sp -.6l
-.Ar source
+.TP
-can be in one of two forms:
+\fBget\fP \fIfile1 file2 file3...\fP
-a filename on the remote host, if the host has already been specified,
+Get a file or set of files from the specified sources.  A remote
-or a string of the form
+filename can be in one of two forms: a plain filename on the remote
-.Ar hosts:filename
+host, if the host has already been specified, or a string of the form
-to specify both a host and filename at the same time.
+.I "host:filename"
-If the latter form is used,
+to specify both a host and filename at the same time.  If the latter
-the last hostname specified becomes the default for future transfers.
+form is used, the last hostname specified becomes the default for
-.Pp
+future transfers.
-.It Ic mode Ar transfer-mode
+.TP
-Set the mode for transfers;
+\fBmode\fP \fItransfer-mode\fP
-.Ar transfer-mode
+Specify the mode for transfers;
+.I transfer-mode
 may be one of
-.Ic ascii
+.B ascii
-or
+(or
-.Ic binary .
+.BR netascii ) or
+.B binary
+(or
+.BR octet .)
 The default is
-.Ic ascii .
+.BR ascii .
-.Pp
+.TP
-.It Ic put Ar file
+\fBput\fP \fIfile\fP
-.It Ic put Ar localfile remotefile
+.sp -.6l
-.It Ic put Ar file1 file2 ... fileN remote-directory
+.TP
-Put a file or set of files to the specified
+\fBput\fP \fIlocalfile remotefile\fP
-remote file or directory.
+.sp -.6l
-The destination
+.TP
-can be in one of two forms:
+\fBput\fP \fIfile1 file2 file3... remote-directory\fP
-a filename on the remote host, if the host has already been specified,
+Put a file or set of files to the specified remote file or directory.
-or a string of the form
+The destination can be in one of two forms: a filename on the remote
-.Ar hosts:filename
+host, if the host has already been specified, or a string of the form
-to specify both a host and filename at the same time.
+.I "host:filename"
-If the latter form is used,
+to specify both a host and filename at the same time.  If the latter
-the hostname specified becomes the default for future transfers.
+form is used, the hostname specified becomes the default for future
-If the remote-directory form is used, the remote host is
+transfers.  If the remote-directory form is used, the remote host is
-assumed to be a
+assumed to be a UNIX system or another system using
-.Tn UNIX
+.B /
-machine.
+as directory separator.
-.Pp
+.TP
-.It Ic quit
+.B quit
 Exit
-.Nm tftp .
+.BR tftp .
-An end-of-file also exits.
+End-of-file will also exit.
-.Pp
+.TP
-.It Ic rexmt Ar retransmission-timeout
+\fBrexmt\fP \fIretransmission-timeout\fP
 Set the per-packet retransmission timeout, in seconds.
-.Pp
+.TP
-.It Ic status
+.B status
 Show current status.
-.Pp
+.TP
-.It Ic timeout Ar total-transmission-timeout
+\fBtimeout\fP \fItotal-transmission-timeout\fP
 Set the total transmission timeout, in seconds.
-.Pp
+.TP
-.It Ic trace
+.B trace
-Toggle packet tracing.
+Toggle packet tracing (a debugging feature.)
-.Pp
+.TP
-.It Ic verbose
+.B verbose
 Toggle verbose mode.
-.El
+.SH "NOTES"
-.Sh BUGS
+The TFTP protocol provides no provisions for authentication or
-Because there is no user login or validation within
+security.  Therefore, the remote server will probably implement some
-the
+kinds of access restriction or firewalling.  These access restrictions
-.Tn TFTP
+are likely to be site- and server-specific.
-protocol, the remote site will probably have some
+.SH "AUTHOR"
-sort of file access restrictions in place.  The
+This version of
-exact methods are specific to each site and therefore
+.B tftp
-difficult to document here.
+is maintained by H. Peter Anvin <hpa@zytor.com>.  It was derived from,
-.Sh HISTORY
+but has substantially diverged from, an OpenBSD source base, with
-The
+added patches by Markus Gutschke and Gero Kulhman.
-.Nm
+.SH "SEE ALSO"
-command appeared in
+.BR tftpd (8).
-.Bx 4.3 .

tftpd/tftpd.8

@@ -1,13 +1,36 @@
 .\" -*- nroff -*- --------------------------------------------------------- *
+.\" $Id$
 .\"  
-.\"  Copyright 2001 H. Peter Anvin - All Rights Reserved
+.\" Copyright (c) 1990, 1993, 1994
+.\"     The Regents of the University of California.  All rights reserved.
 .\"
-.\"  This program is free software available under the same license
+.\" Copyright 2001 H. Peter Anvin - All Rights Reserved
-.\"  as the "OpenBSD" operating system, distributed at
+.\"
-.\"   http://www.openbsd.org/.
+.\" 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. 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 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.
 .\"
 .\"----------------------------------------------------------------------- */
-.\" $Id$
 .TH TFTPD 8 "13 November 2001" "tftp-hpa" "UNIX System Manager's Manual"
 .SH NAME
 .B tftpd
@@ -24,27 +47,6 @@ devices.  The server is normally started by
 .BR inetd ,
 but can also run standalone.
 .PP
-The use of TFTP services does not require an account or password on
-the server system.  Due to the lack of authentication information,
-.B tftpd
-will allow only publicly readable files (o+r) to be accessed.  Files
-may be written only if they already exist and are publicly writable.
-Note that this extends the concept of ``public'' to include all users
-on all hosts that can be reached through the network; this may not be
-appropriate on all systems, and its implications should be considered
-before enabling TFTP service.  The server should have the user ID with
-the lowest possible privilege; see the
-.B \-u
-flag below.
-.PP
-Access to files can, and should, be restricted by invoking
-.B tftpd
-with a list of directories by including pathnames as server program
-arguments on the command line.  In this case access is restricted to
-files whole names are prefixed by one of the given directories.  See
-also the
-.B \-s
-flag below.
 .SH OPTIONS
 .TP
 .B \-l
@@ -123,13 +125,13 @@ This version of
 .B tftpd
 supports RFC 2347 option negotation.  Currently implemented options
 are
-\f(CWblksize\fP
+.B blksize
 (RFC 2348),
-\f(CWblksize2\fP
+.B blksize2
 (nonstandard),
-\f(CWtsize\fP
+.B tsize
 (RFC 2349), and
-\f(CWtimeout\fP
+.B timeout
 (RFC 2349).  The
 .B \-r
 option can be used to disable specific options; this may be necessary
@@ -139,7 +141,7 @@ The
 .B \-m
 option specifies a file which contains filename remapping rules.  Each
 non-comment line (comments begin with hash marks,
-\f(CW#\fP)
+.BR # )
 contains an
 .IR operation ,
 specified below; a
@@ -203,12 +205,46 @@ If the mapping file is changed, you need to send
 to any outstanding
 .B tftpd
 process.
+.SH "SECURITY"
+The use of TFTP services does not require an account or password on
+the server system.  Due to the lack of authentication information,
+.B tftpd
+will allow only publicly readable files (o+r) to be accessed.  Files
+may be written only if they already exist and are publicly writable,
+unless the
+.B \-c
+option is specified.
+Note that this extends the concept of ``public'' to include all users
+on all hosts that can be reached through the network; this may not be
+appropriate on all systems, and its implications should be considered
+before enabling TFTP service.  Typically, some kind of firewall or
+packet-filter solution should be employed.
+.PP
+The server should be set to have the user ID with the lowest possible
+privilege; please see the
+.B \-u
+flag.
+.PP
+Access to files can, and should, be restricted by invoking
+.B tftpd
+with a list of directories by including pathnames as server program
+arguments on the command line.  In this case access is restricted to
+files whole names are prefixed by one of the given directories.  If
+possible, it is recommended that the
+.B \-s
+flag is used to set up a chroot() environment for the server to run in
+once a connection has been set up.
+.PP
+Finally, the filename remapping
+.RB ( \-m
+flag) support can be used to provide a limited amount of additional
+access control.
 .SH "BUGS"
 It is unclear at this point if the retransmission algorithm used is
 sufficient to satisfy the RFC 1123 requirement that TFTP
 implementations use adaptive retransmission timeout.  Furthermore, it
 is unclear how to combine the adaptive timeout of RFC 1123 with the
-\f(CWtimeout\fP
+.B timeout
 option specified by RFC 2349.
 .SH "CONFORMING TO"
 RFC 1123,
@@ -227,9 +263,9 @@ RFC 2349,
 .IR "TFTP Timeout Interval and Transfer Size Options" .
 .PP
 The nonstandard
-\f(CWblksize2\fP
+.B blksize2
 TFTP option is functionally identical to the
-\f(CWblksize\fP
+.B blksize
 option specified in RFC 2349, with the additional constraint that the
 blocksize is constrained to be a power of 2.
 .SH "AUTHOR"