Return to sftp-server.8 CVS log

Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/sftp-server.8, Revision 1.16

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