Improve the documentation in channel_request_exec().

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

View File

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