From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/ssh/doc/src/ssh.xml | 38 +++++++------- lib/ssh/doc/src/ssh_connection.xml | 32 ++++++------ lib/ssh/doc/src/ssh_sftp.xml | 104 ++++++++++++++++++------------------- lib/ssh/doc/src/ssh_sftpd.xml | 4 +- 4 files changed, 89 insertions(+), 89 deletions(-) (limited to 'lib/ssh') diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index 759c66d63c..1a53a2ea98 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -28,7 +28,7 @@ 2007-10-06 - ssh + ssh Main API of the ssh application

This is the interface module for the SSH application. @@ -1059,17 +1059,17 @@ - + Closes an SSH connection.

Closes an SSH connection.

- connect(Host, Port, Options) -> Result - connect(Host, Port, Options, NegotiationTimeout) -> Result + connect(Host, Port, Options) -> Result + connect(Host, Port, Options, NegotiationTimeout) -> Result connect(TcpSocket, Options) -> Result - connect(TcpSocket, Options, NegotiationTimeout) -> Result + connect(TcpSocket, Options, NegotiationTimeout) -> Result Connects to an SSH server. Host = host() @@ -1098,7 +1098,7 @@ - + Retrieves information about a connection.

Retrieves information about a connection. The list Keys defines which information that @@ -1108,9 +1108,9 @@ - daemon(Port | TcpSocket) -> Result - daemon(Port | TcpSocket, Options) -> Result - daemon(HostAddress, Port, Options) -> Result + daemon(Port | TcpSocket) -> Result + daemon(Port | TcpSocket, Options) -> Result + daemon(HostAddress, Port, Options) -> Result Starts a server listening for SSH connections. Port = integer() @@ -1176,9 +1176,9 @@ - shell(Host | TcpSocket) -> Result - shell(Host | TcpSocket, Options) -> Result - shell(Host, Port, Options) -> Result + shell(Host | TcpSocket) -> Result + shell(Host | TcpSocket, Options) -> Result + shell(Host, Port, Options) -> Result Starts an interactive shell on a remote SSH server. Host = host() @@ -1203,8 +1203,8 @@ - - + + Starts the SSH application.

Utility function that starts the applications crypto, public_key, @@ -1215,7 +1215,7 @@ - + Stops the ssh application.

Stops the ssh application. @@ -1225,8 +1225,8 @@ - - + + Stops the listener and all connections started by the listener. @@ -1235,8 +1235,8 @@ - - + + Stops the listener, but leaves existing connections started by the listener operational. diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml index 7933cff511..2a701929f6 100644 --- a/lib/ssh/doc/src/ssh_connection.xml +++ b/lib/ssh/doc/src/ssh_connection.xml @@ -30,7 +30,7 @@ - ssh_connection + ssh_connection This module provides API functions to send SSH Connection Protocol events to the other side of an SSH channel. @@ -201,7 +201,7 @@ - adjust_window(ConnectionRef, ChannelId, NumOfBytes) -> ok + adjust_window(ConnectionRef, ChannelId, NumOfBytes) -> ok Adjusts the SSH flow control window. ConnectionRef = connection_ref() @@ -221,7 +221,7 @@ - close(ConnectionRef, ChannelId) -> ok + close(ConnectionRef, ChannelId) -> ok Sends a close message on the channel ChannelId. ConnectionRef = connection_ref() @@ -240,7 +240,7 @@ - exec(ConnectionRef, ChannelId, Command, TimeOut) -> ssh_request_status() | + exec(ConnectionRef, ChannelId, Command, TimeOut) -> ssh_request_status() | {error, reason()} Requests that the server starts the execution of the given command. @@ -284,7 +284,7 @@ - exit_status(ConnectionRef, ChannelId, Status) -> ok + exit_status(ConnectionRef, ChannelId, Status) -> ok Sends the exit status of a command to the client. ConnectionRef = connection_ref() @@ -339,7 +339,7 @@ - reply_request(ConnectionRef, WantReply, Status, ChannelId) -> ok + reply_request(ConnectionRef, WantReply, Status, ChannelId) -> ok Sends status replies to requests that want such replies. ConnectionRef = connection_ref() @@ -357,10 +357,10 @@ - send(ConnectionRef, ChannelId, Data) -> - send(ConnectionRef, ChannelId, Data, Timeout) -> - send(ConnectionRef, ChannelId, Type, Data) -> - send(ConnectionRef, ChannelId, Type, Data, TimeOut) -> + send(ConnectionRef, ChannelId, Data) -> + send(ConnectionRef, ChannelId, Data, Timeout) -> + send(ConnectionRef, ChannelId, Type, Data) -> + send(ConnectionRef, ChannelId, Type, Data, TimeOut) -> ok | {error, timeout} | {error, closed} Sends channel data. @@ -380,7 +380,7 @@ - send_eof(ConnectionRef, ChannelId) -> ok | {error, closed} + send_eof(ConnectionRef, ChannelId) -> ok | {error, closed} Sends EOF on channel ChannelId. ConnectionRef = connection_ref() @@ -392,8 +392,8 @@ - session_channel(ConnectionRef, Timeout) -> - session_channel(ConnectionRef, InitialWindowSize, + session_channel(ConnectionRef, Timeout) -> + session_channel(ConnectionRef, InitialWindowSize, MaxPacketSize, Timeout) -> {ok, channel_id()} | {error, reason()} Opens a channel for an SSH session. @@ -410,7 +410,7 @@ - setenv(ConnectionRef, ChannelId, Var, Value, TimeOut) -> ssh_request_status() | + setenv(ConnectionRef, ChannelId, Var, Value, TimeOut) -> ssh_request_status() | {error, reason()} Environment variables can be passed to the shell/command to be started later. @@ -428,7 +428,7 @@ - shell(ConnectionRef, ChannelId) -> ok | failure | {error, closed} + shell(ConnectionRef, ChannelId) -> ok | failure | {error, closed} Requests that the user default shell (typically defined in /etc/passwd in Unix systems) is to be executed at the server end. @@ -448,7 +448,7 @@ - subsystem(ConnectionRef, ChannelId, Subsystem, Timeout) -> ssh_request_status() | + subsystem(ConnectionRef, ChannelId, Subsystem, Timeout) -> ssh_request_status() | {error, reason()} Requests to execute a predefined subsystem on the server. diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 780e132ae2..c89092798d 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -29,7 +29,7 @@ ssh_sftp.sgml - ssh_sftp + ssh_sftp SFTP client.

This module implements an SSH FTP (SFTP) client. SFTP is a @@ -82,7 +82,7 @@ - apread(ChannelPid, Handle, Position, Len) -> {async, N} | {error, reason()} + apread(ChannelPid, Handle, Position, Len) -> {async, N} | {error, reason()} Reads asynchronously from an open file. ChannelPid = pid() @@ -98,7 +98,7 @@ - apwrite(ChannelPid, Handle, Position, Data) -> {async, N} | {error, reason()} + apwrite(ChannelPid, Handle, Position, Data) -> {async, N} | {error, reason()} Writes asynchronously to an open file. ChannelPid = pid() @@ -116,7 +116,7 @@ - aread(ChannelPid, Handle, Len) -> {async, N} | {error, reason()} + aread(ChannelPid, Handle, Len) -> {async, N} | {error, reason()} Reads asynchronously from an open file. ChannelPid = pid() @@ -137,7 +137,7 @@ - awrite(ChannelPid, Handle, Data) -> {async, N} | {error, reason()} + awrite(ChannelPid, Handle, Data) -> {async, N} | {error, reason()} Writes asynchronously to an open file. ChannelPid = pid() @@ -159,8 +159,8 @@ - close(ChannelPid, Handle) -> - close(ChannelPid, Handle, Timeout) -> ok | {error, reason()} + close(ChannelPid, Handle) -> + close(ChannelPid, Handle, Timeout) -> ok | {error, reason()} Closes an open handle. ChannelPid = pid() @@ -173,8 +173,8 @@ - delete(ChannelPid, Name) -> - delete(ChannelPid, Name, Timeout) -> ok | {error, reason()} + delete(ChannelPid, Name) -> + delete(ChannelPid, Name, Timeout) -> ok | {error, reason()} Deletes a file. ChannelPid = pid() @@ -188,8 +188,8 @@ - del_dir(ChannelPid, Name) -> - del_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} + del_dir(ChannelPid, Name) -> + del_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} Deletes an empty directory. ChannelPid = pid() @@ -204,8 +204,8 @@ - list_dir(ChannelPid, Path) -> - list_dir(ChannelPid, Path, Timeout) -> {ok, Filenames} | {error, reason()} + list_dir(ChannelPid, Path) -> + list_dir(ChannelPid, Path, Timeout) -> {ok, Filenames} | {error, reason()} Lists the directory. ChannelPid = pid() @@ -221,8 +221,8 @@ - make_dir(ChannelPid, Name) -> - make_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} + make_dir(ChannelPid, Name) -> + make_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} Creates a directory. ChannelPid = pid() @@ -237,8 +237,8 @@ - make_symlink(ChannelPid, Name, Target) -> - make_symlink(ChannelPid, Name, Target, Timeout) -> ok | {error, reason()} + make_symlink(ChannelPid, Name, Target) -> + make_symlink(ChannelPid, Name, Target, Timeout) -> ok | {error, reason()} Creates a symbolic link. ChannelPid = pid() @@ -253,8 +253,8 @@ - open(ChannelPid, File, Mode) -> - open(ChannelPid, File, Mode, Timeout) -> {ok, Handle} | {error, reason()} + open(ChannelPid, File, Mode) -> + open(ChannelPid, File, Mode, Timeout) -> {ok, Handle} | {error, reason()} Opens a file and returns a handle. ChannelPid = pid() @@ -270,8 +270,8 @@ - opendir(ChannelPid, Path) -> - opendir(ChannelPid, Path, Timeout) -> {ok, Handle} | {error, reason()} + opendir(ChannelPid, Path) -> + opendir(ChannelPid, Path, Timeout) -> {ok, Handle} | {error, reason()} Opens a directory and returns a handle. ChannelPid = pid() @@ -339,8 +339,8 @@ - position(ChannelPid, Handle, Location) -> - position(ChannelPid, Handle, Location, Timeout) -> {ok, NewPosition | {error, reason()} + position(ChannelPid, Handle, Location) -> + position(ChannelPid, Handle, Location, Timeout) -> {ok, NewPosition | {error, reason()} Sets the file position of a file. ChannelPid = pid() @@ -384,8 +384,8 @@ - pread(ChannelPid, Handle, Position, Len) -> - pread(ChannelPid, Handle, Position, Len, Timeout) -> {ok, Data} | eof | {error, reason()} + pread(ChannelPid, Handle, Position, Len) -> + pread(ChannelPid, Handle, Position, Len, Timeout) -> {ok, Data} | eof | {error, reason()} Reads from an open file. ChannelPid = pid() @@ -402,8 +402,8 @@ - pwrite(ChannelPid, Handle, Position, Data) -> ok - pwrite(ChannelPid, Handle, Position, Data, Timeout) -> ok | {error, reason()} + pwrite(ChannelPid, Handle, Position, Data) -> ok + pwrite(ChannelPid, Handle, Position, Data, Timeout) -> ok | {error, reason()} Writes to an open file. ChannelPid = pid() @@ -419,8 +419,8 @@ - read(ChannelPid, Handle, Len) -> - read(ChannelPid, Handle, Len, Timeout) -> {ok, Data} | eof | {error, reason()} + read(ChannelPid, Handle, Len) -> + read(ChannelPid, Handle, Len, Timeout) -> {ok, Data} | eof | {error, reason()} Reads from an open file. ChannelPid = pid() @@ -441,8 +441,8 @@ - read_file(ChannelPid, File) -> - read_file(ChannelPid, File, Timeout) -> {ok, Data} | {error, reason()} + read_file(ChannelPid, File) -> + read_file(ChannelPid, File, Timeout) -> {ok, Data} | {error, reason()} Reads a file. ChannelPid = pid() @@ -456,8 +456,8 @@ - read_file_info(ChannelPid, Name) -> - read_file_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} + read_file_info(ChannelPid, Name) -> + read_file_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} Gets information about a file. ChannelPid = pid() @@ -481,8 +481,8 @@ - read_link(ChannelPid, Name) -> - read_link(ChannelPid, Name, Timeout) -> {ok, Target} | {error, reason()} + read_link(ChannelPid, Name) -> + read_link(ChannelPid, Name, Timeout) -> {ok, Target} | {error, reason()} Reads symbolic link. ChannelPid = pid() @@ -496,8 +496,8 @@ - read_link_info(ChannelPid, Name) -> {ok, FileInfo} | {error, reason()} - read_link_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} + read_link_info(ChannelPid, Name) -> {ok, FileInfo} | {error, reason()} + read_link_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} Gets information about a symbolic link. ChannelPid = pid() @@ -517,8 +517,8 @@ - rename(ChannelPid, OldName, NewName) -> - rename(ChannelPid, OldName, NewName, Timeout) -> ok | {error, reason()} + rename(ChannelPid, OldName, NewName) -> + rename(ChannelPid, OldName, NewName, Timeout) -> ok | {error, reason()} Renames a file. ChannelPid = pid() @@ -534,16 +534,16 @@ - start_channel(ConnectionRef) -> - start_channel(ConnectionRef, Options) -> + start_channel(ConnectionRef) -> + start_channel(ConnectionRef, Options) -> {ok, Pid} | {error, reason()|term()} - start_channel(Host, Options) -> - start_channel(Host, Port, Options) -> + start_channel(Host, Options) -> + start_channel(Host, Port, Options) -> {ok, Pid, ConnectionRef} | {error, reason()|term()} - start_channel(TcpSocket) -> - start_channel(TcpSocket, Options) -> + start_channel(TcpSocket) -> + start_channel(TcpSocket, Options) -> {ok, Pid, ConnectionRef} | {error, reason()|term()} Starts an SFTP client. @@ -594,7 +594,7 @@ - stop_channel(ChannelPid) -> ok + stop_channel(ChannelPid) -> ok Stops the SFTP client channel. ChannelPid = pid() @@ -606,8 +606,8 @@ - write(ChannelPid, Handle, Data) -> - write(ChannelPid, Handle, Data, Timeout) -> ok | {error, reason()} + write(ChannelPid, Handle, Data) -> + write(ChannelPid, Handle, Data, Timeout) -> ok | {error, reason()} Writes to an open file. ChannelPid = pid() @@ -625,8 +625,8 @@ - write_file(ChannelPid, File, Iolist) -> - write_file(ChannelPid, File, Iolist, Timeout) -> ok | {error, reason()} + write_file(ChannelPid, File, Iolist) -> + write_file(ChannelPid, File, Iolist, Timeout) -> ok | {error, reason()} Writes a file. ChannelPid = pid() @@ -641,8 +641,8 @@ - write_file_info(ChannelPid, Name, Info) -> - write_file_info(ChannelPid, Name, Info, Timeout) -> ok | {error, reason()} + write_file_info(ChannelPid, Name, Info) -> + write_file_info(ChannelPid, Name, Info, Timeout) -> ok | {error, reason()} Writes information for a file. ChannelPid = pid() diff --git a/lib/ssh/doc/src/ssh_sftpd.xml b/lib/ssh/doc/src/ssh_sftpd.xml index 3b34150e98..ee72784add 100644 --- a/lib/ssh/doc/src/ssh_sftpd.xml +++ b/lib/ssh/doc/src/ssh_sftpd.xml @@ -29,7 +29,7 @@ ssh_sftpd.sgml - ssh_sftpd + ssh_sftpd Specifies the channel process to handle an SFTP subsystem.

Specifies a channel process to handle an SFTP subsystem.

@@ -51,7 +51,7 @@ - subsystem_spec(Options) -> subsystem_spec() + subsystem_spec(Options) -> subsystem_spec() Returns the subsystem specification that allows an SSH daemon to handle the subsystem "sftp". Options = [{Option, Value}] -- cgit v1.2.3