Upgrade to OpenSSH-5.3p1.
[dragonfly.git] / crypto / openssh / sftp-server.8
CommitLineData
40c002af 1.\" $OpenBSD: sftp-server.8,v 1.15 2009/03/26 08:38:39 sobrado Exp $
16c343f1
PA
2.\"
3.\" Copyright (c) 2000 Markus Friedl. All rights reserved.
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.\"
40c002af 25.Dd $Mdocdate: March 26 2009 $
16c343f1
PA
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
33.Op Fl f Ar log_facility
34.Op Fl l Ar log_level
35.Sh DESCRIPTION
36.Nm
37is a program that speaks the server side of SFTP protocol
38to stdout and expects client requests from stdin.
39.Nm
40is not intended to be called directly, but from
41.Xr sshd 8
42using the
43.Cm Subsystem
44option.
45.Pp
46Command-line flags to
47.Nm
48should be specified in the
49.Cm Subsystem
50declaration.
51See
52.Xr sshd_config 5
53for more information.
54.Pp
55Valid options are:
56.Bl -tag -width Ds
57.It Fl f Ar log_facility
58Specifies the facility code that is used when logging messages from
59.Nm .
60The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
61LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
62The default is AUTH.
63.It Fl l Ar log_level
64Specifies which messages will be logged by
65.Nm .
66The possible values are:
67QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
68INFO and VERBOSE log transactions that
69.Nm
70performs on behalf of the client.
71DEBUG and DEBUG1 are equivalent.
72DEBUG2 and DEBUG3 each specify higher levels of debugging output.
73The default is ERROR.
74.El
3b69e377
PA
75.Pp
76For logging to work,
77.Nm
78must be able to access
79.Pa /dev/log .
80Use of
81.Nm
40c002af 82in a chroot configuration therefore requires that
3b69e377
PA
83.Xr syslogd 8
84establish a logging socket inside the chroot directory.
16c343f1
PA
85.Sh SEE ALSO
86.Xr sftp 1 ,
87.Xr ssh 1 ,
88.Xr sshd_config 5 ,
89.Xr sshd 8
90.Rs
91.%A T. Ylonen
92.%A S. Lehtinen
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
98.Sh HISTORY
99.Nm
100first appeared in
101.Ox 2.8 .
102.Sh AUTHORS
103.An Markus Friedl Aq markus@openbsd.org