- djm@cvs.openbsd.org 2009/12/20 23:20:40

[openssh.git] / sftp-server.8

diff --git a/sftp-server.8 b/sftp-server.8
index b8d579a9fd561e37ef6ff9c645c0d6fa02e3906b..ef6d3b3242e2a47ad0395129ec2f7482e5aea328 100644 (file)
--- a/sftp-server.8
+++ b/sftp-server.8
@@ -1,6 +1,6 @@
-.\" $OpenBSD: sftp-server.8,v 1.4 2000/11/10 05:10:40 aaron Exp $
+.\" $OpenBSD: sftp-server.8,v 1.17 2009/08/31 21:01:29 djm Exp $

 .\"
 .\"

-.\" Copyright (c) 2000 Markus Friedl. All rights reserved.
+.\" Copyright (c) 2000 Markus Friedl.  All rights reserved.

 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions


@@ -22,7 +22,7 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"

-.Dd August 30, 2000
+.Dd $Mdocdate$

 .Dt SFTP-SERVER 8
 .Os
 .Sh NAME
 .Dt SFTP-SERVER 8
 .Os
 .Sh NAME


@@ -30,6 +30,10 @@
 .Nd SFTP server subsystem
 .Sh SYNOPSIS
 .Nm sftp-server
 .Nd SFTP server subsystem
 .Sh SYNOPSIS
 .Nm sftp-server

+.Op Fl eh
+.Op Fl f Ar log_facility
+.Op Fl l Ar log_level
+.Op Fl u Ar umask

 .Sh DESCRIPTION
 .Nm
 is a program that speaks the server side of SFTP protocol
 .Sh DESCRIPTION
 .Nm
 is a program that speaks the server side of SFTP protocol


@@ -40,16 +44,75 @@ is not intended to be called directly, but from
 using the
 .Cm Subsystem
 option.
 using the
 .Cm Subsystem
 option.

+.Pp
+Command-line flags to
+.Nm
+should be specified in the
+.Cm Subsystem
+declaration.

 See
 See

-.Xr sshd 8
+.Xr sshd_config 5

 for more information.
 for more information.

+.Pp
+Valid options are:
+.Bl -tag -width Ds
+.It Fl e
+Causes
+.Nm
+to print logging information to stderr instead of syslog for debugging.
+.It Fl f Ar log_facility
+Specifies the facility code that is used when logging messages from
+.Nm .
+The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
+LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
+The default is AUTH.
+.It Fl h
+Displays
+.Nm
+usage information.
+.It Fl l Ar log_level
+Specifies which messages will be logged by
+.Nm .
+The possible values are:
+QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
+INFO and VERBOSE log transactions that
+.Nm
+performs on behalf of the client.
+DEBUG and DEBUG1 are equivalent.
+DEBUG2 and DEBUG3 each specify higher levels of debugging output.
+The default is ERROR.
+.It Fl u Ar umask
+Sets an explicit
+.Xr umask 2
+to be applied to newly-created files and directories, instead of the
+user's default mask.
+.El
+.Pp
+For logging to work,
+.Nm
+must be able to access
+.Pa /dev/log .
+Use of
+.Nm
+in a chroot configuration therefore requires that
+.Xr syslogd 8
+establish a logging socket inside the chroot directory.

 .Sh SEE ALSO
 .Sh SEE ALSO

+.Xr sftp 1 ,

 .Xr ssh 1 ,
 .Xr ssh 1 ,

-.Xr ssh-add 1 ,
-.Xr ssh-keygen 1 ,
+.Xr sshd_config 5 ,

 .Xr sshd 8
 .Xr sshd 8

-.Sh AUTHORS
-Markus Friedl <markus@openbsd.org>
+.Rs
+.%A T. Ylonen
+.%A S. Lehtinen
+.%T "SSH File Transfer Protocol"
+.%N draft-ietf-secsh-filexfer-00.txt
+.%D January 2001
+.%O work in progress material
+.Re

 .Sh HISTORY
 .Nm
 .Sh HISTORY
 .Nm

-first appeared in OpenBSD 2.8 .
+first appeared in
+.Ox 2.8 .
+.Sh AUTHORS
+.An Markus Friedl Aq markus@openbsd.org