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