From b5daac6772be9dd52a60fa5a0c22ddd9a63d2e92 Mon Sep 17 00:00:00 2001 From: Daniel Evers Date: Wed, 11 Oct 2023 20:18:09 +0200 Subject: [PATCH] Issue #157: Added documentation Signed-off-by: Daniel Evers (daniel.evers@utimaco.com) Reviewed-by: Jakub Jelen --- doc/shell.dox | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/shell.dox b/doc/shell.dox index d770f27a..2cf400a5 100644 --- a/doc/shell.dox +++ b/doc/shell.dox @@ -65,8 +65,14 @@ to as a "pty", for "pseudo-teletype". The remote processes won't see the difference with a real text-oriented terminal. If needed, you request the pty with the function ssh_channel_request_pty(). -Then you define its dimensions (number of rows and columns) -with ssh_channel_change_pty_size(). +If you want define its dimensions (number of rows and columns), +call ssh_channel_request_pty_size() instead. It's also possible to change +the dimensions after creating the pty with ssh_channel_change_pty_size(). + +If you want to change the terminal modes used by the pty (e.g. to change +CRLF handling), use ssh_channel_request_pty_size_modes(). This function +accepts an additional "modes" buffer that is expected to contain encoded +terminal modes according to RFC 4254 section 8. Be your session interactive or not, the next step is to request a shell with ssh_channel_request_shell().