shinys000114/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2026-02-11 18:50:28 +09:00
Code Issues Packages Projects Releases Wiki Activity

Improve the documentation in channel_request_exec().

Browse Source 
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@699 7dcaeef0-15fb-0310-b436-a5af3365683c
This commit is contained in:
Andreas Schneider
2009-05-04 07:04:53 +00:00
parent f40ae74f51
commit dda7808851
1 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
libssh/channels.c
View File

@@ -1287,13 +1287,19 @@ error:
return rc; return rc;
} }
/** it's similar to sh -c "command" /**
* \brief run a shell command without an interactive shell * @brief Run a shell command without an interactive shell.
* \param channel channel *
* \param cmd command to execute (by ex. "ls ~/ -al | grep -i reports") * This is similar to 'sh -c command'.
* \return SSH_SUCCESS on success\n *
* SSH_ERROR on error * @param channel The channel to execute the command.
* \see channel_request_shell() *
* @param cmd The command to execute
* (e.g. "ls ~/ -al | grep -i reports").
*
* @return SSH_SUCCESS on success, SSH_ERROR on error.
*
* @see channel_request_shell()
*/ */
int channel_request_exec(CHANNEL *channel, const char *cmd) { int channel_request_exec(CHANNEL *channel, const char *cmd) {
BUFFER *buffer = NULL; BUFFER *buffer = NULL;