summaryrefslogtreecommitdiff
path: root/lib/ssh/doc
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ssh/doc')
-rw-r--r--lib/ssh/doc/src/configure_algos.xml6
-rw-r--r--lib/ssh/doc/src/introduction.xml6
-rw-r--r--lib/ssh/doc/src/ssh.xml26
-rw-r--r--lib/ssh/doc/src/ssh_agent.xml10
-rw-r--r--lib/ssh/doc/src/ssh_client_channel.xml32
-rw-r--r--lib/ssh/doc/src/ssh_client_key_api.xml2
-rw-r--r--lib/ssh/doc/src/ssh_connection.xml24
-rw-r--r--lib/ssh/doc/src/ssh_file.xml20
-rw-r--r--lib/ssh/doc/src/ssh_protocol.xml6
-rw-r--r--lib/ssh/doc/src/ssh_server_channel.xml4
-rw-r--r--lib/ssh/doc/src/ssh_server_key_api.xml2
-rw-r--r--lib/ssh/doc/src/ssh_sftp.xml32
-rw-r--r--lib/ssh/doc/src/using_ssh.xml10
13 files changed, 90 insertions, 90 deletions
diff --git a/lib/ssh/doc/src/configure_algos.xml b/lib/ssh/doc/src/configure_algos.xml
index fa45b1cb4c..46721a40be 100644
--- a/lib/ssh/doc/src/configure_algos.xml
+++ b/lib/ssh/doc/src/configure_algos.xml
@@ -116,7 +116,7 @@
</list>
<p>Due to this, it impossible to list in documentation what algorithms that are available in a certain installation.</p>
<p>There is an important command to list the actual algorithms and their ordering:
- <seealso marker="ssh#default_algorithms-0">ssh:default_algorithms/0</seealso>.</p>
+ <seealso marker="ssh#default_algorithms/0">ssh:default_algorithms/0</seealso>.</p>
<marker id="example_default_algorithms"/>
<code type="erl">
0> ssh:default_algorithms().
@@ -145,9 +145,9 @@
</code>
<p>To change the algorithm list, there are two options which can be used in
- <seealso marker="ssh#connect-3">ssh:connect/2,3,4</seealso>
+ <seealso marker="ssh#connect/3">ssh:connect/2,3,4</seealso>
and
- <seealso marker="ssh#daemon-2">ssh:daemon/2,3</seealso>. The options could of course
+ <seealso marker="ssh#daemon/2">ssh:daemon/2,3</seealso>. The options could of course
be used in all other functions that initiates connections.</p>
<p>The options are <c>preferred_algorithms</c> and <c>modify_algorithms</c>. The first one
diff --git a/lib/ssh/doc/src/introduction.xml b/lib/ssh/doc/src/introduction.xml
index 8444daf0cc..b69d497315 100644
--- a/lib/ssh/doc/src/introduction.xml
+++ b/lib/ssh/doc/src/introduction.xml
@@ -106,8 +106,8 @@
</list>
<p>Several configuration options for
authentication handling are available in
- <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso>
- and <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso>.</p>
+ <seealso marker="ssh#connect/3">ssh:connect/[3,4]</seealso>
+ and <seealso marker="ssh#daemon/2">ssh:daemon/[2,3]</seealso>.</p>
<p>
The public key handling can be customized by implementing
the following behaviours from <c>ssh</c>:</p>
@@ -168,7 +168,7 @@
but that is much more work.
</item>
<item><em>Exec</em> - One-time remote execution of commands. See function
- <seealso marker="ssh_connection#exec-4">ssh_connection:exec/4</seealso>
+ <seealso marker="ssh_connection#exec/4">ssh_connection:exec/4</seealso>
for more information.</item>
</list>
</section>
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 9ed67a3c8b..b5275e0564 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -214,7 +214,7 @@
<list type="bulleted">
<item><c>PeerName</c> - a string with the name or address of the remote host.</item>
<item><c>FingerPrint</c> - the fingerprint of the Host Key as
- <seealso marker="public_key:public_key#ssh_hostkey_fingerprint-1">public_key:ssh_hostkey_fingerprint/1</seealso>
+ <seealso marker="public_key:public_key#ssh_hostkey_fingerprint/1">public_key:ssh_hostkey_fingerprint/1</seealso>
calculates it.
</item>
</list>
@@ -224,7 +224,7 @@
shall be used to calculate the fingerprint used in the call of the <c>accept_callback()</c>.
The <c>HashALgoSpec</c>
is either an atom or a list of atoms as the first argument in
- <seealso marker="public_key:public_key#ssh_hostkey_fingerprint-2">public_key:ssh_hostkey_fingerprint/2</seealso>.
+ <seealso marker="public_key:public_key#ssh_hostkey_fingerprint/2">public_key:ssh_hostkey_fingerprint/2</seealso>.
If it is a list of hash algorithm names, the <c>FingerPrint</c> argument in the
<c>accept_callback()</c> will be
a list of fingerprints in the same order as the corresponding name in the <c>HashAlgoSpec</c> list.
@@ -750,7 +750,7 @@
<name name="tcpip_tunnel_in_daemon_option"/>
<desc>
<p>Enables (<c>true</c>) or disables (<c>false</c>) the possibility to tunnel a TCP/IP connection in to a
- <seealso marker="ssh:ssh#daemon-2">server</seealso>.
+ <seealso marker="ssh:ssh#daemon/2">server</seealso>.
Disabled per default.
</p>
</desc>
@@ -760,7 +760,7 @@
<name name="tcpip_tunnel_out_daemon_option"/>
<desc>
<p>Enables (<c>true</c>) or disables (<c>false</c>) the possibility to tunnel a TCP/IP connection out of a
- <seealso marker="ssh:ssh#daemon-2">server</seealso>.
+ <seealso marker="ssh:ssh#daemon/2">server</seealso>.
Disabled per default.
</p>
</desc>
@@ -847,9 +847,9 @@
<seealso marker="ssh_client_key_api">ssh_client_key_api</seealso> and/or
<seealso marker="ssh_server_key_api">ssh_server_key_api</seealso>.
The <c>UserOptions</c> are the options given to
- <seealso marker="ssh:ssh#connect-3">ssh:connect</seealso>,
- <seealso marker="ssh:ssh#shell-1">ssh:shell</seealso> or
- <seealso marker="ssh:ssh#daemon-2">ssh:daemon</seealso>.
+ <seealso marker="ssh:ssh#connect/3">ssh:connect</seealso>,
+ <seealso marker="ssh:ssh#shell/1">ssh:shell</seealso> or
+ <seealso marker="ssh:ssh#daemon/2">ssh:daemon</seealso>.
</p>
</desc>
@@ -974,7 +974,7 @@
<item>
<p>Input is the <c>modify_algs_list()</c> and a set of algorithms <c>A</c>
obtained from the <c>preferred_algorithms</c> option if existing, or else from the
- <seealso marker="ssh#default_algorithms-0">ssh:default_algorithms/0</seealso>.
+ <seealso marker="ssh#default_algorithms/0">ssh:default_algorithms/0</seealso>.
</p>
</item>
<item>
@@ -1077,8 +1077,8 @@
<datatype>
<name name="open_socket"/>
<desc>
- <p>The socket is supposed to be result of a <seealso marker="kernel:gen_tcp#connect-3">gen_tcp:connect</seealso>
- or a <seealso marker="kernel:gen_tcp#accept-1">gen_tcp:accept</seealso>. The socket must be in passive
+ <p>The socket is supposed to be result of a <seealso marker="kernel:gen_tcp#connect/3">gen_tcp:connect</seealso>
+ or a <seealso marker="kernel:gen_tcp#accept/1">gen_tcp:accept</seealso>. The socket must be in passive
mode (that is, opened with the option <c>{active,false})</c>.
</p>
</desc>
@@ -1088,7 +1088,7 @@
<name name="daemon_ref"/>
<desc>
<p>Opaque data type representing a daemon.</p>
- <p>Returned by the functions <seealso marker="ssh#daemon-1"><c>daemon/1,2,3</c></seealso>.</p>
+ <p>Returned by the functions <seealso marker="ssh#daemon/1"><c>daemon/1,2,3</c></seealso>.</p>
</desc>
</datatype>
@@ -1097,8 +1097,8 @@
<desc>
<p>Opaque data type representing a connection between a client and a server (daemon).</p>
<p>Returned by the functions
- <seealso marker="ssh#connect-3"><c>connect/2,3,4</c></seealso> and
- <seealso marker="ssh_sftp#start_channel-2"><c>ssh_sftp:start_channel/2,3</c></seealso>.
+ <seealso marker="ssh#connect/3"><c>connect/2,3,4</c></seealso> and
+ <seealso marker="ssh_sftp#start_channel/2"><c>ssh_sftp:start_channel/2,3</c></seealso>.
</p>
</desc>
</datatype>
diff --git a/lib/ssh/doc/src/ssh_agent.xml b/lib/ssh/doc/src/ssh_agent.xml
index 034b6b3b66..290d3febf4 100644
--- a/lib/ssh/doc/src/ssh_agent.xml
+++ b/lib/ssh/doc/src/ssh_agent.xml
@@ -43,8 +43,8 @@
allow it to be used by setting the option
<seealso marker="ssh:ssh#type-key_cb_common_option"><c>key_cb</c></seealso>
when starting a client (with for example
- <seealso marker="ssh:ssh#connect-3">ssh:connect</seealso>,
- <seealso marker="ssh:ssh#shell-1">ssh:shell</seealso>
+ <seealso marker="ssh:ssh#connect/3">ssh:connect</seealso>,
+ <seealso marker="ssh:ssh#shell/1">ssh:shell</seealso>
).
</p>
<code type="erl">
@@ -106,7 +106,7 @@
<fsummary></fsummary>
<desc>
<p>
- This callback is delegated to the <seealso marker="ssh:ssh_file#add_host_key-4">ssh_file</seealso> module.
+ This callback is delegated to the <seealso marker="ssh:ssh_file#add_host_key/4">ssh_file</seealso> module.
</p>
</desc>
</func>
@@ -117,7 +117,7 @@
<fsummary></fsummary>
<desc>
<p>
- This callback is delegated to the <seealso marker="ssh:ssh_file#is_host_key-5">ssh_file</seealso> module.
+ This callback is delegated to the <seealso marker="ssh:ssh_file#is_host_key/5">ssh_file</seealso> module.
</p>
</desc>
</func>
@@ -128,7 +128,7 @@
<desc>
<p><strong>Types and description</strong></p>
<p>See the api description in
- <seealso marker="ssh:ssh_client_key_api#Module:user_key-2">ssh_client_key_api, Module:user_key/2</seealso>.
+ <seealso marker="ssh:ssh_client_key_api#Module:user_key/2">ssh_client_key_api, Module:user_key/2</seealso>.
</p>
</desc>
</func>
diff --git a/lib/ssh/doc/src/ssh_client_channel.xml b/lib/ssh/doc/src/ssh_client_channel.xml
index e5f64ea603..4eba4939f6 100644
--- a/lib/ssh/doc/src/ssh_client_channel.xml
+++ b/lib/ssh/doc/src/ssh_client_channel.xml
@@ -73,7 +73,7 @@
<fsummary>Makes a synchronous call to a channel.</fsummary>
<type>
<v>ChannelRef = pid() </v>
- <d>As returned by <seealso marker = "#start_link-4">start_link/4</seealso></d>
+ <d>As returned by <seealso marker = "#start_link/4">start_link/4</seealso></d>
<v>Msg = term()</v>
<v>Timeout = timeout()</v>
<v>Reply = term()</v>
@@ -84,7 +84,7 @@
<p>Makes a synchronous call to the channel process by sending
a message and waiting until a reply arrives, or a time-out
occurs. The channel calls <seealso marker =
- "#Module:handle_call-3">Module:handle_call/3</seealso>
+ "#Module:handle_call/3">Module:handle_call/3</seealso>
to handle the message. If the channel process does not exist,
<c>{error, closed}</c> is returned.
</p>
@@ -97,14 +97,14 @@
ChannelRef and returns ok.</fsummary>
<type>
<v>ChannelRef = pid()</v>
- <d>As returned by <seealso marker = "#start_link-4">start_link/4</seealso></d>
+ <d>As returned by <seealso marker = "#start_link/4">start_link/4</seealso></d>
<v>Msg = term()</v>
</type>
<desc>
<p>Sends an asynchronous message to the channel process and
returns ok immediately, ignoring if the destination node or
channel process does not exist. The channel calls
- <seealso marker = "#Module:handle_cast-2">Module:handle_cast/2</seealso>
+ <seealso marker = "#Module:handle_cast/2">Module:handle_cast/2</seealso>
to handle the message.
</p>
</desc>
@@ -115,7 +115,7 @@
<fsummary>Makes an existing process an ssh_client_channel (replaces ssh_channel) process.</fsummary>
<type>
<v>State = term()</v>
- <d>as returned by <seealso marker = "#init-1">init/1</seealso></d>
+ <d>as returned by <seealso marker = "#init/1">init/1</seealso></d>
</type>
<desc>
<p>Makes an existing process an <c>ssh_client_channel</c> (replaces ssh_channel)
@@ -125,7 +125,7 @@
one of the start functions in <c>proc_lib</c>, see the <seealso
marker="stdlib:proc_lib">proc_lib(3)</seealso> manual page in STDLIB.
The user is responsible for any initialization of the process
- and must call <seealso marker = "#init-1">init/1</seealso>.
+ and must call <seealso marker = "#init/1">init/1</seealso>.
</p>
</desc>
</func>
@@ -152,7 +152,7 @@
<tag><c>{cm, </c><seealso marker="ssh:ssh#type-connection_ref">ssh:connection_ref()</seealso><c>}</c></tag>
<item><p>Reference to the <c>ssh</c> connection as returned by
- <seealso marker="ssh#connect-3">ssh:connect/3</seealso>.
+ <seealso marker="ssh#connect/3">ssh:connect/3</seealso>.
</p></item>
<tag><c>{channel_id, </c><seealso marker="ssh:ssh#type-channel_id">ssh:channel_id()</seealso><c>}</c></tag>
@@ -183,12 +183,12 @@
<p>This function can be used by a channel to send a
reply to a client that called <c>call/[2,3]</c> when the reply
cannot be defined in the return value of
- <seealso marker ="#Module:handle_call-3">Module:handle_call/3</seealso>.</p>
+ <seealso marker ="#Module:handle_call/3">Module:handle_call/3</seealso>.</p>
<p><c>Client</c> must be the <c>From</c> argument provided to
the callback function <c>handle_call/3</c>.
<c>Reply</c> is an arbitrary term,
which is given back to the client as the return value of
- <seealso marker="#call-2">call/[2,3].</seealso></p>
+ <seealso marker="#call/2">call/[2,3].</seealso></p>
</desc>
</func>
@@ -199,7 +199,7 @@
<fsummary>Starts a process that handles an SSH channel.</fsummary>
<type>
<v>SshConnection = <seealso marker="ssh:ssh#type-connection_ref">ssh:connection_ref()</seealso></v>
- <d>As returned by <seealso marker="ssh#connect-3">ssh:connect/3</seealso></d>
+ <d>As returned by <seealso marker="ssh#connect/3">ssh:connect/3</seealso></d>
<v>ChannelId = <seealso marker="ssh#type-channel_id">ssh:channel_id()</seealso></v>
<d>As returned by
@@ -237,7 +237,7 @@
<title>Callback timeouts</title>
<p>The timeout values that can be returned by the callback functions
have the same semantics as in a <seealso marker="stdlib:gen_server">gen_server</seealso>.
- If the time-out occurs, <seealso marker="#Module:handle_msg-2">handle_msg/2</seealso>
+ If the time-out occurs, <seealso marker="#Module:handle_msg/2">handle_msg/2</seealso>
is called as <c>handle_msg(timeout, State)</c>.</p>
</section>
</section>
@@ -314,19 +314,19 @@
<v>Msg = term()</v>
<v>From = opaque()</v>
<d>Is to be used as argument to
- <seealso marker="#reply-2">reply/2</seealso></d>
+ <seealso marker="#reply/2">reply/2</seealso></d>
<v>State = term()</v>
<v>Result = {reply, Reply, NewState} | {reply, Reply, NewState, timeout()}
| {noreply, NewState} | {noreply , NewState, timeout()}
| {stop, Reason, Reply, NewState} | {stop, Reason, NewState} </v>
<v>Reply = term()</v>
- <d>Will be the return value of <seealso marker="#call-2">call/[2,3]</seealso></d>
+ <d>Will be the return value of <seealso marker="#call/2">call/[2,3]</seealso></d>
<v>NewState = term()</v>
<v>Reason = term()</v>
</type>
<desc>
<p>Handles messages sent by calling
- <seealso marker="#call-2">call/[2,3]</seealso>
+ <seealso marker="#call/2">call/[2,3]</seealso>
</p>
<p>For more detailed information on time-outs,, see Section
<seealso marker="#cb_timeouts">Callback timeouts</seealso>.</p>
@@ -377,7 +377,7 @@
<tag><c>{ssh_channel_up, </c><seealso marker="ssh:ssh#type-channel_id">ssh:channel_id()</seealso><c>, </c><seealso marker="ssh:ssh#type-connection_ref">ssh:connection_ref()</seealso><c>}</c></tag>
<item><p>This is the first message that the channel receives.
It is sent just before the <seealso
- marker="#init-1">init/1</seealso> function
+ marker="#init/1">init/1</seealso> function
returns successfully. This is especially useful if the
server wants to send a message to the client without first
receiving a message from it. If the message is not
@@ -426,7 +426,7 @@
<desc>
<p>This function is called by a channel process when it is
about to terminate. Before this function is called, <seealso
- marker="ssh_connection#close-2"> ssh_connection:close/2
+ marker="ssh_connection#close/2"> ssh_connection:close/2
</seealso> is called, if it has not been called earlier.
This function does any necessary cleaning
up. When it returns, the channel process terminates with
diff --git a/lib/ssh/doc/src/ssh_client_key_api.xml b/lib/ssh/doc/src/ssh_client_key_api.xml
index a61d43a818..3f22286126 100644
--- a/lib/ssh/doc/src/ssh_client_key_api.xml
+++ b/lib/ssh/doc/src/ssh_client_key_api.xml
@@ -45,7 +45,7 @@
<datatype>
<name name="client_key_cb_options"/>
<desc>
- <p>Options provided to <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso>.
+ <p>Options provided to <seealso marker="ssh#connect/3">ssh:connect/[3,4]</seealso>.
</p>
<p>The option list given in the
<seealso marker="ssh#type-key_cb_common_option"><c>key_cb</c></seealso>
diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml
index 762cca1ded..032005e226 100644
--- a/lib/ssh/doc/src/ssh_connection.xml
+++ b/lib/ssh/doc/src/ssh_connection.xml
@@ -49,7 +49,7 @@
<p>
If the <seealso marker="ssh_client_channel">ssh_client_channel</seealso> behavior is used to
implement the channel process, these messages are handled by
- <seealso marker="ssh_client_channel#Module:handle_ssh_msg-2">handle_ssh_msg/2</seealso>.</p>
+ <seealso marker="ssh_client_channel#Module:handle_ssh_msg/2">handle_ssh_msg/2</seealso>.</p>
</description>
<datatypes>
@@ -57,7 +57,7 @@
<name name="ssh_data_type_code"/>
<desc>
<p>The valid values are <c>0</c> ("normal") and <c>1</c> ("stderr"), see
- <url href="https://tools.ietf.org/html/rfc4254#page-8">RFC 4254, Section 5.2</url>.</p>
+ <url href="https://tools.ietf.org/html/rfc4254#page/8">RFC 4254, Section 5.2</url>.</p>
</desc>
</datatype>
@@ -109,7 +109,7 @@
<name name="want_reply"/>
<desc>
<p>Messages that include a <c>WantReply</c> expect the channel handling
- process to call <seealso marker="ssh_connection#reply_request-4">
+ process to call <seealso marker="ssh_connection#reply_request/4">
ssh_connection:reply_request/4</seealso>
with the boolean value of <c>WantReply</c> as the second argument.</p>
</desc>
@@ -121,7 +121,7 @@
<name name="data_ch_msg"/>
<desc>
<p>Data has arrived on the channel. This event is sent as a result of calling
- <seealso marker="ssh_connection#send-3"> ssh_connection:send/[3,4,5]</seealso>.
+ <seealso marker="ssh_connection#send/3"> ssh_connection:send/[3,4,5]</seealso>.
</p>
</desc>
</datatype>
@@ -132,7 +132,7 @@
<name name="eof_ch_msg"/>
<desc>
<p>Indicates that the other side sends no more data. This event is sent as a result of calling
- <seealso marker="ssh_connection#send_eof-2"> ssh_connection:send_eof/2</seealso>.
+ <seealso marker="ssh_connection#send_eof/2"> ssh_connection:send_eof/2</seealso>.
</p>
</desc>
</datatype>
@@ -140,7 +140,7 @@
<name name="closed_ch_msg"/>
<desc>
<p>This event is sent as a result of calling
- <seealso marker="ssh_connection#close-2">ssh_connection:close/2</seealso>.
+ <seealso marker="ssh_connection#close/2">ssh_connection:close/2</seealso>.
Both the handling of this event and sending it are taken care of by the
<seealso marker="ssh_client_channel">ssh_client_channel</seealso> behavior.</p>
</desc>
@@ -160,7 +160,7 @@
drawable area of the window. <c>Opcode</c> in the
<c>TerminalModes</c> list is the mnemonic name, represented
as a lowercase Erlang atom, defined in
- <url href="https://tools.ietf.org/html/rfc4254#section-8">RFC 4254</url>, Section 8.
+ <url href="https://tools.ietf.org/html/rfc4254#section/8">RFC 4254</url>, Section 8.
It can also be an <c>Opcode</c> if the mnemonic name is not listed in the
RFC. Example: <c>OP code: 53, mnemonic name ECHO erlang atom:
echo</c>. This event is sent as a result of calling <seealso
@@ -175,7 +175,7 @@
<desc>
<p>Environment variables can be passed to the shell/command
to be started later. This event is sent as a result of calling <seealso
- marker="ssh_connection#setenv-5"> ssh_connection:setenv/5</seealso>.
+ marker="ssh_connection#setenv/5"> ssh_connection:setenv/5</seealso>.
</p>
</desc>
</datatype>
@@ -187,7 +187,7 @@
<desc>
<p>This message requests that the user default shell
is started at the other end. This event is sent as a result of calling
- <seealso marker="ssh_connection#shell-2"> ssh_connection:shell/2</seealso>.
+ <seealso marker="ssh_connection#shell/2"> ssh_connection:shell/2</seealso>.
</p>
</desc>
</datatype>
@@ -196,7 +196,7 @@
<desc>
<p>This message requests that the server starts
execution of the given command. This event is sent as a result of calling <seealso
- marker="ssh_connection#exec-4">ssh_connection:exec/4 </seealso>.
+ marker="ssh_connection#exec/4">ssh_connection:exec/4 </seealso>.
</p>
</desc>
</datatype>
@@ -234,7 +234,7 @@
following message can be sent to return the exit status of the
command. A zero <c>exit_status</c> usually means that the command
terminated successfully. This event is sent as a result of calling
- <seealso marker="ssh_connection#exit_status-3">
+ <seealso marker="ssh_connection#exit_status/3">
ssh_connection:exit_status/3</seealso>.</p>
</desc>
</datatype>
@@ -263,7 +263,7 @@
<note><p>Channels implemented with the <seealso marker="ssh_client_channel"> ssh_client_channel</seealso>
behavior do not normally need to call this function as flow control
is handled by the behavior. The behavior adjusts the window every time
- the callback <seealso marker="ssh_client_channel#Module:handle_ssh_msg-2">
+ the callback <seealso marker="ssh_client_channel#Module:handle_ssh_msg/2">
handle_ssh_msg/2</seealso> returns after processing channel data.</p></note>
</desc>
</func>
diff --git a/lib/ssh/doc/src/ssh_file.xml b/lib/ssh/doc/src/ssh_file.xml
index 6315bcbdbd..8ac0ba7ceb 100644
--- a/lib/ssh/doc/src/ssh_file.xml
+++ b/lib/ssh/doc/src/ssh_file.xml
@@ -48,9 +48,9 @@
<p>Such another callback module could be used by setting the option
<seealso marker="ssh:ssh#type-key_cb_common_option"><c>key_cb</c></seealso>
when starting a client or a server (with for example
- <seealso marker="ssh:ssh#connect-3">ssh:connect</seealso>,
- <seealso marker="ssh:ssh#daemon-2">ssh:daemon</seealso> of
- <seealso marker="ssh:ssh#shell-1">ssh:shell</seealso>
+ <seealso marker="ssh:ssh#connect/3">ssh:connect</seealso>,
+ <seealso marker="ssh:ssh#daemon/2">ssh:daemon</seealso> of
+ <seealso marker="ssh:ssh#shell/1">ssh:shell</seealso>
).
</p>
@@ -189,7 +189,7 @@
<desc>
<p><strong>Types and description</strong></p>
<p>See the api description in
- <seealso marker="ssh:ssh_server_key_api#Module:host_key-2">ssh_server_key_api, Module:host_key/2</seealso>.
+ <seealso marker="ssh:ssh_server_key_api#Module:host_key/2">ssh_server_key_api, Module:host_key/2</seealso>.
</p>
<p><strong>Options</strong></p>
<list>
@@ -215,7 +215,7 @@
<desc>
<p><strong>Types and description</strong></p>
<p>See the api description in
- <seealso marker="ssh:ssh_server_key_api#Module:is_auth_key-3">ssh_server_key_api: Module:is_auth_key/3</seealso>.
+ <seealso marker="ssh:ssh_server_key_api#Module:is_auth_key/3">ssh_server_key_api: Module:is_auth_key/3</seealso>.
</p>
<p><strong>Options</strong></p>
<list>
@@ -238,11 +238,11 @@
<desc>
<p><strong>Types and description</strong></p>
<p>See the api description in
- <seealso marker="ssh:ssh_client_key_api#Module:add_host_key-4">ssh_client_key_api, Module:add_host_key/4</seealso>.
+ <seealso marker="ssh:ssh_client_key_api#Module:add_host_key/4">ssh_client_key_api, Module:add_host_key/4</seealso>.
</p>
<marker id="add_host_key-3"/>
<p>Note that the alternative, the old
- <seealso marker="ssh:ssh_client_key_api#Module:add_host_key-3">Module:add_host_key/3</seealso>
+ <seealso marker="ssh:ssh_client_key_api#Module:add_host_key/3">Module:add_host_key/3</seealso>
is no longer supported by <c>ssh_file</c>.
</p>
<p><strong>Option</strong></p>
@@ -262,11 +262,11 @@
<desc>
<p><strong>Types and description</strong></p>
<p>See the api description in
- <seealso marker="ssh:ssh_client_key_api#Module:is_host_key-5">ssh_client_key_api, Module:is_host_key/5</seealso>.
+ <seealso marker="ssh:ssh_client_key_api#Module:is_host_key/5">ssh_client_key_api, Module:is_host_key/5</seealso>.
</p>
<marker id="is_host_key-4"/>
<p>Note that the alternative, the old
- <seealso marker="ssh:ssh_client_key_api#Module:is_host_key-4">Module:is_host_key/4</seealso>
+ <seealso marker="ssh:ssh_client_key_api#Module:is_host_key/4">Module:is_host_key/4</seealso>
is no longer supported by <c>ssh_file</c>.
</p>
<p><strong>Option</strong></p>
@@ -301,7 +301,7 @@ key :: % encoded key from eg ssh_host_*.pub
<desc>
<p><strong>Types and description</strong></p>
<p>See the api description in
- <seealso marker="ssh:ssh_client_key_api#Module:user_key-2">ssh_client_key_api, Module:user_key/2</seealso>.
+ <seealso marker="ssh:ssh_client_key_api#Module:user_key/2">ssh_client_key_api, Module:user_key/2</seealso>.
</p>
<p><strong>Options</strong></p>
<list>
diff --git a/lib/ssh/doc/src/ssh_protocol.xml b/lib/ssh/doc/src/ssh_protocol.xml
index 0d99a96997..05fb365770 100644
--- a/lib/ssh/doc/src/ssh_protocol.xml
+++ b/lib/ssh/doc/src/ssh_protocol.xml
@@ -57,8 +57,8 @@
this case the the plain text password will be encrypted before sent
over the network. There are several configuration options for
authentication handling available in
- <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso>
- and <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso>
+ <seealso marker="ssh#connect/3">ssh:connect/[3,4]</seealso>
+ and <seealso marker="ssh#daemon/2">ssh:daemon/[2,3]</seealso>
It is also possible to customize the public key handling
by implementing the behaviours <seealso
marker="ssh_client_key_api">ssh_client_key_api</seealso> and
@@ -113,7 +113,7 @@
to provide your own CLI (Command Line Interface) implementation.
</item>
<item><em>Exec</em> - one-time remote execution of commands. See <seealso
- marker="ssh_connection#exec-4">ssh_connection:exec/4</seealso></item>
+ marker="ssh_connection#exec/4">ssh_connection:exec/4</seealso></item>
</list>
</section>
diff --git a/lib/ssh/doc/src/ssh_server_channel.xml b/lib/ssh/doc/src/ssh_server_channel.xml
index 037c4acda3..da2949a57d 100644
--- a/lib/ssh/doc/src/ssh_server_channel.xml
+++ b/lib/ssh/doc/src/ssh_server_channel.xml
@@ -86,7 +86,7 @@
</p>
<p>The time-out values that can be returned
have the same semantics as in a <seealso marker="stdlib:gen_server">gen_server</seealso>.
- If the time-out occurs, <seealso marker="#Module:handle_msg-2">handle_msg/2</seealso>
+ If the time-out occurs, <seealso marker="#Module:handle_msg/2">handle_msg/2</seealso>
is called as <c>handle_msg(timeout, State)</c>.
</p>
</desc>
@@ -162,7 +162,7 @@
<desc>
<p>This function is called by a channel process when it is
about to terminate. Before this function is called, <seealso
- marker="ssh_connection#close-2"> ssh_connection:close/2
+ marker="ssh_connection#close/2"> ssh_connection:close/2
</seealso> is called, if it has not been called earlier.
This function does any necessary cleaning
up. When it returns, the channel process terminates with
diff --git a/lib/ssh/doc/src/ssh_server_key_api.xml b/lib/ssh/doc/src/ssh_server_key_api.xml
index 013a788a4a..c77b9809de 100644
--- a/lib/ssh/doc/src/ssh_server_key_api.xml
+++ b/lib/ssh/doc/src/ssh_server_key_api.xml
@@ -75,7 +75,7 @@
<datatype>
<name name="daemon_key_cb_options"/>
<desc>
- <p>Options provided to <seealso marker="ssh#daemon-2">ssh:daemon/2,3</seealso>.
+ <p>Options provided to <seealso marker="ssh#daemon/2">ssh:daemon/2,3</seealso>.
</p>
<p>The option list given in the
<seealso marker="ssh#type-key_cb_common_option"><c>key_cb</c></seealso>
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index 5c8eba6203..0a344a5977 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -144,8 +144,8 @@
<name name="apread" arity="4" since=""/>
<fsummary>Reads asynchronously from an open file.</fsummary>
<desc><p>The <c><![CDATA[apread/4]]></c> function reads from a specified position,
- combining the <seealso marker="#position-3"><c>position/3</c></seealso> and
- <seealso marker="#aread-3"><c>aread/3</c></seealso> functions.</p>
+ combining the <seealso marker="#position/3"><c>position/3</c></seealso> and
+ <seealso marker="#aread/3"><c>aread/3</c></seealso> functions.</p>
</desc>
</func>
@@ -153,8 +153,8 @@
<name name="apwrite" arity="4" since=""/>
<fsummary>Writes asynchronously to an open file.</fsummary>
<desc><p>The <c><![CDATA[apwrite/4]]></c> function writes to a specified position,
- combining the <seealso marker="#position-3"><c>position/3</c></seealso> and
- <seealso marker="#awrite-3"><c>awrite/3</c></seealso> functions.</p>
+ combining the <seealso marker="#position/3"><c>position/3</c></seealso> and
+ <seealso marker="#awrite/3"><c>awrite/3</c></seealso> functions.</p>
</desc>
</func>
@@ -276,10 +276,10 @@
<p>Opens a handle to a tar file on the server, associated with <c>ChannelPid</c>.
The handle can be used for remote tar creation and extraction. The actual writing
and reading is performed by calls to
- <seealso marker="stdlib:erl_tar#add-3">erl_tar:add/3,4</seealso> and
- <seealso marker="stdlib:erl_tar#extract-2">erl_tar:extract/2</seealso>.
+ <seealso marker="stdlib:erl_tar#add/3">erl_tar:add/3,4</seealso> and
+ <seealso marker="stdlib:erl_tar#extract/2">erl_tar:extract/2</seealso>.
Note: The
- <seealso marker="stdlib:erl_tar#init-3">erl_tar:init/3</seealso> function should not
+ <seealso marker="stdlib:erl_tar#init/3">erl_tar:init/3</seealso> function should not
be called, that one is called by this open_tar function.
</p>
<p>For code examples see Section
@@ -335,8 +335,8 @@
<name name="pread" arity="5" since=""/>
<fsummary>Reads from an open file.</fsummary>
<desc><p>The <c><![CDATA[pread/3,4]]></c> function reads from a specified position,
- combining the <seealso marker="#position-3"><c>position/3</c></seealso> and
- <seealso marker="#read-3"><c>read/3,4</c></seealso> functions.</p>
+ combining the <seealso marker="#position/3"><c>position/3</c></seealso> and
+ <seealso marker="#read/3"><c>read/3,4</c></seealso> functions.</p>
</desc>
</func>
@@ -345,8 +345,8 @@
<name name="pwrite" arity="5" since=""/>
<fsummary>Writes to an open file.</fsummary>
<desc><p>The <c><![CDATA[pwrite/3,4]]></c> function writes to a specified position,
- combining the <seealso marker="#position-3"><c>position/3</c></seealso> and
- <seealso marker="#write-3"><c>write/3,4</c></seealso> functions.</p>
+ combining the <seealso marker="#position/3"><c>position/3</c></seealso> and
+ <seealso marker="#write/3"><c>write/3,4</c></seealso> functions.</p>
</desc>
</func>
@@ -381,12 +381,12 @@
<desc>
<p>Returns a <c><![CDATA[file_info]]></c> record from the file system object specified by
<c><![CDATA[Name]]></c> or <c><![CDATA[Handle]]></c>. See
- <seealso marker="kernel:file#read_file_info-2">file:read_file_info/2</seealso>
+ <seealso marker="kernel:file#read_file_info/2">file:read_file_info/2</seealso>
for information about the record.
</p>
<p>
Depending on the underlying OS:es links might be followed and info on the final file, directory
- etc is returned. See <seealso marker="#read_link_info-2">read_link_info/2</seealso>
+ etc is returned. See <seealso marker="#read_link_info/2">read_link_info/2</seealso>
on how to get information on links instead.
</p>
</desc>
@@ -410,7 +410,7 @@
<p>Returns a <c><![CDATA[file_info]]></c> record from the symbolic
link specified by <c><![CDATA[Name]]></c> or <c><![CDATA[Handle]]></c>.
See
- <seealso marker="kernel:file#read_link_info-2">file:read_link_info/2</seealso>
+ <seealso marker="kernel:file#read_link_info/2">file:read_link_info/2</seealso>
for information about the record.
</p>
</desc>
@@ -494,7 +494,7 @@
<fsummary>Stops the SFTP client channel.</fsummary>
<desc>
<p>Stops an SFTP channel. Does not close the SSH connection.
- Use <seealso marker="ssh#close-1">ssh:close/1</seealso> to close it.</p>
+ Use <seealso marker="ssh#close/1">ssh:close/1</seealso> to close it.</p>
</desc>
</func>
@@ -527,7 +527,7 @@
<desc>
<p>Writes file information from a <c><![CDATA[file_info]]></c> record to the
file specified by <c><![CDATA[Name]]></c>. See
- <seealso marker="kernel:file#write_file_info-2">file:write_file_info/[2,3]</seealso>
+ <seealso marker="kernel:file#write_file_info/2">file:write_file_info/[2,3]</seealso>
for information about the record.
</p>
</desc>
diff --git a/lib/ssh/doc/src/using_ssh.xml b/lib/ssh/doc/src/using_ssh.xml
index 17468917fb..938d549ef8 100644
--- a/lib/ssh/doc/src/using_ssh.xml
+++ b/lib/ssh/doc/src/using_ssh.xml
@@ -35,7 +35,7 @@
<section>
<title>General Information</title>
<p>The following examples use the utility function
- <seealso marker="ssh#start-0"> ssh:start/0</seealso> to start
+ <seealso marker="ssh#start/0"> ssh:start/0</seealso> to start
all needed applications (<c>crypto</c>, <c>public_key</c>, and <c>ssh</c>).
All examples are run in an Erlang shell, or in a bash shell, using <em>openssh</em>
to illustrate how the <c>ssh</c> application can be used. The
@@ -173,7 +173,7 @@ ok
7></pre>
<p>See <seealso marker="ssh_connection#description">ssh_connection</seealso> and
- <seealso marker="ssh_connection#exec-4">ssh_connection:exec/4</seealso>
+ <seealso marker="ssh_connection#exec/4">ssh_connection:exec/4</seealso>
for finding documentation of the channel messages.</p>
<p>To collect the channel messages in a program, use <c>receive...end</c> instead of <c>flush/1</c>:</p>
@@ -198,7 +198,7 @@ ok
{ok,1}
8></pre>
- <p>To close the connection, call the function <seealso marker="ssh#close-1"><c>ssh:close(ConnectionRef)</c></seealso>.
+ <p>To close the connection, call the function <seealso marker="ssh#close/1"><c>ssh:close(ConnectionRef)</c></seealso>.
As an alternative, set the option
<seealso marker="ssh#type-max_idle_time_common_option"><c>{idle_time, 1}</c></seealso>
when opening the connection. This will cause the connection to be closed automaticaly when there are
@@ -260,7 +260,7 @@ ok
$bash></pre>
<p>And similar for reading from stdin. As an example we use
- <seealso marker="stdlib:io#read-1">io:read/1</seealso> which
+ <seealso marker="stdlib:io#read/1">io:read/1</seealso> which
displays the argument as a prompt on stdout, reads a term from stdin and returns it
in an ok-tuple:</p>
<pre>
@@ -314,7 +314,7 @@ ok
<p>There is often a need to configure some other exec evaluator to tailor the input language or
restrict the possible functions to call. There are two ways of doing this which will be shown with examples
- below. See <seealso marker="ssh#daemon-2">ssh:daemon/2,3</seealso> and
+ below. See <seealso marker="ssh#daemon/2">ssh:daemon/2,3</seealso> and
<seealso marker="ssh#type-exec_daemon_option">exec_daemon_option()</seealso>) for details.</p>
<p>Examples of the two ways to configure the exec evaluator:</p>
<list type="ordered">
View Lorry Controller Status