- djm@cvs.openbsd.org 2010/01/09 00:20:26

[openssh.git] / sftp-server.8

diff --git a/sftp-server.8 b/sftp-server.8
index 199c4f30eec00214a5a8a6434bfdb2f9354b8aec..344dc826d29719c7345a1dedae43d4b1e7ec07ed 100644 (file)
--- a/sftp-server.8
+++ b/sftp-server.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sftp-server.8,v 1.11 2006/07/06 10:47:57 djm Exp $
+.\" $OpenBSD: sftp-server.8,v 1.18 2010/01/09 00:20:26 djm 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,8 +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 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


@@ -54,12 +56,20 @@ for more information.
 .Pp
 Valid options are:
 .Bl -tag -width Ds
 .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 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 .
 .It Fl l Ar log_level
 Specifies which messages will be logged by
 .Nm .


@@ -71,7 +81,28 @@ 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.
 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
 .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 ,