5172 tftpd service is not registered by default and its manual is giving misleading...
[unleashed.git] / usr / src / man / man1m / in.tftpd.1m
blobe67bb435d4209b5c04de2a46dbef4d8726f57e95
1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved
4 .\" Copyright 2015 Nexenta Systems, Inc. All rights reserved.
5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
8 .TH IN.TFTPD 1M "Jun 17, 2015"
9 .SH NAME
10 in.tftpd, tftpd \- Internet Trivial File Transfer Protocol server
11 .SH SYNOPSIS
12 .LP
13 .nf
14 \fBin.tftpd\fR [\fB-d\fR] [\fB-T\fR \fIrexmtval\fR] [\fB-s\fR] [\fIhomedir\fR]
15 .fi
17 .SH DESCRIPTION
18 .LP
19 \fBtftpd\fR is a server that supports the Internet Trivial File Transfer
20 Protocol (TFTP).
21 .sp
22 .LP
23 Before responding to a request, the server attempts to change its current
24 directory to \fIhomedir\fR; the default directory is \fB/tftpboot\fR.
25 .sp
26 .LP
27 The use of \fBtftp\fR does not require an account or password on the remote
28 system. Due to the lack of authentication information, \fBin.tftpd\fR will
29 allow only publicly readable files to be accessed. Files may be written only if
30 they already exist and are publicly writable. Note that this extends the
31 concept of "public" to include all users on all hosts that can be reached
32 through the network. This may not be appropriate on all systems, and its
33 implications should be considered before enabling this service.
34 .sp
35 .LP
36 \fBin.tftpd\fR runs with the user \fBID\fR and group \fBID\fR set to
37 \fB[GU]ID_NOBODY\fR under the assumption that no files exist with that owner or
38 group. However, nothing checks this assumption or enforces this restriction.
39 .SH OPTIONS
40 .ne 2
41 .na
42 \fB\fB-d\fR\fR
43 .ad
44 .RS 15n
45 Debug. When specified it sets the \fBSO_DEBUG\fR socket option.
46 .RE
48 .sp
49 .ne 2
50 .na
51 \fB\fB-s\fR\fR
52 .ad
53 .RS 15n
54 Secure. When specified, the directory change to \fIhomedir\fR must succeed. The
55 daemon also changes its root directory to \fIhomedir\fR.
56 .RE
58 .sp
59 .ne 2
60 .na
61 \fB\fB-T\fR \fIrexmtval\fR\fR
62 .ad
63 .RS 15n
64 Specifies the value of the retransmission timeout in seconds. This also affects
65 the maximum session timeout in that the latter is set to five times the
66 retransmission timeout value.
67 .RE
69 .SH USAGE
70 .LP
71 The \fBin.tftpd\fR server is IPv6-enabled. See \fBip6\fR(7P).
72 .LP
73 \fBin.tftpd\fR supports transfers of greater than 32 MB, per RFC 2348.
74 .SH SEE ALSO
75 .LP
76 \fBsvcs\fR(1), \fBtftp\fR(1), \fBinetadm\fR(1M), \fBinetd\fR(1M),
77 \fBsvcadm\fR(1M), \fBnetconfig\fR(4), \fBattributes\fR(5), \fBsmf\fR(5),
78 \fBip6\fR(7P)
79 .LP
80 Malkin, G. and Harkin, A. \fIRFC 2347, TFTP Option Extension\fR. The Internet
81 Society. May 1998
82 .sp
83 .LP
84 Malkin, G. and Harkin, A. \fIRFC 2348, TFTP Blocksize Option\fR. The Internet
85 Society. May 1998
86 .sp
87 .LP
88 Malkin, G. and Harkin, A. \fIRFC 2349, TFTP Timeout Interval and Transfer Size
89 Options\fR. The Internet Society. May 1998
90 .sp
91 .LP
92 Sollins, K.R. \fIRFC 1350, The TFTP Protocol (Revision 2)\fR. Network Working
93 Group. July 1992.
94 .SH NOTES
95 .LP
96 The \fBtftpd\fR server only acknowledges the transfer size option that is sent
97 with a \fBread\fR request when the octet transfer mode is specified.
98 .LP
99 The \fBin.tftpd.1m\fR service is managed by the service management facility,
100 \fBsmf\fR(5), under the service identifier:
102 .in +2
104 svc:/network/tftp/udp6:default
106 .in -2
111 Administrative actions on this service, such as enabling, disabling, or
112 requesting restart, can be performed using \fBsvcadm\fR(1M). Responsibility for
113 initiating and restarting this service is delegated to \fBinetd\fR(1M). Use
114 \fBinetadm\fR(1M) to make configuration changes and to view configuration
115 information for this service. The service's status can be queried using the
116 \fBsvcs\fR(1) command.