1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
'\" te
.\" Copyright (C) 2001, Sun Microsystems, Inc. All Rights Reserved
.\" 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.
.\" 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.
.\" 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]
.TH ftpconversions 4 "1 May 2003" "SunOS 5.11" "File Formats"
.SH NAME
ftpconversions \- FTP Server conversions database
.SH SYNOPSIS
.LP
.nf
\fB/etc/ftpd/ftpconversions\fR
.fi
.SH DESCRIPTION
.sp
.LP
When the FTP Server, \fBin.ftpd\fR(1M), receives the retrieve (\fBRETR\fR)
command, if the specified file does not exist, it looks for a conversion to
change an existing file or directory of the same base name into the format
requested, subject to the \fBftpaccess\fR(4) \fBcompress\fR and \fBtar\fR
capabilities.
.sp
.LP
The conversions and their attributes known by \fBin.ftpd\fR(1M) are stored in
an \fBASCII\fR file of the following format. Each line in the file provides a
description for a single conversion. The fields in this file are separated by
colons (:).
.sp
.in +2
.nf
%s:%s:%s:%s:%s:%s:%s:%s
1 2 3 4 5 6 7 8
.fi
.in -2
.sp
.sp
.LP
The fields are described as follows:
.sp
.ne 2
.mk
.na
\fB1\fR
.ad
.RS 5n
.rt
\fBStrip prefix\fR.
.RE
.sp
.ne 2
.mk
.na
\fB2\fR
.ad
.RS 5n
.rt
\fBStrip postfix\fR.
.RE
.sp
.ne 2
.mk
.na
\fB3\fR
.ad
.RS 5n
.rt
\fBAddon prefix\fR.
.RE
.sp
.ne 2
.mk
.na
\fB4\fR
.ad
.RS 5n
.rt
\fBAddon postfix\fR.
.RE
.sp
.ne 2
.mk
.na
\fB5\fR
.ad
.RS 5n
.rt
\fBExternal command\fR.
.RE
.sp
.ne 2
.mk
.na
\fB6\fR
.ad
.RS 5n
.rt
\fBTypes\fR.
.RE
.sp
.ne 2
.mk
.na
\fB7\fR
.ad
.RS 5n
.rt
\fBOptions\fR.
.RE
.sp
.ne 2
.mk
.na
\fB8\fR
.ad
.RS 5n
.rt
\fBDescription\fR.
.RE
.sp
.LP
The \fBStrip prefix\fR and \fBAddon prefix\fR fields are not currently
supported.
.sp
.LP
The \fBStrip postfix\fR and \fBaddon postfix\fR fields are extensions to be
added to or removed from the requested \fBfilename\fR in attempting to produce
the name of an existing file or directory. When the attempt succeeds, the FTP
Server runs the external command associated with the conversion. The magic
cookie \fB%s\fR in the argument is passed to the command, replaced with the
name of the existing file or directory.
.sp
.LP
\fBExternal command\fR is the absolute pathname of a command to run followed by
the appropriate options to carry out the conversion. The standard output of the
command is sent back in response to the \fBRETR\fR (retrieve) command. For
anonymous and guest users to be able to execute the command, it must be present
in their \fBchroot'd\fR hierarchy along with any necessary dynamic libraries.
.sp
.LP
\fBTypes\fR specifies the conversion type. The following values are recognized:
.sp
.ne 2
.mk
.na
\fB\fBT_ASCII\fR\fR
.ad
.RS 11n
.rt
ASCII transfers are allowed of a file produced by the conversion.
.RE
.sp
.ne 2
.mk
.na
\fB\fB\fR\fBT_DIR\fR\fR
.ad
.RS 11n
.rt
Directories can be converted.
.RE
.sp
.ne 2
.mk
.na
\fB\fBT_REG\fR\fR
.ad
.RS 11n
.rt
Regular files can be converted.
.RE
.sp
.LP
\fBOptions\fR are checked against the \fBftpaccess\fR(4) \fBcompress\fR and
\fBtar\fR capabilities and are recorded in the \fBspecial-action-flag\fR field
that is written to the FTP Server logfile. See \fBxferlog\fR(4). The following
options are supported:
.sp
.ne 2
.mk
.na
\fB\fBO_COMPRESS\fR\fR
.ad
.RS 16n
.rt
conversion compresses
.RE
.sp
.ne 2
.mk
.na
\fB\fBO_TAR\fR\fR
.ad
.RS 16n
.rt
conversion archives
.RE
.sp
.ne 2
.mk
.na
\fB\fBO_UNCOMPRESS\fR\fR
.ad
.RS 16n
.rt
conversion uncompresses
.RE
.sp
.LP
You can specify more than one option by using "\fB|\fR" to separate options.
For example, \fBO_TAR|O_COMPRESS\fR specifies that the conversion archives and
compresses.
.sp
.LP
\fBDescription\fR is a one word description of the conversion that is used in
error messages returned to the FTP client.
.sp
.LP
Lines that begin with a \fB#\fR sign are treated as comment lines and are
ignored.
.SH EXAMPLES
.LP
\fBExample 1 \fRCompressing a Regular File for Transfer
.sp
.LP
The following example specifies a conversion which generates \fBfilename.Z\fR
by compressing an existing file \fBfilename\fR. The conversion can only be
applied to regular files, not directories, and the absence of \fBT_ASCII\fR
prevents the resulting file from being transferred in ASCII mode.
.sp
.in +2
.nf
: : :.Z:/usr/bin/compress -c %s:T_REG:O_COMPRESS:COMPRESS
.fi
.in -2
.LP
\fBExample 2 \fR Uncompressing and Transferring in ASCII Mode
.sp
.LP
The following example specifies a conversion that takes \fBfilename.Z\fR and
uncompresses it to produce \fBfilename\fR, which then can be transferred in
ASCII mode.
.sp
.in +2
.nf
:.Z: : :/usr/bin/compress -cd %s:T_REG|T_ASCII:O_UNCOMPRESS:UNCOMPRESS
.fi
.in -2
.SH FILES
.sp
.ne 2
.mk
.na
\fB\fB/etc/ftpd/ftpconversions\fR\fR
.ad
.RS 28n
.rt
.RE
.SH SEE ALSO
.sp
.LP
\fBldd\fR(1), \fBin.ftpd\fR(1M), \fBftpaccess\fR(4), \fBxferlog\fR(4),
\fBattributes\fR(5)
|