usr/src/man/man1m/sftp-server.sunssh.1m

   1 '\" te
   2 .\" To view license terms, attribution, and copyright for OpenSSH, the default path is /var/sadm/pkg/SUNWsshdr/install/copyright. If the Solaris operating environment has been installed anywhere other than the default, modify the given path to access the file at the
   3 .\" installed location.
   4 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   5 .TH SFTP-SERVER 1M "Oct 24, 2007"
   6 .SH NAME
   7 sftp-server \- SFTP server subsystem
   8 .SH SYNOPSIS
   9 .LP
  10 .nf
  11 \fB/usr/lib/ssh/sftp-server\fR [\fB-f\fR \fIlog_facility\fR] [\fB-l\fR \fIlog_level\fR]
  12 .fi
  13
  14 .SH DESCRIPTION
  15 .LP
  16 \fBsftp-server\fR implements the server side of the SSH File Transfer Protocol
  17 as defined in the IETF \fBdraft-ietf-secsh-filexfer\fR.
  18 .sp
  19 .LP
  20 \fBsftp-server\fR is a subsystem for \fBsshd\fR(1M) and must not be run
  21 directly. Command-line flags to \fBsftp-server\fR should be specified in the
  22 Subsystem declaration. See \fBsshd_config\fR(4) for more information.
  23 .sp
  24 .LP
  25 To enable the \fBsftp-server\fR subsystem for \fBsshd\fR add the following to
  26 \fB/etc/ssh/sshd_config\fR:
  27 .sp
  28 .in +2
  29 .nf
  30 Subsystem   sftp     /usr/lib/ssh/sftp-server
  31 .fi
  32 .in -2
  33 .sp
  34
  35 .sp
  36 .LP
  37 See \fBsshd_config\fR(4) for a description of the format and contents of that
  38 file.
  39 .sp
  40 .LP
  41 There is no relationship between the protocol used by \fBsftp-server\fR and the
  42 FTP protocol (RFC 959).
  43 .SH OPTIONS
  44 .LP
  45 Valid options are listed below. As stated above, these are to be specified in
  46 the Subsystem declation of \fBsshd_config\fR.
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fB-f\fR \fIlog_facility\fR\fR
  51 .ad
  52 .sp .6
  53 .RS 4n
  54 Specifies the facility code that is used when logging messages from
  55 \fBsftp-server\fR. The possible values are: \fBDAEMON\fR, \fBUSER\fR,
  56 \fBAUTH\fR, \fBLOCAL0\fR, \fBLOCAL1\fR, \fBLOCAL2\fR, \fBLOCAL3\fR,
  57 \fBLOCAL4\fR, \fBLOCAL5\fR, \fBLOCAL6\fR, \fBLOCAL7\fR. The default is
  58 \fBAUTH\fR.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-l\fR \fIlog_level\fR\fR
  65 .ad
  66 .sp .6
  67 .RS 4n
  68 Specifies which messages will be logged by \fBsftp-server\fR. The possible
  69 values are: \fBQUIET\fR, \fBFATAL\fR, \fBERROR\fR, \fBINFO\fR, \fBVERBOSE\fR,
  70 \fBDEBUG\fR, \fBDEBUG1\fR, \fBDEBUG2\fR, and \fBDEBUG3\fR. \fBINFO\fR and
  71 \fBVERBOSE\fR log transactions that \fBsftp-server\fR performs on behalf of the
  72 client. \fBDEBUG\fR and \fBDEBUG1\fR are equivalent. \fBDEBUG2\fR and
  73 \fBDEBUG3\fR each specify higher levels of debugging output. The default is
  74 \fBERROR\fR.
  75 .RE
  76
  77 .SH EXIT STATUS
  78 .LP
  79 The following exit values are returned:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB0\fR\fR
  84 .ad
  85 .RS 6n
  86 Successful completion.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB>\fB0\fR\fR
  93 .ad
  94 .RS 6n
  95 An error occurred.
  96 .RE
  97
  98 .SH FILES
  99 .ne 2
 100 .na
 101 \fB\fB/usr/lib/ssh/sftp-server\fR\fR
 102 .ad
 103 .RS 28n
 104 Server-side binary.
 105 .RE
 106
 107 .SH ATTRIBUTES
 108 .LP
 109 See \fBattributes\fR(5) for descriptions of the following attributes:
 110 .sp
 111
 112 .sp
 113 .TS
 114 box;
 115 c | c
 116 l | l .
 117 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 118 _
 119 Interface Stability     Evolving
 120 .TE
 121
 122 .SH SEE ALSO
 123 .LP
 124 \fBsftp\fR(1), \fBssh\fR(1), \fBssh-add\fR(1), \fBssh-keygen\fR(1),
 125 \fBsshd\fR(1M), \fBsshd_config\fR(4), \fBattributes\fR(5)