aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
author√Čric Bischoff <eric@bureau-cornavin.com>2010-09-07 09:54:42 +0200
committerAndreas Schneider <asn@cynapses.org>2010-09-07 09:54:42 +0200
commit398bc769cec5631bcb561d17b9c6900a5ec36b4a (patch)
treec0a3db7c11ed1f06856a4c34eefe39c56ad3b4b7 /doc
parent49f57a8d0dcf990169e2f591a937672f74ffa4a9 (diff)
downloadlibssh-398bc769cec5631bcb561d17b9c6900a5ec36b4a.tar.gz
libssh-398bc769cec5631bcb561d17b9c6900a5ec36b4a.tar.xz
libssh-398bc769cec5631bcb561d17b9c6900a5ec36b4a.zip
doc: More work on the tutorial.
Diffstat (limited to 'doc')
-rw-r--r--doc/command.dox (renamed from doc/commands.dox)10
-rw-r--r--doc/guided_tour.dox4
-rw-r--r--doc/introduction.dox2
3 files changed, 8 insertions, 8 deletions
diff --git a/doc/commands.dox b/doc/command.dox
index 86cf156b..91b74ddc 100644
--- a/doc/commands.dox
+++ b/doc/command.dox
@@ -1,9 +1,9 @@
/**
-@page commands Chapter 4: Passing remote commands
-@section remote_commands Passing remote commands
+@page command Chapter 4: Passing a remote command
+@section remote_command Passing a remote command
Previous chapter has shown how to open a full shell session, with an attached
-terminal or not. If you only need to execute commands on the remote end,
+terminal or not. If you only need to execute a command on the remote end,
you don't need all that complexity.
The method described here is suited for executing only one remote command.
@@ -13,9 +13,9 @@ a non-interactive remote shell, as explained in previous chapter.
@see shell
-@subsection exec_remote Executing remote commands
+@subsection exec_remote Executing a remote command
-The first steps for executing remote commands are identical to those
+The first steps for executing a remote command are identical to those
for opening remote shells. You first need a SSH channel, and then
a SSH session that uses this channel:
diff --git a/doc/guided_tour.dox b/doc/guided_tour.dox
index 5f7a1003..5f337246 100644
--- a/doc/guided_tour.dox
+++ b/doc/guided_tour.dox
@@ -356,7 +356,7 @@ int main()
At this point, the authenticity of both server and client is established.
Time has come to take advantage of the many possibilities offered by the SSH
-protocol: execute remote commands, open remote shells, transfer files,
+protocol: execute a remote command, open remote shells, transfer files,
forward ports, etc.
The example below shows how to execute a remote command:
@@ -416,7 +416,7 @@ int show_remote_processes(ssh_session session)
@endcode
@see @ref opening_shell
-@see @ref remote_commands
+@see @ref remote_command
@see @ref sftp_subsystem
@see @ref scp_subsystem
diff --git a/doc/introduction.dox b/doc/introduction.dox
index 4c51d140..20894821 100644
--- a/doc/introduction.dox
+++ b/doc/introduction.dox
@@ -35,7 +35,7 @@ Table of contents:
@subpage shell
-@subpage commands
+@subpage command
@subpage sftp