1ssh_sftpd(3)               Erlang Module Definition               ssh_sftpd(3)
2
3
4

NAME

6       ssh_sftpd - Specifies the channel process to handle an SFTP subsystem.
7

DESCRIPTION

9       Specifies a channel process to handle an SFTP subsystem.
10

DATA TYPES

12         subsystem_spec() =:
13           {subsystem_name(), {channel_callback(), channel_init_args()}}
14
15         subsystem_name() =:
16           "sftp"
17
18         channel_callback() =:
19           atom() - Name of the Erlang module implementing the subsystem using
20           the ssh_server_channel (replaces ssh_daemon_channel) behaviour.
21
22         channel_init_args() =:
23           list() - The one given as argument to function subsystem_spec/1.
24

EXPORTS

26       subsystem_spec(Options) -> subsystem_spec()
27
28              Types:
29
30                 Options = [{Option, Value}]
31
32              Is to be used together with ssh:daemon/[1,2,3]
33
34              Options:
35
36                {cwd, String}:
37                  Sets the initial current working directory for the server.
38
39                {file_handler, CallbackModule}:
40                  Determines which module  to  call  for  accessing  the  file
41                  server.  The default value is ssh_sftpd_file, which uses the
42                  file and filelib  APIs  to  access  the  standard  OTP  file
43                  server.  This  option  can  be  used  to  plug in other file
44                  servers.
45
46                {max_files, Integer}:
47                  The default value is 0, which means that there is  no  upper
48                  limit.  If supplied, the number of filenames returned to the
49                  SFTP client per READDIR request is limited to  at  most  the
50                  given value.
51
52                {root, String}:
53                  Sets  the  SFTP root directory. Then the user cannot see any
54                  files above this root. If, for example, the  root  directory
55                  is  set  to /tmp, then the user sees this directory as /. If
56                  the user then writes cd /etc, the user moves to /tmp/etc.
57
58                {sftpd_vsn, integer()}:
59                  Sets the SFTP version to use. Defaults to 5.  Version  6  is
60                  under development and limited.
61
62
63
64Ericsson AB                        ssh 4.7.6                      ssh_sftpd(3)