1 .\" $OpenBSD: sftp-server.8,v 1.21 2013/01/04 19:26:38 jmc Exp $
4 .\" Copyright (c) 2000 Markus Friedl. All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 .Nd SFTP server subsystem
35 .Op Fl d Ar start_directory
36 .Op Fl f Ar log_facility
41 is a program that speaks the server side of SFTP protocol
42 to stdout and expects client requests from stdin.
44 is not intended to be called directly, but from
52 should be specified in the
61 .It Fl d Ar start_directory
62 specifies an alternate starting directory for users.
63 The pathname may contain the following tokens that are expanded at runtime:
64 %% is replaced by a literal '%',
65 %h is replaced by the home directory of the user being authenticated,
66 and %u is replaced by the username of that user.
67 The default is to use the user's home directory.
68 This option is useful in conjunction with the
75 to print logging information to stderr instead of syslog for debugging.
76 .It Fl f Ar log_facility
77 Specifies the facility code that is used when logging messages from
79 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
80 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
87 Specifies which messages will be logged by
89 The possible values are:
90 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
91 INFO and VERBOSE log transactions that
93 performs on behalf of the client.
94 DEBUG and DEBUG1 are equivalent.
95 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
98 Places this instance of
100 into a read-only mode.
101 Attempts to open files for writing, as well as other operations that change
102 the state of the filesystem, will be denied.
106 to be applied to newly-created files and directories, instead of the
112 must be able to access
116 in a chroot configuration therefore requires that
118 establish a logging socket inside the chroot directory.
127 .%T "SSH File Transfer Protocol"
128 .%N draft-ietf-secsh-filexfer-00.txt
130 .%O work in progress material
137 .An Markus Friedl Aq markus@openbsd.org