Adapt comments in options to give parameters types
Этот коммит содержится в:
Aris Adamantiadis
родитель
3253ece2a2
Коммит
b129181809
@ -170,19 +170,19 @@ int ssh_options_set_algo(ssh_session session, int algo,
|
||||
/**
|
||||
* @brief This function can set all possible ssh options.
|
||||
*
|
||||
* @param session An allocated ssh option structure.
|
||||
* @param session An allocated SSH session structure.
|
||||
*
|
||||
* @param type The option type to set. This could be one of the
|
||||
* following:
|
||||
*
|
||||
* - SSH_OPTIONS_HOST:
|
||||
* The hostname or ip address to connect to (string).
|
||||
* The hostname or ip address to connect to (const char *).
|
||||
*
|
||||
* - SSH_OPTIONS_PORT:
|
||||
* The port to connect to (integer).
|
||||
* The port to connect to (unsigned int).
|
||||
*
|
||||
* - SSH_OPTIONS_PORT_STR:
|
||||
* The port to connect to (string).
|
||||
* The port to connect to (const char *).
|
||||
*
|
||||
* - SSH_OPTIONS_FD:
|
||||
* The file descriptor to use (socket_t).\n
|
||||
@ -193,16 +193,16 @@ int ssh_options_set_algo(ssh_session session, int algo,
|
||||
* the known_host mechanism.
|
||||
*
|
||||
* - SSH_OPTIONS_BINDADDR:
|
||||
* The address to bind the client to (string).
|
||||
* The address to bind the client to (const char *).
|
||||
*
|
||||
* - SSH_OPTIONS_USER:
|
||||
* The username for authentication (string).\n
|
||||
* The username for authentication (const char *).\n
|
||||
* \n
|
||||
* If the value is NULL, the username is set to the
|
||||
* default username.
|
||||
*
|
||||
* - SSH_OPTIONS_SSH_DIR:
|
||||
* Set the ssh directory (format string).\n
|
||||
* Set the ssh directory (const char *,format string).\n
|
||||
* \n
|
||||
* If the value is NULL, the directory is set to the
|
||||
* default ssh directory.\n
|
||||
@ -213,7 +213,7 @@ int ssh_options_set_algo(ssh_session session, int algo,
|
||||
* directory.
|
||||
*
|
||||
* - SSH_OPTIONS_KNOWNHOSTS:
|
||||
* Set the known hosts file name (format string).\n
|
||||
* Set the known hosts file name (const char *,format string).\n
|
||||
* \n
|
||||
* If the value is NULL, the directory is set to the
|
||||
* default known hosts file, normally
|
||||
@ -224,7 +224,7 @@ int ssh_options_set_algo(ssh_session session, int algo,
|
||||
* replaced by the user home directory.
|
||||
*
|
||||
* - SSH_OPTIONS_IDENTITY:
|
||||
* Set the identity file name (format string).\n
|
||||
* Set the identity file name (const char *,format string).\n
|
||||
* \n
|
||||
* By default identity, id_dsa and id_rsa are checked.\n
|
||||
* \n
|
||||
@ -233,22 +233,22 @@ int ssh_options_set_algo(ssh_session session, int algo,
|
||||
* user home directory.
|
||||
*
|
||||
* - SSH_OPTIONS_TIMEOUT:
|
||||
* Set a timeout for the connection in seconds (integer).
|
||||
* Set a timeout for the connection in seconds (long).
|
||||
*
|
||||
* - SSH_OPTIONS_TIMEOUT_USEC:
|
||||
* Set a timeout for the connection in micro seconds
|
||||
* (integer).
|
||||
* (long).
|
||||
*
|
||||
* - SSH_OPTIONS_SSH1:
|
||||
* Allow or deny the connection to SSH1 servers
|
||||
* (integer).
|
||||
* (int, 0 is false).
|
||||
*
|
||||
* - SSH_OPTIONS_SSH2:
|
||||
* Allow or deny the connection to SSH2 servers
|
||||
* (integer).
|
||||
* (int, 0 is false).
|
||||
*
|
||||
* - SSH_OPTIONS_LOG_VERBOSITY:
|
||||
* Set the session logging verbosity (integer).\n
|
||||
* Set the session logging verbosity (int).\n
|
||||
* \n
|
||||
* The verbosity of the messages. Every log smaller or
|
||||
* equal to verbosity will be shown.
|
||||
@ -259,7 +259,7 @@ int ssh_options_set_algo(ssh_session session, int algo,
|
||||
* - SSH_LOG_FUNCTIONS: Function entering and leaving
|
||||
*
|
||||
* - SSH_OPTIONS_LOG_VERBOSITY_STR:
|
||||
* Set the session logging verbosity (string).\n
|
||||
* Set the session logging verbosity (const char *).\n
|
||||
* \n
|
||||
* The verbosity of the messages. Every log smaller or
|
||||
* equal to verbosity will be shown.
|
||||
@ -303,28 +303,28 @@ int ssh_options_set_algo(ssh_session session, int algo,
|
||||
* status callback (generic pointer).
|
||||
*
|
||||
* - SSH_OPTIONS_CIPHERS_C_S:
|
||||
* Set the symmetric cipher client to server (string,
|
||||
* Set the symmetric cipher client to server (const char *,
|
||||
* comma-separated list).
|
||||
*
|
||||
* - SSH_OPTIONS_CIPHERS_S_C:
|
||||
* Set the symmetric cipher server to client (string,
|
||||
* Set the symmetric cipher server to client (const char *,
|
||||
* comma-separated list).
|
||||
*
|
||||
* - SSH_OPTIONS_COMPRESSION_C_S:
|
||||
* Set the compression to use for client to server
|
||||
* communication (string, "none" or "zlib").
|
||||
* communication (const char *, "none" or "zlib").
|
||||
*
|
||||
* - SSH_OPTIONS_COMPRESSION_S_C:
|
||||
* Set the compression to use for server to client
|
||||
* communication (string, "none" or "zlib").
|
||||
* communication (const char *, "none" or "zlib").
|
||||
*
|
||||
* - SSH_OPTIONS_STRICTHOSTKEYCHECK:
|
||||
* Set the parameter StrictHostKeyChecking to avoid
|
||||
* asking about a fingerprint (integer, 0 = false).
|
||||
* asking about a fingerprint (int, 0 = false).
|
||||
*
|
||||
* - SSH_OPTIONS_PROXYCOMMAND:
|
||||
* Set the command to be executed in order to connect to
|
||||
* server.
|
||||
* server (const char *).
|
||||
*
|
||||
* @param value The value to set. This is a generic pointer and the
|
||||
* datatype which is used should be set according to the
|
||||
|
||||
Загрузка…
x
Ссылка в новой задаче
Block a user