- jmc@cvs.openbsd.org 2006/07/18 08:03:09
[openssh-git.git] / sftp-server.8
blobda68e45fb1ef492110134762eef91cc19732506e
1 .\" $OpenBSD: sftp-server.8,v 1.11 2006/07/06 10:47:57 djm Exp $
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 .\"
25 .Dd August 30, 2000
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
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
41 .Xr sshd 8
42 using the
43 .Cm Subsystem
44 option.
45 .Pp
46 Command-line flags to
47 .Nm
48 should be specified in the
49 .Cm Subsystem
50 declaration.
51 See
52 .Xr sshd_config 5
53 for more information.
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
75 .Sh SEE ALSO
76 .Xr sftp 1 ,
77 .Xr ssh 1 ,
78 .Xr sshd_config 5 ,
79 .Xr sshd 8
80 .Rs
81 .%A T. Ylonen
82 .%A S. Lehtinen
83 .%T "SSH File Transfer Protocol"
84 .%N draft-ietf-secsh-filexfer-00.txt
85 .%D January 2001
86 .%O work in progress material
87 .Re
88 .Sh AUTHORS
89 .An Markus Friedl Aq markus@openbsd.org
90 .Sh HISTORY
91 .Nm
92 first appeared in OpenBSD 2.8 .