1
0
mirror of https://github.com/nmap/nmap.git synced 2025-12-07 05:01:29 +00:00

Corrections to libssh2 NSEdoc

This commit is contained in:
dmiller
2025-06-10 20:46:03 +00:00
parent aae135fa91
commit 4f25581f1e

View File

@@ -74,7 +74,7 @@ function publickey_canauth(session, username, publickeydata)
-- @return libssh2 channel -- @return libssh2 channel
function open_channel(session, no_pty) function open_channel(session, no_pty)
--- Reads data from stdin on libssh2 channel. --- Reads data from stdout on libssh2 channel.
-- @param session Authenticated libssh2 session -- @param session Authenticated libssh2 session
-- @param channel Open libssh2 channel -- @param channel Open libssh2 channel
-- @return string containing data read from channel -- @return string containing data read from channel
@@ -86,18 +86,17 @@ function channel_read(session, channel)
-- @return string containing data read from channel -- @return string containing data read from channel
function channel_read_stderr(session, channel) function channel_read_stderr(session, channel)
--- Writes data to libssh2 channel. Not garenteed to write entire buffer. --- Writes data to libssh2 channel. Not guaranteed to write entire buffer.
-- @param session Authenticated libssh2 session -- @param session Authenticated libssh2 session
-- @param channel Open libssh2 channel -- @param channel Open libssh2 channel
-- @param buffer String containing data to be written -- @param buffer String containing data to be written
-- @return Number of bytes written to channel -- @return Number of bytes written to channel
function channel_write(session, channel, buffer) function channel_write(session, channel, buffer)
--- Executes command on libssh2 channel and returns output --- Executes command on libssh2 channel
-- @param session Authenticated libssh2 session -- @param session Authenticated libssh2 session
-- @param channel Open libssh2 channel -- @param channel Open libssh2 channel
-- @param cmd String containing command to execute -- @param cmd String containing command to execute
-- @return String containing output from command
function channel_exec(session, channel, cmd) function channel_exec(session, channel, cmd)
--- Sends EOF on libssh2 channel. Note that the server may continue to send data --- Sends EOF on libssh2 channel. Note that the server may continue to send data