]>
Commit | Line | Data |
---|---|---|
b7177174 | 1 | .\" $OpenBSD: sftp-server.8,v 1.17 2009/08/31 21:01:29 djm Exp $ |
bcbf86ec | 2 | .\" |
f3c7c613 | 3 | .\" Copyright (c) 2000 Markus Friedl. All rights reserved. |
bcbf86ec | 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 | .\" | |
e473dcd1 | 25 | .Dd $Mdocdate$ |
b5e300c2 | 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 | |
b7177174 | 33 | .Op Fl eh |
a13880bb | 34 | .Op Fl f Ar log_facility |
35 | .Op Fl l Ar log_level | |
62b92bdc | 36 | .Op Fl u Ar umask |
b5e300c2 | 37 | .Sh DESCRIPTION |
38 | .Nm | |
39 | is a program that speaks the server side of SFTP protocol | |
40 | to stdout and expects client requests from stdin. | |
41 | .Nm | |
42 | is not intended to be called directly, but from | |
33de75a3 | 43 | .Xr sshd 8 |
b5e300c2 | 44 | using the |
45 | .Cm Subsystem | |
46 | option. | |
a13880bb | 47 | .Pp |
48 | Command-line flags to | |
49 | .Nm | |
50 | should be specified in the | |
51 | .Cm Subsystem | |
52 | declaration. | |
b5e300c2 | 53 | See |
433e60ac | 54 | .Xr sshd_config 5 |
b5e300c2 | 55 | for more information. |
a13880bb | 56 | .Pp |
57 | Valid options are: | |
58 | .Bl -tag -width Ds | |
b7177174 | 59 | .It Fl e |
60 | Causes | |
61 | .Nm | |
62 | to print logging information to stderr instead of syslog for debugging. | |
a13880bb | 63 | .It Fl f Ar log_facility |
64 | Specifies the facility code that is used when logging messages from | |
65 | .Nm . | |
66 | The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, | |
67 | LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. | |
68 | The default is AUTH. | |
b7177174 | 69 | .It Fl h |
70 | Displays | |
71 | .Nm | |
72 | usage information. | |
a13880bb | 73 | .It Fl l Ar log_level |
74 | Specifies which messages will be logged by | |
75 | .Nm . | |
76 | The possible values are: | |
77 | QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. | |
78 | INFO and VERBOSE log transactions that | |
79 | .Nm | |
80 | performs on behalf of the client. | |
81 | DEBUG and DEBUG1 are equivalent. | |
82 | DEBUG2 and DEBUG3 each specify higher levels of debugging output. | |
83 | The default is ERROR. | |
62b92bdc | 84 | .It Fl u Ar umask |
85 | Sets an explicit | |
86 | .Xr umask 2 | |
87 | to be applied to newly-created files and directories, instead of the | |
88 | user's default mask. | |
a13880bb | 89 | .El |
66fba053 | 90 | .Pp |
91 | For logging to work, | |
92 | .Nm | |
93 | must be able to access | |
94 | .Pa /dev/log . | |
95 | Use of | |
96 | .Nm | |
b31ae930 | 97 | in a chroot configuration therefore requires that |
66fba053 | 98 | .Xr syslogd 8 |
99 | establish a logging socket inside the chroot directory. | |
b5e300c2 | 100 | .Sh SEE ALSO |
2cad6cef | 101 | .Xr sftp 1 , |
b5e300c2 | 102 | .Xr ssh 1 , |
433e60ac | 103 | .Xr sshd_config 5 , |
33de75a3 | 104 | .Xr sshd 8 |
2cad6cef | 105 | .Rs |
7b518233 | 106 | .%A T. Ylonen |
107 | .%A S. Lehtinen | |
2cad6cef | 108 | .%T "SSH File Transfer Protocol" |
109 | .%N draft-ietf-secsh-filexfer-00.txt | |
110 | .%D January 2001 | |
111 | .%O work in progress material | |
112 | .Re | |
33de75a3 | 113 | .Sh HISTORY |
114 | .Nm | |
5ed1a353 | 115 | first appeared in |
116 | .Ox 2.8 . | |
117 | .Sh AUTHORS | |
118 | .An Markus Friedl Aq markus@openbsd.org |