diff options
| -rw-r--r-- | doc/authentication.dox | 2 | ||||
| -rw-r--r-- | doc/command.dox | 2 | ||||
| -rw-r--r-- | doc/forwarding.dox | 2 | ||||
| -rw-r--r-- | doc/guided_tour.dox | 2 | ||||
| -rw-r--r-- | doc/introduction.dox | 20 | ||||
| -rw-r--r-- | doc/mainpage.dox | 2 | ||||
| -rw-r--r-- | doc/scp.dox | 2 | ||||
| -rw-r--r-- | doc/sftp.dox | 2 | ||||
| -rw-r--r-- | doc/shell.dox | 2 | ||||
| -rw-r--r-- | doc/tbd.dox | 2 | ||||
| -rw-r--r-- | doc/threading.dox | 2 |
11 files changed, 20 insertions, 20 deletions
diff --git a/doc/authentication.dox b/doc/authentication.dox index e98d5e79..aea60bc4 100644 --- a/doc/authentication.dox +++ b/doc/authentication.dox @@ -1,5 +1,5 @@ /** -@page authentication Chapter 2: A deeper insight on authentication +@page libssh_tutor_authentication Chapter 2: A deeper insight on authentication @section authentication_details A deeper insight on authentication In our guided tour, we merely mentioned that the user needed to authenticate. diff --git a/doc/command.dox b/doc/command.dox index 91b74ddc..92e256ab 100644 --- a/doc/command.dox +++ b/doc/command.dox @@ -1,5 +1,5 @@ /** -@page command Chapter 4: Passing a remote command +@page libssh_tutor_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 diff --git a/doc/forwarding.dox b/doc/forwarding.dox index 5acf1f1b..e0bfd225 100644 --- a/doc/forwarding.dox +++ b/doc/forwarding.dox @@ -1,5 +1,5 @@ /** -@page forwarding Chapter 7: Forwarding connections +@page libssh_tutor_forwarding Chapter 7: Forwarding connections @section forwarding_connections Forwarding connections Port forwarding comes in SSH protocol in two different flavours: diff --git a/doc/guided_tour.dox b/doc/guided_tour.dox index 5f337246..2fa906e0 100644 --- a/doc/guided_tour.dox +++ b/doc/guided_tour.dox @@ -1,5 +1,5 @@ /** -@page guided_tour Chapter 1: A typical SSH session +@page libssh_tutor_guided_tour Chapter 1: A typical SSH session @section ssh_session A typical SSH session A SSH session goes through the following steps: diff --git a/doc/introduction.dox b/doc/introduction.dox index 9aca63e1..cf35db62 100644 --- a/doc/introduction.dox +++ b/doc/introduction.dox @@ -1,5 +1,5 @@ /** -@page tutorial The Tutorial +@page libssh_tutorial The Tutorial @section introduction Introduction libssh is a C library that enables you to write a program that uses the @@ -29,22 +29,22 @@ little changes on versions like 0.4.2 and later. Table of contents: -@subpage guided_tour +@subpage libssh_tutor_guided_tour -@subpage authentication +@subpage libssh_tutor_authentication -@subpage shell +@subpage libssh_tutor_shell -@subpage command +@subpage libssh_tutor_command -@subpage sftp +@subpage libssh_tutor_sftp -@subpage scp +@subpage libssh_tutor_scp -@subpage forwarding +@subpage libssh_tutor_forwarding -@subpage threads +@subpage libssh_tutor_threads -@subpage tbd +@subpage libssh_tutor_todo */ diff --git a/doc/mainpage.dox b/doc/mainpage.dox index b48e9896..4da67c0e 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -7,7 +7,7 @@ documents the libssh C API and the C++ wrapper. @section main-tutorial Tutorial -You should start by reading @subpage tutorial, then reading the documentation of +You should start by reading @subpage libssh_tutorial, then reading the documentation of the interesting functions as you go. @section main-features Features diff --git a/doc/scp.dox b/doc/scp.dox index fdf589eb..e6fd5f1a 100644 --- a/doc/scp.dox +++ b/doc/scp.dox @@ -1,5 +1,5 @@ /** -@page scp Chapter 6: The SCP subsystem +@page libssh_tutor_scp Chapter 6: The SCP subsystem @section scp_subsystem The SCP subsystem The SCP subsystem has far less functionnality than the SFTP subsystem. diff --git a/doc/sftp.dox b/doc/sftp.dox index 7306be57..f70456ff 100644 --- a/doc/sftp.dox +++ b/doc/sftp.dox @@ -1,5 +1,5 @@ /** -@page sftp Chapter 5: The SFTP subsystem +@page libssh_tutor_sftp Chapter 5: The SFTP subsystem @section sftp_subsystem The SFTP subsystem SFTP stands for "Secure File Transfer Protocol". It enables you to safely diff --git a/doc/shell.dox b/doc/shell.dox index 9b7225a6..35fdfc82 100644 --- a/doc/shell.dox +++ b/doc/shell.dox @@ -1,5 +1,5 @@ /** -@page shell Chapter 3: Opening a remote shell +@page libssh_tutor_shell Chapter 3: Opening a remote shell @section opening_shell Opening a remote shell We already mentioned that a single SSH connection can be shared diff --git a/doc/tbd.dox b/doc/tbd.dox index e1ba046d..921337ed 100644 --- a/doc/tbd.dox +++ b/doc/tbd.dox @@ -1,5 +1,5 @@ /** -@page tbd To be done +@page libssh_tutor_todo To be done *** To be written *** diff --git a/doc/threading.dox b/doc/threading.dox index 4a45cfa4..a18a3fb6 100644 --- a/doc/threading.dox +++ b/doc/threading.dox @@ -1,5 +1,5 @@ /** -@page threads Chapter 8: Threads with libssh +@page libssh_tutor_threads Chapter 8: Threads with libssh @section threads_with_libssh How to use libssh with threads libssh may be used in multithreaded applications, but under several conditions : |