import of openssh-5.8p1
[openssh.git] / sftp-server.0
1 SFTP-SERVER(8)          OpenBSD System Manager's Manual         SFTP-SERVER(8)
2
3 NAME
4      sftp-server - SFTP server subsystem
5
6 SYNOPSIS
7      sftp-server [-ehR] [-f log_facility] [-l log_level] [-u umask]
8
9 DESCRIPTION
10      sftp-server is a program that speaks the server side of SFTP protocol to
11      stdout and expects client requests from stdin.  sftp-server is not
12      intended to be called directly, but from sshd(8) using the Subsystem
13      option.
14
15      Command-line flags to sftp-server should be specified in the Subsystem
16      declaration.  See sshd_config(5) for more information.
17
18      Valid options are:
19
20      -e      Causes sftp-server to print logging information to stderr instead
21              of syslog for debugging.
22
23      -f log_facility
24              Specifies the facility code that is used when logging messages
25              from sftp-server.  The possible values are: DAEMON, USER, AUTH,
26              LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
27              The default is AUTH.
28
29      -h      Displays sftp-server usage information.
30
31      -l log_level
32              Specifies which messages will be logged by sftp-server.  The
33              possible values are: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG,
34              DEBUG1, DEBUG2, and DEBUG3.  INFO and VERBOSE log transactions
35              that sftp-server performs on behalf of the client.  DEBUG and
36              DEBUG1 are equivalent.  DEBUG2 and DEBUG3 each specify higher
37              levels of debugging output.  The default is ERROR.
38
39      -R      Places this instance of sftp-server into a read-only mode.
40              Attempts to open files for writing, as well as other operations
41              that change the state of the filesystem, will be denied.
42
43      -u umask
44              Sets an explicit umask(2) to be applied to newly-created files
45              and directories, instead of the user's default mask.
46
47      For logging to work, sftp-server must be able to access /dev/log.  Use of
48      sftp-server in a chroot configuration therefore requires that syslogd(8)
49      establish a logging socket inside the chroot directory.
50
51 SEE ALSO
52      sftp(1), ssh(1), sshd_config(5), sshd(8)
53
54      T. Ylonen and S. Lehtinen, SSH File Transfer Protocol,
55      draft-ietf-secsh-filexfer-00.txt, January 2001, work in progress
56      material.
57
58 HISTORY
59      sftp-server first appeared in OpenBSD 2.8.
60
61 AUTHORS
62      Markus Friedl <markus@openbsd.org>
63
64 OpenBSD 4.9                     January 9, 2010                    OpenBSD 4.9