diff options
author | Andreas Schneider <mail@cynapses.org> | 2009-05-04 07:04:53 +0000 |
---|---|---|
committer | Andreas Schneider <mail@cynapses.org> | 2009-05-04 07:04:53 +0000 |
commit | dda7808851079f75042fd73850adb336eb53c8e8 (patch) | |
tree | aea85c381ed76d112b7e378895aac3e472a2aa38 | |
parent | f40ae74f51c7f508904ec5dad48b7ea4c9cf06f6 (diff) | |
download | libssh-dda7808851079f75042fd73850adb336eb53c8e8.tar.gz libssh-dda7808851079f75042fd73850adb336eb53c8e8.tar.xz libssh-dda7808851079f75042fd73850adb336eb53c8e8.zip |
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
-rw-r--r-- | libssh/channels.c | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/libssh/channels.c b/libssh/channels.c index 267122c..5949f78 100644 --- a/libssh/channels.c +++ b/libssh/channels.c @@ -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; |