1 '\" te 2 .\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved 3 .\" 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. 4 .\" 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. 5 .\" 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] 6 .TH XFERLOG 4 "Apr 25, 2003" 7 .SH NAME 8 xferlog \- FTP Server transfer log file 9 .SH SYNOPSIS 10 .LP 11 .nf 12 \fB/var/log/xferlog\fR 13 .fi 14 15 .SH DESCRIPTION 16 .sp 17 .LP 18 The \fBxferlog\fR file contains transfer logging information from the FTP 19 Server, \fBin.ftpd\fR(1M). You can use the logfile capability to change the 20 location of the log file. See \fBftpaccess\fR(4). 21 .sp 22 .LP 23 By default, each server entry is composed of a single line of the following 24 form. All fields are separated by spaces. 25 .sp 26 .in +2 27 .nf 28 \fIcurrent-time\fR \fItransfer-time \fR \fIremote-host\fR \fIbytes-transferred\fR \e 29 \fIfilename\fR 30 \fItransfer-type\fR \fIspecial-action-flag\fR \fIdirection\fR \fIaccess-mode\fR \fIusername\fR 31 \fIservice-name\fR \fIauthentication-method\fR \fIauthenticated-user-id\fR \e 32 \fIcompletion-status\fR 33 .fi 34 .in -2 35 36 .sp 37 .LP 38 The \fBxferlog\fR format capability can be used to customize the transfer log 39 file format used. In addition to those in the default format, it also supports 40 \fBchroot-filename\fR, \fBfile-size\fR, and \fBrestart-offset\fR fields. See 41 \fBftpaccess\fR(4). 42 .sp 43 .LP 44 The fields are defined as follows: 45 .sp 46 .ne 2 47 .na 48 \fB\fIcurrent-time\fR\fR 49 .ad 50 .RS 25n 51 The current local time in the form \fBDDD MMM dd hh:mm:ss YYYY\fR, where: 52 .sp 53 .ne 2 54 .na 55 \fB\fBDDD\fR\fR 56 .ad 57 .RS 8n 58 Is the day of the week 59 .RE 60 61 .sp 62 .ne 2 63 .na 64 \fB\fBMMM\fR\fR 65 .ad 66 .RS 8n 67 Is the month 68 .RE 69 70 .sp 71 .ne 2 72 .na 73 \fB\fBdd\fR\fR 74 .ad 75 .RS 8n 76 Is the day of the month 77 .RE 78 79 .sp 80 .ne 2 81 .na 82 \fB\fBhh\fR\fR 83 .ad 84 .RS 8n 85 Is the hour 86 .RE 87 88 .sp 89 .ne 2 90 .na 91 \fB\fBmm\fR\fR 92 .ad 93 .RS 8n 94 Is the minutes 95 .RE 96 97 .sp 98 .ne 2 99 .na 100 \fB\fBss\fR\fR 101 .ad 102 .RS 8n 103 Is the seconds 104 .RE 105 106 .sp 107 .ne 2 108 .na 109 \fB\fBYYYY\fR\fR 110 .ad 111 .RS 8n 112 Is the year 113 .RE 114 115 .RE 116 117 .sp 118 .ne 2 119 .na 120 \fB\fItransfer-time \fR\fR 121 .ad 122 .RS 25n 123 The total time in seconds for the transfer 124 .RE 125 126 .sp 127 .ne 2 128 .na 129 \fB\fIremote-host\fR\fR 130 .ad 131 .RS 25n 132 The remote host name 133 .RE 134 135 .sp 136 .ne 2 137 .na 138 \fB\fIbytes-transferred\fR\fR 139 .ad 140 .RS 25n 141 The number of bytes transferred 142 .RE 143 144 .sp 145 .ne 2 146 .na 147 \fB\fIfilename\fR\fR 148 .ad 149 .RS 25n 150 The absolute pathname of the transferred file 151 .RE 152 153 .sp 154 .ne 2 155 .na 156 \fB\fItransfer-type\fR\fR 157 .ad 158 .RS 25n 159 A single character indicating the type of transfer: 160 .sp 161 .ne 2 162 .na 163 \fBa\fR 164 .ad 165 .RS 5n 166 Indicates an ascii transfer 167 .RE 168 169 .sp 170 .ne 2 171 .na 172 \fBb\fR 173 .ad 174 .RS 5n 175 Indicates a binary transfer 176 .RE 177 178 .RE 179 180 .sp 181 .ne 2 182 .na 183 \fB\fIspecial-action-flag\fR\fR 184 .ad 185 .RS 25n 186 One or more single character flags that indicate any special action taken. The 187 \fIspecial-action-flag\fR can have one of more of the following values: 188 .sp 189 .ne 2 190 .na 191 \fBC\fR 192 .ad 193 .RS 16n 194 File was compressed 195 .RE 196 197 .sp 198 .ne 2 199 .na 200 \fBU\fR 201 .ad 202 .RS 16n 203 File was uncompressed 204 .RE 205 206 .sp 207 .ne 2 208 .na 209 \fBT\fR 210 .ad 211 .RS 16n 212 File was archived, for example, by using \fBtar\fR(1) 213 .RE 214 215 .sp 216 .ne 2 217 .na 218 \fB_ (underbar)\fR 219 .ad 220 .RS 16n 221 No action was taken. 222 .RE 223 224 .RE 225 226 .sp 227 .ne 2 228 .na 229 \fB\fIdirection\fR\fR 230 .ad 231 .RS 25n 232 The direction of the transfer. \fIdirection\fR can have one of the following 233 values: 234 .sp 235 .ne 2 236 .na 237 \fBo\fR 238 .ad 239 .RS 5n 240 Outgoing 241 .RE 242 243 .sp 244 .ne 2 245 .na 246 \fBi\fR 247 .ad 248 .RS 5n 249 Incoming 250 .RE 251 252 .RE 253 254 .sp 255 .ne 2 256 .na 257 \fB\fIaccess-mode\fR\fR 258 .ad 259 .RS 25n 260 The method by which the user is logged in. \fIaccess-mode\fR can have one of 261 the following values: 262 .sp 263 .ne 2 264 .na 265 \fBa\fR 266 .ad 267 .RS 5n 268 For an anonymous user. 269 .RE 270 271 .sp 272 .ne 2 273 .na 274 \fBg\fR 275 .ad 276 .RS 5n 277 For a passworded guest user. See the description of the \fBguestgroup\fR 278 capability in \fBftpaccess\fR(4). 279 .RE 280 281 .sp 282 .ne 2 283 .na 284 \fBr\fR 285 .ad 286 .RS 5n 287 For a real, locally authenticated user 288 .RE 289 290 .RE 291 292 .sp 293 .ne 2 294 .na 295 \fB\fIusername\fR\fR 296 .ad 297 .RS 25n 298 The local username, or if anonymous, the ID string given 299 .RE 300 301 .sp 302 .ne 2 303 .na 304 \fB\fIservice-name\fR\fR 305 .ad 306 .RS 25n 307 The name of the service invoked, usually \fBftp\fR 308 .RE 309 310 .sp 311 .ne 2 312 .na 313 \fB\fIauthentication-method\fR\fR 314 .ad 315 .RS 25n 316 The method of authentication used. \fIauthentication-method\fR can have one of 317 the following values: 318 .sp 319 .ne 2 320 .na 321 \fB0\fR 322 .ad 323 .RS 5n 324 None 325 .RE 326 327 .sp 328 .ne 2 329 .na 330 \fB1\fR 331 .ad 332 .RS 5n 333 \fIRFC 931\fR authentication 334 .RE 335 336 .RE 337 338 .sp 339 .ne 2 340 .na 341 \fB\fIauthenticated-user-id\fR\fR 342 .ad 343 .RS 25n 344 The user ID returned by the authentication method. A \fB*\fR is used if an 345 authenticated user ID is not available. 346 .RE 347 348 .sp 349 .ne 2 350 .na 351 \fB\fIcompletion-status\fR\fR 352 .ad 353 .RS 25n 354 A single character indicating the status of the transfer. 355 \fIcompletion-status\fR can have one of the following values: 356 .sp 357 .ne 2 358 .na 359 \fBc\fR 360 .ad 361 .RS 5n 362 Indicates complete transfer 363 .RE 364 365 .sp 366 .ne 2 367 .na 368 \fBi\fR 369 .ad 370 .RS 5n 371 Indicates incomplete transfer 372 .RE 373 374 .RE 375 376 .sp 377 .ne 2 378 .na 379 \fB\fIchroot-filename\fR\fR 380 .ad 381 .RS 25n 382 The pathname of the transferred file relative to the \fBchroot\fR point. This 383 will differ from the \fIfilename\fR field for anonymous and guest users. 384 .RE 385 386 .sp 387 .ne 2 388 .na 389 \fB\fIfile-size\fR\fR 390 .ad 391 .RS 25n 392 The size, in bytes, of the file on the server. 393 .RE 394 395 .sp 396 .ne 2 397 .na 398 \fB\fIrestart-offset\fR\fR 399 .ad 400 .RS 25n 401 The offset, in bytes, at which the file transfer was restarted (0 when no 402 restart offset was specified). 403 .RE 404 405 .SH FILES 406 .sp 407 .LP 408 \fB/var/log/xferlog\fR 409 .SH ATTRIBUTES 410 .sp 411 .LP 412 See \fBattributes\fR(5) for descriptions of the following attributes: 413 .sp 414 415 .sp 416 .TS 417 box; 418 c | c 419 l | l . 420 ATTRIBUTE TYPE ATTRIBUTE VALUE 421 _ 422 Interface Stability External 423 .TE 424 425 .SH SEE ALSO 426 .sp 427 .LP 428 \fBtar\fR(1), \fBin.ftpd\fR(1M), \fBftpaccess\fR(4), \fBftpconversions\fR(4), 429 \fBattributes\fR(5) 430 .sp 431 .LP 432 StJohns, Mike. \fIRFC 931, Authentication Server\fR. Network Working Group. 433 January 1985.