forked from mirrors/tftp-hpa-google
Make the version number automatically included in the man page footer
This commit is contained in:
parent
779db73551
commit
4f739767f2
7 changed files with 330 additions and 10 deletions
5
Makefile
5
Makefile
|
@ -51,7 +51,10 @@ MCONFIG: configure MCONFIG.in acconfig.h.in
|
|||
acconfig.h: MCONFIG
|
||||
: Generated by side effect
|
||||
|
||||
acconfig.h.in: configure.in aclocal.m4
|
||||
# Adding "configure" to the dependencies serializes this with running
|
||||
# autoconf, because there are apparently race conditions between
|
||||
# autoconf and autoheader.
|
||||
acconfig.h.in: configure.in configure aclocal.m4
|
||||
rm -f acconfig.h.in acconfig.h
|
||||
autoheader -f
|
||||
|
||||
|
|
|
@ -1,6 +1,7 @@
|
|||
all: tftp
|
||||
all: tftp tftp.1
|
||||
|
||||
SRCROOT = ..
|
||||
VERSION = $(shell cat ../version)
|
||||
|
||||
-include ../MCONFIG
|
||||
include ../MRULES
|
||||
|
@ -12,13 +13,16 @@ tftp: $(OBJS)
|
|||
|
||||
$(OBJS): tftpsubs.h
|
||||
|
||||
install: tftp
|
||||
tftp.1: tftp.1.in ../version
|
||||
sed -e 's/@@VERSION@@/$(VERSION)/g' < $< > $@
|
||||
|
||||
install: all
|
||||
mkdir -p $(INSTALLROOT)$(BINDIR) $(INSTALLROOT)$(MANDIR)/man1
|
||||
$(INSTALL_PROGRAM) tftp $(INSTALLROOT)$(BINDIR)
|
||||
$(INSTALL_DATA) tftp.1 $(INSTALLROOT)$(MANDIR)/man1
|
||||
|
||||
clean:
|
||||
rm -f *.o tftp
|
||||
rm -f *.o tftp tftp.1
|
||||
|
||||
distclean: clean
|
||||
rm -f *~
|
||||
|
|
|
@ -31,7 +31,7 @@
|
|||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\"----------------------------------------------------------------------- */
|
||||
.TH TFTP 1 "13 November 2001" "tftp-hpa" "UNIX User's Manual"
|
||||
.TH TFTP 1 "13 November 2001" "tftp-hpa @@VERSION@@" "UNIX User's Manual"
|
||||
.SH NAME
|
||||
.B tftp
|
||||
\- IPv4 Trivial File Transfer Protocol client
|
|
@ -1,6 +1,7 @@
|
|||
all: tftpd
|
||||
all: tftpd tftpd.8
|
||||
|
||||
SRCROOT = ..
|
||||
VERSION = $(shell cat ../version)
|
||||
|
||||
-include ../MCONFIG
|
||||
include ../MRULES
|
||||
|
@ -17,14 +18,17 @@ tftpsubs.h:
|
|||
|
||||
$(OBJS): tftpsubs.h
|
||||
|
||||
install: tftpd
|
||||
tftpd.8: tftpd.8.in ../version
|
||||
sed -e 's/@@VERSION@@/$(VERSION)/g' < $< > $@
|
||||
|
||||
install: all
|
||||
mkdir -p $(INSTALLROOT)$(SBINDIR) $(INSTALLROOT)$(MANDIR)/man8
|
||||
$(INSTALL_PROGRAM) tftpd $(INSTALLROOT)$(SBINDIR)/in.tftpd
|
||||
$(INSTALL_DATA) tftpd.8 $(INSTALLROOT)$(MANDIR)/man8/in.tftpd.8
|
||||
cd $(INSTALLROOT)$(MANDIR)/man8 && ln -sf in.tftpd.8 tftpd.8
|
||||
|
||||
clean:
|
||||
rm -f *.o tftpd tftpsubs.c tftpsubs.h
|
||||
rm -f *.o tftpd tftpsubs.c tftpsubs.h tftpd.8
|
||||
|
||||
distclean: clean
|
||||
rm -f *~
|
||||
|
|
|
@ -31,7 +31,7 @@
|
|||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\"----------------------------------------------------------------------- */
|
||||
.TH TFTPD 8 "16 November 2001" "tftp-hpa" "UNIX System Manager's Manual"
|
||||
.TH TFTPD 8 "16 November 2001" "tftp-hpa 0.27-pre1" "UNIX System Manager's Manual"
|
||||
.SH NAME
|
||||
.B tftpd
|
||||
\- IPv4 Trivial File Transfer Protocol server
|
||||
|
|
309
tftpd/tftpd.8.in
Normal file
309
tftpd/tftpd.8.in
Normal file
|
@ -0,0 +1,309 @@
|
|||
.\" -*- nroff -*- --------------------------------------------------------- *
|
||||
.\" $Id$
|
||||
.\"
|
||||
.\" Copyright (c) 1990, 1993, 1994
|
||||
.\" 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
|
||||
.\" 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.
|
||||
.\"
|
||||
.\"----------------------------------------------------------------------- */
|
||||
.TH TFTPD 8 "16 November 2001" "tftp-hpa @@VERSION@@" "UNIX System Manager's Manual"
|
||||
.SH NAME
|
||||
.B tftpd
|
||||
\- IPv4 Trivial File Transfer Protocol server
|
||||
.SH SYNOPSIS
|
||||
.B in.tftpd
|
||||
.RI [ options... ]
|
||||
.I directory...
|
||||
.SH DESCRIPTION
|
||||
.B tftpd
|
||||
is a server for the IPv4 Trivial File Transfer Protocol. The TFTP
|
||||
protocol is extensively used to support remote booting of diskless
|
||||
devices. The server is normally started by
|
||||
.BR inetd ,
|
||||
but can also run standalone.
|
||||
.PP
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \-l
|
||||
Run the server in standalone (listen) mode, rather than run from
|
||||
.BR inetd .
|
||||
In listen mode, the
|
||||
.B \-t
|
||||
option is ignored, and the
|
||||
.B \-a
|
||||
option can be used to specify a specific local address or port to
|
||||
listen to.
|
||||
.TP
|
||||
\fB\-a\fP \fI[address][:port]\fP
|
||||
Specify a specific
|
||||
.I address
|
||||
and
|
||||
.I port
|
||||
to listen to when called with the
|
||||
.B \-l
|
||||
option. The default is to listen to the
|
||||
.I tftp
|
||||
port specified in
|
||||
.I /etc/services
|
||||
on all local addresses.
|
||||
.TP
|
||||
.B \-c
|
||||
Allow new files to be created. By default,
|
||||
.B tftpd
|
||||
will only allow upload of files that already exist. Files are created
|
||||
with default permissions allowing anyone to read or write them.
|
||||
.TP
|
||||
.B \-s
|
||||
Change root directory on startup. This means the remote host does not
|
||||
need to pass along the directory as part of the transfer, and may add
|
||||
security. When
|
||||
.B \-s
|
||||
is specified, exactly one
|
||||
.I directory
|
||||
should be specified on the command line. The use of this option is
|
||||
recommended for security as well as compatibility with some boot ROMs
|
||||
which cannot be easily made to include a directory name in its request.
|
||||
.TP
|
||||
\fB\-u\fP \fIusername\fP
|
||||
Specify the username which
|
||||
.B tftpd
|
||||
will run as; the default is "nobody".
|
||||
.TP
|
||||
\fB\-t\fP \fItimeout\fP
|
||||
When run from
|
||||
.B inetd
|
||||
this specifies how long, in seconds, to wait for a second connection
|
||||
before terminating the server.
|
||||
.B inetd
|
||||
will then respawn the server when another request comes in. The
|
||||
default is 900 (15 minutes.)
|
||||
.TP
|
||||
\fB\-m\fP \fIremap-file\fP
|
||||
Specify the use of filename remapping. The
|
||||
.I remap-file
|
||||
is a file containing the remapping rules. See the section on filename
|
||||
remapping below. This option may not be compiled in, see the output of
|
||||
.B "in.tftpd \-V"
|
||||
to verify whether or not it is available.
|
||||
.TP
|
||||
.B \-v
|
||||
Increase the logging verbosity of
|
||||
.BR tftpd .
|
||||
This flag can be specified multiple times for even higher verbosity.
|
||||
.TP
|
||||
\fB\-r\fP \fItftp-option\fP
|
||||
Indicate that a specific RFC 2347 TFTP option should never be
|
||||
accepted.
|
||||
.TP
|
||||
.B \-V
|
||||
Print the version number and configuration to standard output, then
|
||||
exit gracefully.
|
||||
.SH "RFC 2347 OPTION NEGOTIATION"
|
||||
This version of
|
||||
.B tftpd
|
||||
supports RFC 2347 option negotation. Currently implemented options
|
||||
are
|
||||
.B blksize
|
||||
(RFC 2348),
|
||||
.B blksize2
|
||||
(nonstandard),
|
||||
.B tsize
|
||||
(RFC 2349), and
|
||||
.B timeout
|
||||
(RFC 2349). The nonstandard
|
||||
.B blksize2
|
||||
TFTP option is functionally identical to the
|
||||
.B blksize
|
||||
option, with the additional constraint that the
|
||||
blocksize is constrained to be a power of 2.
|
||||
.PP
|
||||
The
|
||||
.B \-r
|
||||
option can be used to disable specific options; this may be necessary
|
||||
to work around bugs in specific TFTP client implementations.
|
||||
.SH "FILENAME REMAPPING"
|
||||
The
|
||||
.B \-m
|
||||
option specifies a file which contains filename remapping rules. Each
|
||||
non-comment line (comments begin with hash marks,
|
||||
.BR # )
|
||||
contains an
|
||||
.IR operation ,
|
||||
specified below; a
|
||||
.IR regex ,
|
||||
a regular expression in the style of
|
||||
.BR egrep ;
|
||||
and optionally a
|
||||
.IR "replacement pattern" .
|
||||
The operation indicated by
|
||||
.I operation
|
||||
is performed if the
|
||||
.I regex
|
||||
matches all or part of the filename. Rules are processed from the top
|
||||
down, and by default, all rules are processed even if there is a
|
||||
match.
|
||||
.PP
|
||||
The
|
||||
.I operation
|
||||
can be any combination of the following letters:
|
||||
.TP
|
||||
.B r
|
||||
Replace the substring matched by
|
||||
.I regex
|
||||
by the
|
||||
.IR "replacement pattern" .
|
||||
The replacement pattern may contain escape sequences; see below.
|
||||
.TP
|
||||
.B g
|
||||
Repeat this rule until it no longer matches. This is always used with
|
||||
.BR r .
|
||||
.TP
|
||||
.B i
|
||||
Match the
|
||||
.I regex
|
||||
case-insensitively. By default it is case sensitive.
|
||||
.TP
|
||||
.B e
|
||||
If this rule matches, end rule processing after executing the rule.
|
||||
.TP
|
||||
.B s
|
||||
If this rule matches, start rule processing over from the very first
|
||||
rule after executing this rule.
|
||||
.TP
|
||||
.B a
|
||||
If this rule matches, refuse the request and send an access denied
|
||||
error to the client.
|
||||
.TP
|
||||
.B G
|
||||
This rule applies to GET (RRQ) requests only.
|
||||
.TP
|
||||
.B P
|
||||
This rule applies to PUT (WRQ) requests only.
|
||||
.PP
|
||||
The following escape sequences are recognized as part of the
|
||||
.IR "replacement pattern" :
|
||||
.TP
|
||||
\fB\\0\fP
|
||||
The entire string matched by the
|
||||
.IR regex .
|
||||
.TP
|
||||
\fB\\1\fP to \fB\\9\fP
|
||||
Match the first nine parentensized subexpressions, \\( ... \\) of the
|
||||
.I regex
|
||||
pattern.
|
||||
.TP
|
||||
\fB\\i\fP
|
||||
The IP address of the requesting host, in dotted-quad notation
|
||||
(e.g. 192.0.2.169).
|
||||
.TP
|
||||
\fB\\x\fP
|
||||
The IP address of the requesting host, in hexadecimal notation
|
||||
(e.g. C00002A9).
|
||||
.TP
|
||||
\fB\\\fP
|
||||
Literal backslash.
|
||||
.TP
|
||||
\fB\\\fP\fIwhitespace\fP
|
||||
Literal whitespace.
|
||||
.TP
|
||||
\fB\\#\fI
|
||||
Literal hash mark.
|
||||
.PP
|
||||
If the mapping file is changed, you need to send
|
||||
.B SIGHUP
|
||||
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. If appropriately compiled (see the output of
|
||||
.BR "in.tftpd \-V" )
|
||||
.B tftpd
|
||||
will query the
|
||||
.BR hosts_access (5)
|
||||
database for access control information. This may be slow; sites
|
||||
requiring maximum performance may want to compile without this option
|
||||
and rely on firewalling or kernel-based packet filters instead.
|
||||
.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 "CONFORMING TO"
|
||||
RFC 1123,
|
||||
.IR "Requirements for Internet Hosts \- Application and Support" .
|
||||
.br
|
||||
RFC 1350,
|
||||
.IR "The TFTP Protocol (revision 2)" .
|
||||
.br
|
||||
RFC 2347,
|
||||
.IR "TFTP Option Extension" .
|
||||
.br
|
||||
RFC 2348,
|
||||
.IR "TFTP Blocksize Option" .
|
||||
.br
|
||||
RFC 2349,
|
||||
.IR "TFTP Timeout Interval and Transfer Size Options" .
|
||||
.SH "AUTHOR"
|
||||
This version of
|
||||
.B tftpd
|
||||
is maintained by H. Peter Anvin <hpa@zytor.com>. It was derived from,
|
||||
but has substantially diverged from, an OpenBSD source base, with
|
||||
added patches by Markus Gutschke and Gero Kulhman.
|
||||
.SH "SEE ALSO"
|
||||
.BR tftp (1),
|
||||
.BR egrep (1),
|
||||
.BR hosts_access (5),
|
||||
.BR regex (7),
|
||||
.BR inetd (8).
|
2
version
2
version
|
@ -1 +1 @@
|
|||
0.27-pre1
|
||||
0.27-pre2
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue