- guenther@cvs.openbsd.org 2010/01/15 00:05:22

[openssh.git] / sftp-server.8

diff --git a/sftp-server.8 b/sftp-server.8
index 42f5d437cd5e1b6ea8fe954ecce6543ff50a5988..7dc81684e58e6f96634ba3afbbc0a459424d43a4 100644 (file)
--- a/sftp-server.8
+++ b/sftp-server.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sftp-server.8,v 1.10 2003/10/08 08:27:36 jmc Exp $
+.\" $OpenBSD: sftp-server.8,v 1.19 2010/01/09 03:36:00 jmc Exp $

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


@@ -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 ehR
+.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,9 +44,65 @@ 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
 .Xr sshd_config 5
 for more information.
 See
 .Xr sshd_config 5
 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 R
+Places this instance of
+.Nm
+into a read-only mode.
+Attempts to open files for writing, as well as other operations that change
+the state of the filesystem, will be denied.
+.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
 .Xr sftp 1 ,
 .Xr ssh 1 ,
 .Sh SEE ALSO
 .Xr sftp 1 ,
 .Xr ssh 1 ,


@@ -56,8 +116,9 @@ for more information.
 .%D January 2001
 .%O work in progress material
 .Re
 .%D January 2001
 .%O work in progress material
 .Re

-.Sh AUTHORS
-.An Markus Friedl Aq markus@openbsd.org

 .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