Reference Manual
Release Notes
PDF
Top

SSH
Reference Manual
Version 2.1

Expand All
Contract All

Table of Contents

- ssh
  - Top of manual page
  - close/1
  - connect/3
  - connect/4
  - connection_info/2
  - daemon/1
  - daemon/2
  - daemon/3
  - shell/1
  - shell/2
  - shell/3
  - start/0
  - start/1
  - stop/0
  - stop_daemon/1
  - stop_daemon/2
  - stop_listener/1
  - stop_listener/2
- ssh_channel
  - Top of manual page
  - call/2
  - call/3
  - cast/2
  - enter_loop/1
  - init/1
  - reply/2
  - start/4
  - start_link/4
  - CallbackModule:code_change/3
  - CallbackModule:init/1
  - CallbackModule:handle_call/3
  - CallbackModule:handle_cast/2
  - CallbackModule:handle_msg/2
  - CallbackModule:handle_ssh_msg/2
  - CallbackModule:terminate/2
- ssh_connection
  - Top of manual page
  - adjust_window/3
  - close/2
  - exec/4
  - exit_status/3
  - reply_request/4
  - send/3
  - send/4
  - send/4
  - send/5
  - send_eof/2
  - session_channel/2
  - session_channel/4
  - setenv/5
  - shell/2
  - subsystem/4
- ssh_sftp
  - Top of manual page
  - start_channel/1
  - start_channel/2
  - start_channel/2
  - start_channel/3
  - stop_channel/1
  - read_file/2
  - read_file/3
  - write_file/3
  - write_file/4
  - list_dir/2
  - list_dir/3
  - open/3
  - open/4
  - opendir/2
  - opendir/3
  - close/2
  - close/3
  - read/3
  - read/4
  - pread/4
  - pread/5
  - aread/3
  - apread/4
  - write/3
  - write/4
  - pwrite/4
  - pwrite/5
  - awrite/3
  - apwrite/4
  - position/3
  - position/4
  - read_file_info/2
  - read_file_info/3
  - read_link_info/2
  - read_link_info/3
  - write_file_info/3
  - write_file_info/4
  - read_link/2
  - read_link/3
  - make_symlink/3
  - make_symlink/4
  - rename/3
  - rename/4
  - delete/2
  - delete/3
  - make_dir/2
  - make_dir/3
  - del_dir/2
  - del_dir/3
- ssh_sftpd
  - Top of manual page
  - subsystem_spec/1

# ssh_sftpd

### MODULE

ssh_sftpd

### MODULE SUMMARY

Specifies a channel process to handle a sftp subsystem.

### DESCRIPTION

Specifies a channel process to handle a sftp subsystem.

### COMMON DATA TYPES

subsystem_spec() = {subsystem_name(), {channel_callback(), channel_init_args()}}

subsystem_name() = "sftp"

channel_callback() = atom() - Name of the erlang module implementing the subsystem using the ssh_channel behavior see ssh_channel(3)

channel_init_args() = list() - The one given as argument to function subsystem_spec/1.

### EXPORTS

subsystem_spec(Options) -> subsystem_spec()

Types:

Options = [{Option, Value}]

Should be used together with ssh:daemon/[1,2,3]

Options are:

{cwd, String}

  Sets the initial current working directory for the server.

{file_handler, CallbackModule}

  Determines which module to call for communicating with the file server. Default value is ssh_sftpd_file that uses the file and filelib API:s to access the standard OTP file server. This option may be used to plug in the use of other file servers.

{max_files, Integer}

  The default value is 0, which means that there is no upper limit. If supplied, the number of filenames returned to the sftp client per READDIR request, is limited to at most the given value.

{root, String}

  Sets the sftp root directory. The user will then not be able to see any files above this root. If for instance the root is set to /tmp the user will see this directory as / and if the user does cd /etc the user will end up in /tmp/etc.