blob: 199c4f30eec00214a5a8a6434bfdb2f9354b8aec [file] [log] [blame]
Damien Millerfef95ad2006-07-10 20:46:55 +10001.\" $OpenBSD: sftp-server.8,v 1.11 2006/07/06 10:47:57 djm Exp $
Damien Millere4340be2000-09-16 13:29:08 +11002.\"
Ben Lindstrom92a2e382001-03-05 06:59:27 +00003.\" Copyright (c) 2000 Markus Friedl. All rights reserved.
Damien Millere4340be2000-09-16 13:29:08 +11004.\"
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.\"
Damien Miller7b28dc52000-09-05 13:34:53 +110025.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
Damien Millerfef95ad2006-07-10 20:46:55 +100033.Op Fl f Ar log_facility
34.Op Fl l Ar log_level
Damien Miller7b28dc52000-09-05 13:34:53 +110035.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
Damien Miller50a41ed2000-10-16 12:14:42 +110041.Xr sshd 8
Damien Miller7b28dc52000-09-05 13:34:53 +110042using the
43.Cm Subsystem
44option.
Damien Millerfef95ad2006-07-10 20:46:55 +100045.Pp
46Command-line flags to
47.Nm
48should be specified in the
49.Cm Subsystem
50declaration.
Damien Miller7b28dc52000-09-05 13:34:53 +110051See
Darren Tucker1f203942003-10-15 15:50:42 +100052.Xr sshd_config 5
Damien Miller7b28dc52000-09-05 13:34:53 +110053for more information.
Damien Millerfef95ad2006-07-10 20:46:55 +100054.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
Damien Miller7b28dc52000-09-05 13:34:53 +110075.Sh SEE ALSO
Ben Lindstrom160ec622001-04-22 17:17:46 +000076.Xr sftp 1 ,
Damien Miller7b28dc52000-09-05 13:34:53 +110077.Xr ssh 1 ,
Darren Tucker1f203942003-10-15 15:50:42 +100078.Xr sshd_config 5 ,
Damien Miller50a41ed2000-10-16 12:14:42 +110079.Xr sshd 8
Ben Lindstrom160ec622001-04-22 17:17:46 +000080.Rs
Ben Lindstrom90fd0602001-06-25 04:45:33 +000081.%A T. Ylonen
82.%A S. Lehtinen
Ben Lindstrom160ec622001-04-22 17:17:46 +000083.%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
Damien Miller50a41ed2000-10-16 12:14:42 +110088.Sh HISTORY
89.Nm
Darren Tucker25bd3c02006-09-26 20:14:28 +100090first appeared in
91.Ox 2.8 .
92.Sh AUTHORS
93.An Markus Friedl Aq markus@openbsd.org