mirror of
				https://github.com/libssh2/libssh2.git
				synced 2025-10-30 12:05:34 +03:00 
			
		
		
		
	To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
  - autotools: `--disable-docs`
  - cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
  manually fixed copyrights, inline function references and a couple
  of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
		
	
		
			
				
	
	
		
			45 lines
		
	
	
		
			1.1 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			45 lines
		
	
	
		
			1.1 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
| ---
 | |
| c: Copyright (C) The libssh2 project and its contributors.
 | |
| SPDX-License-Identifier: BSD-3-Clause
 | |
| Title: libssh2_session_methods
 | |
| Section: 3
 | |
| Source: libssh2
 | |
| See-also:
 | |
|   - libssh2_session_init_ex(3)
 | |
| ---
 | |
| 
 | |
| # NAME
 | |
| 
 | |
| libssh2_session_methods - return the currently active algorithms
 | |
| 
 | |
| # SYNOPSIS
 | |
| 
 | |
| ~~~c
 | |
| #include <libssh2.h>
 | |
| 
 | |
| const char *
 | |
| libssh2_session_methods(LIBSSH2_SESSION *session, int method_type);
 | |
| ~~~
 | |
| 
 | |
| # DESCRIPTION
 | |
| 
 | |
| *session* - Session instance as returned by libssh2_session_init_ex(3)
 | |
| 
 | |
| *method_type* - one of the method type constants: LIBSSH2_METHOD_KEX,
 | |
| LIBSSH2_METHOD_HOSTKEY, LIBSSH2_METHOD_CRYPT_CS, LIBSSH2_METHOD_CRYPT_SC,
 | |
| LIBSSH2_METHOD_MAC_CS, LIBSSH2_METHOD_MAC_SC, LIBSSH2_METHOD_COMP_CS,
 | |
| LIBSSH2_METHOD_COMP_SC, LIBSSH2_METHOD_LANG_CS, LIBSSH2_METHOD_LANG_SC,
 | |
| LIBSSH2_METHOD_SIGN_ALGO.
 | |
| 
 | |
| Returns the actual method negotiated for a particular transport parameter.
 | |
| 
 | |
| # RETURN VALUE
 | |
| 
 | |
| Negotiated method or NULL if the session has not yet been started.
 | |
| 
 | |
| # ERRORS
 | |
| 
 | |
| *LIBSSH2_ERROR_INVAL* - The requested method type was invalid.
 | |
| 
 | |
| *LIBSSH2_ERROR_METHOD_NONE* - no method has been set
 |