Annotation of src/usr.bin/ssh/sftp-server.8, Revision 1.15
1.15 ! sobrado 1: .\" $OpenBSD: sftp-server.8,v 1.14 2008/07/18 22:51:01 jmc Exp $
1.2 deraadt 2: .\"
1.5 deraadt 3: .\" Copyright (c) 2000 Markus Friedl. All rights reserved.
1.2 deraadt 4: .\"
5: .\" Redistribution and use in source and binary forms, with or without
6: .\" modification, are permitted provided that the following conditions
7: .\" are met:
8: .\" 1. Redistributions of source code must retain the above copyright
9: .\" notice, this list of conditions and the following disclaimer.
10: .\" 2. Redistributions in binary form must reproduce the above copyright
11: .\" notice, this list of conditions and the following disclaimer in the
12: .\" documentation and/or other materials provided with the distribution.
13: .\"
14: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24: .\"
1.15 ! sobrado 25: .Dd $Mdocdate: July 18 2008 $
1.1 markus 26: .Dt SFTP-SERVER 8
27: .Os
28: .Sh NAME
29: .Nm sftp-server
30: .Nd SFTP server subsystem
31: .Sh SYNOPSIS
32: .Nm sftp-server
1.11 djm 33: .Op Fl f Ar log_facility
34: .Op Fl l Ar log_level
1.1 markus 35: .Sh DESCRIPTION
36: .Nm
37: is a program that speaks the server side of SFTP protocol
38: to stdout and expects client requests from stdin.
39: .Nm
40: is not intended to be called directly, but from
1.3 aaron 41: .Xr sshd 8
1.1 markus 42: using the
43: .Cm Subsystem
44: option.
1.11 djm 45: .Pp
46: Command-line flags to
47: .Nm
48: should be specified in the
49: .Cm Subsystem
50: declaration.
1.1 markus 51: See
1.10 jmc 52: .Xr sshd_config 5
1.1 markus 53: for more information.
1.11 djm 54: .Pp
55: Valid options are:
56: .Bl -tag -width Ds
57: .It Fl f Ar log_facility
58: Specifies the facility code that is used when logging messages from
59: .Nm .
60: The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
61: LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
62: The default is AUTH.
63: .It Fl l Ar log_level
64: Specifies which messages will be logged by
65: .Nm .
66: The possible values are:
67: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
68: INFO and VERBOSE log transactions that
69: .Nm
70: performs on behalf of the client.
71: DEBUG and DEBUG1 are equivalent.
72: DEBUG2 and DEBUG3 each specify higher levels of debugging output.
73: The default is ERROR.
74: .El
1.13 djm 75: .Pp
76: For logging to work,
77: .Nm
78: must be able to access
79: .Pa /dev/log .
80: Use of
81: .Nm
1.15 ! sobrado 82: in a chroot configuration therefore requires that
1.13 djm 83: .Xr syslogd 8
84: establish a logging socket inside the chroot directory.
1.3 aaron 85: .Sh SEE ALSO
1.6 markus 86: .Xr sftp 1 ,
1.3 aaron 87: .Xr ssh 1 ,
1.10 jmc 88: .Xr sshd_config 5 ,
1.3 aaron 89: .Xr sshd 8
1.6 markus 90: .Rs
1.8 deraadt 91: .%A T. Ylonen
92: .%A S. Lehtinen
1.6 markus 93: .%T "SSH File Transfer Protocol"
94: .%N draft-ietf-secsh-filexfer-00.txt
95: .%D January 2001
96: .%O work in progress material
97: .Re
1.1 markus 98: .Sh HISTORY
99: .Nm
100: first appeared in
101: .Ox 2.8 .
1.9 jmc 102: .Sh AUTHORS
103: .An Markus Friedl Aq markus@openbsd.org