ssh2/docs/Makefile.am

# $Id: Makefile.am,v 1.37 2009/03/26 15:41:15 bagder Exp $

EXTRA_DIST = template.3

dist_man_MANS = \
	libssh2_agent_connect.3 \
	libssh2_agent_disconnect.3 \
	libssh2_agent_free.3 \
	libssh2_agent_get_identity.3 \
	libssh2_agent_init.3 \
	libssh2_agent_list_identities.3 \
	libssh2_agent_userauth.3 \
	libssh2_banner_set.3 \
	libssh2_base64_decode.3 \
	libssh2_channel_close.3 \
	libssh2_channel_direct_tcpip_ex.3 \
	libssh2_channel_eof.3 \
	libssh2_channel_flush_ex.3 \
	libssh2_channel_forward_accept.3 \
	libssh2_channel_forward_cancel.3 \
	libssh2_channel_forward_listen_ex.3 \
	libssh2_channel_free.3 \
	libssh2_channel_get_exit_status.3 \
	libssh2_channel_handle_extended_data.3 \
	libssh2_channel_handle_extended_data2.3 \
	libssh2_channel_open_ex.3 \
	libssh2_channel_process_startup.3 \
	libssh2_channel_read_ex.3 \
	libssh2_channel_receive_window_adjust.3 \
	libssh2_channel_receive_window_adjust2.3 \
	libssh2_channel_request_pty_ex.3 \
	libssh2_channel_request_pty_size_ex.3 \
	libssh2_channel_send_eof.3 \
	libssh2_channel_set_blocking.3 \
	libssh2_channel_setenv_ex.3 \
	libssh2_channel_wait_closed.3 \
	libssh2_channel_wait_eof.3 \
	libssh2_channel_window_read_ex.3 \
	libssh2_channel_window_write_ex.3 \
	libssh2_channel_write_ex.3 \
	libssh2_channel_x11_req_ex.3 \
	libssh2_free_host_entry.3 \
	libssh2_host_entry_match.3 \
	libssh2_hostkey_hash.3 \
	libssh2_knownhost_add.3 \
	libssh2_knownhost_check.3 \
	libssh2_knownhost_del.3 \
	libssh2_knownhost_get.3 \
	libssh2_knownhost_init.3 \
	libssh2_knownhost_free.3 \
	libssh2_knownhost_readfile.3 \
	libssh2_knownhost_readline.3 \
	libssh2_knownhost_writefile.3 \
	libssh2_knownhost_writeline.3 \
	libssh2_new_host_entry.3 \
	libssh2_poll.3 \
	libssh2_poll_channel_read.3 \
	libssh2_publickey_add_ex.3 \
	libssh2_publickey_init.3 \
	libssh2_publickey_list_fetch.3 \
	libssh2_publickey_list_free.3 \
	libssh2_publickey_remove_ex.3 \
	libssh2_publickey_shutdown.3 \
	libssh2_scp_recv.3 \
	libssh2_scp_send_ex.3 \
	libssh2_session_abstract.3 \
	libssh2_session_block_directions.3 \
	libssh2_session_callback_set.3 \
	libssh2_session_disconnect_ex.3 \
	libssh2_session_flag.3 \
	libssh2_session_free.3 \
	libssh2_session_get_blocking.3 \
	libssh2_session_hostkey.3 \
	libssh2_session_init_ex.3 \
	libssh2_session_last_errno.3 \
	libssh2_session_last_error.3 \
	libssh2_session_method_pref.3 \
	libssh2_session_methods.3 \
	libssh2_session_set_blocking.3 \
	libssh2_session_startup.3 \
	libssh2_sftp_close_handle.3 \
	libssh2_sftp_fstat_ex.3 \
	libssh2_sftp_init.3 \
	libssh2_sftp_last_error.3 \
	libssh2_sftp_mkdir_ex.3 \
	libssh2_sftp_open_ex.3 \
	libssh2_sftp_read.3 \
	libssh2_sftp_readdir_ex.3 \
	libssh2_sftp_rename_ex.3 \
	libssh2_sftp_rmdir_ex.3 \
	libssh2_sftp_seek.3 \
	libssh2_sftp_shutdown.3 \
	libssh2_sftp_stat_ex.3 \
	libssh2_sftp_symlink_ex.3 \
	libssh2_sftp_tell.3 \
	libssh2_sftp_tell64.3 \
	libssh2_sftp_unlink_ex.3 \
	libssh2_sftp_write.3 \
	libssh2_trace.3 \
	libssh2_trace_sethandler.3 \
	libssh2_userauth_authenticated.3 \
	libssh2_userauth_hostbased_fromfile_ex.3 \
	libssh2_userauth_keyboard_interactive_ex.3 \
	libssh2_userauth_list.3 \
	libssh2_userauth_password_ex.3 \
	libssh2_userauth_publickey_fromfile_ex.3 \
	libssh2_version.3
* Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed and introduced a transport.h header. * Fixed the blocking mode to only change behavior not the actual underlying socket mode so we now always work with non-blocking sockets. This also introduces a new rule of thumb in libssh2 code: we don't call the external function calls internally. We use the internal (non-blocking) ones! * libssh2_channel_receive_window_adjust2 was added and libssh2_channel_receive_window_adjust is now deprecated * Introduced "local" header files with prototypes etc for different parts instead of cramming everything into libssh2_priv.h. channel.h is the first. 2009-03-26 16:41:14 +01:00			`# $Id: Makefile.am,v 1.37 2009/03/26 15:41:15 bagder Exp $`
Include man pages in distro tarball and make install. Note that this is still (by far) an incomplete set of man pages. 2007-02-02 23:27:06 +01:00
			`EXTRA_DIST = template.3`

Add missing back-slash, so now they can actually be installed 2007-06-15 13:01:22 +02:00			`dist_man_MANS = \`
Add man pages for ssh-agent API. 2009-12-23 01:12:02 +01:00			`libssh2_agent_connect.3 \`
			`libssh2_agent_disconnect.3 \`
			`libssh2_agent_free.3 \`
			`libssh2_agent_get_identity.3 \`
			`libssh2_agent_init.3 \`
			`libssh2_agent_list_identities.3 \`
			`libssh2_agent_userauth.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_banner_set.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_base64_decode.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_channel_close.3 \`
Add libssh2_channel_direct_tcpip_ex.3 and libssh2_channel_eof.3 2007-06-13 19:22:15 +02:00			`libssh2_channel_direct_tcpip_ex.3 \`
			`libssh2_channel_eof.3 \`
Add libssh2_channel_flush_ex.3 and libssh2_channel_forward_cancel.3 2007-06-13 21:53:09 +02:00			`libssh2_channel_flush_ex.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_channel_forward_accept.3 \`
Add libssh2_channel_flush_ex.3 and libssh2_channel_forward_cancel.3 2007-06-13 21:53:09 +02:00			`libssh2_channel_forward_cancel.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_channel_forward_listen_ex.3 \`
Add libssh2_channel_free.3, libssh2_channel_handle_extended_data.3 and libssh2_channel_handle_extended_data2.3 2007-06-13 22:09:15 +02:00			`libssh2_channel_free.3 \`
Add libssh2_channel_get_exit_status() 2007-06-15 12:53:04 +02:00			`libssh2_channel_get_exit_status.3 \`
Add libssh2_channel_free.3, libssh2_channel_handle_extended_data.3 and libssh2_channel_handle_extended_data2.3 2007-06-13 22:09:15 +02:00			`libssh2_channel_handle_extended_data.3 \`
			`libssh2_channel_handle_extended_data2.3 \`
Add libssh2_channel_open_ex.3 and libssh2_channel_process_startup.3 2007-06-13 22:54:25 +02:00			`libssh2_channel_open_ex.3 \`
			`libssh2_channel_process_startup.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_channel_read_ex.3 \`
added three more public functions I found lacking man pages 2009-03-15 23:59:46 +01:00			`libssh2_channel_receive_window_adjust.3 \`
* Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed and introduced a transport.h header. * Fixed the blocking mode to only change behavior not the actual underlying socket mode so we now always work with non-blocking sockets. This also introduces a new rule of thumb in libssh2 code: we don't call the external function calls internally. We use the internal (non-blocking) ones! * libssh2_channel_receive_window_adjust2 was added and libssh2_channel_receive_window_adjust is now deprecated * Introduced "local" header files with prototypes etc for different parts instead of cramming everything into libssh2_priv.h. channel.h is the first. 2009-03-26 16:41:14 +01:00			`libssh2_channel_receive_window_adjust2.3 \`
Add libssh2_channel_request_pty_ex.3 and libssh2_channel_send_eof.3 2007-06-13 23:07:59 +02:00			`libssh2_channel_request_pty_ex.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_channel_request_pty_size_ex.3 \`
Add libssh2_channel_request_pty_ex.3 and libssh2_channel_send_eof.3 2007-06-13 23:07:59 +02:00			`libssh2_channel_send_eof.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_channel_set_blocking.3 \`
Add libssh2_channel_setenv_ex.3 and libssh2_channel_x11_req_ex.3 2007-06-13 23:30:15 +02:00			`libssh2_channel_setenv_ex.3 \`
added libssh2_channel_wait_closed man page 2007-11-29 11:02:58 +01:00			`libssh2_channel_wait_closed.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_channel_wait_eof.3 \`
added three more public functions I found lacking man pages 2009-03-15 23:59:46 +01:00			`libssh2_channel_window_read_ex.3 \`
			`libssh2_channel_window_write_ex.3 \`
wrote up a first libssh2_base64_decode man page, added a few missing man pages to the tarball 2008-12-23 14:23:45 +01:00			`libssh2_channel_write_ex.3 \`
Add libssh2_channel_setenv_ex.3 and libssh2_channel_x11_req_ex.3 2007-06-13 23:30:15 +02:00			`libssh2_channel_x11_req_ex.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_free_host_entry.3 \`
			`libssh2_host_entry_match.3 \`
Add libssh2_hostkey_hash.3, libssh2_scp_recv.3 and libssh2_scp_send_ex.3 2007-06-14 16:56:32 +02:00			`libssh2_hostkey_hash.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_knownhost_add.3 \`
			`libssh2_knownhost_check.3 \`
			`libssh2_knownhost_del.3 \`
			`libssh2_knownhost_get.3 \`
			`libssh2_knownhost_init.3 \`
added man page for libssh2_knownhost_free 2009-10-18 03:03:55 +02:00			`libssh2_knownhost_free.3 \`
After review/feedback/discussions on the mailing list. Rename two functions: s/libssh2_knownhost_parsefile/libssh2_knownhost_readfile s/libssh2_knownhost_dumpfile/libssh2_knownhost_writefile 2009-05-28 19:57:54 +02:00			`libssh2_knownhost_readfile.3 \`
Added man pages for the two newest members of the knownhosts API family: libssh2_knownhost_readline() and libssh2_knownhost_writeline() 2009-05-29 10:12:22 +02:00			`libssh2_knownhost_readline.3 \`
After review/feedback/discussions on the mailing list. Rename two functions: s/libssh2_knownhost_parsefile/libssh2_knownhost_readfile s/libssh2_knownhost_dumpfile/libssh2_knownhost_writefile 2009-05-28 19:57:54 +02:00			`libssh2_knownhost_writefile.3 \`
Added man pages for the two newest members of the knownhosts API family: libssh2_knownhost_readline() and libssh2_knownhost_writeline() 2009-05-29 10:12:22 +02:00			`libssh2_knownhost_writeline.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_new_host_entry.3 \`
			`libssh2_poll.3 \`
			`libssh2_poll_channel_read.3 \`
			`libssh2_publickey_add_ex.3 \`
			`libssh2_publickey_init.3 \`
			`libssh2_publickey_list_fetch.3 \`
			`libssh2_publickey_list_free.3 \`
			`libssh2_publickey_remove_ex.3 \`
			`libssh2_publickey_shutdown.3 \`
Add libssh2_hostkey_hash.3, libssh2_scp_recv.3 and libssh2_scp_send_ex.3 2007-06-14 16:56:32 +02:00			`libssh2_scp_recv.3 \`
			`libssh2_scp_send_ex.3 \`
Add libssh2_session_abstract.3, libssh2_session_callback_set.3, libssh2_session_method_pref.3 and libssh2_session_methods.3 2007-06-14 17:26:58 +02:00			`libssh2_session_abstract.3 \`
- Vlad Grachov brought the new function called libssh2_session_block_directions() which returns a bitmask for what directions the connection blocks. It is to be used applications that use non-blocking sockets and when a libssh2 function returns LIBSSH2_ERROR_EAGAIN this function can be used to figure out in which direction the socket would block and thus it can wait for the socket to again be ready for communication in that direction before it calls libssh2 again. 2008-11-24 14:31:00 +01:00			`libssh2_session_block_directions.3 \`
Add libssh2_session_abstract.3, libssh2_session_callback_set.3, libssh2_session_method_pref.3 and libssh2_session_methods.3 2007-06-14 17:26:58 +02:00			`libssh2_session_callback_set.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_session_disconnect_ex.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_session_flag.3 \`
			`libssh2_session_free.3 \`
			`libssh2_session_get_blocking.3 \`
New man page for libssh2_session_hostkey(3). We probably need to improve this to also return the type of the key. 2009-06-05 09:02:56 +02:00			`libssh2_session_hostkey.3 \`
two more renaming of man pages to the actual function name 2009-03-16 15:40:37 +01:00			`libssh2_session_init_ex.3 \`
Add libssh2_session_last_errno.3 and libssh2_session_last_error.3 2007-06-14 01:02:08 +02:00			`libssh2_session_last_errno.3 \`
			`libssh2_session_last_error.3 \`
Add libssh2_session_abstract.3, libssh2_session_callback_set.3, libssh2_session_method_pref.3 and libssh2_session_methods.3 2007-06-14 17:26:58 +02:00			`libssh2_session_method_pref.3 \`
			`libssh2_session_methods.3 \`
Update libssh2_channel_set_blocking.3 and add libssh2_session_set_blocking.3 2007-06-14 19:23:13 +02:00			`libssh2_session_set_blocking.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_session_startup.3 \`
Add libssh2_sftp_close_handle.3 and libssh2_sftp_fstat_ex.3 2007-06-14 17:45:03 +02:00			`libssh2_sftp_close_handle.3 \`
			`libssh2_sftp_fstat_ex.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_sftp_init.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_sftp_last_error.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_sftp_mkdir_ex.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_sftp_open_ex.3 \`
Add libssh2_banner_set.3 and libssh2_channel_close.3 2007-06-13 19:03:38 +02:00			`libssh2_sftp_read.3 \`
rename the man page to use the same name as the actual function 2009-03-16 15:28:37 +01:00			`libssh2_sftp_readdir_ex.3 \`
Add libssh2_sftp_last_error.3, libssh2_sftp_rename_ex.3, libssh2_sftp_rmdir_ex.3 and libssh2_sftp_seek.3 2007-06-14 18:08:43 +02:00			`libssh2_sftp_rename_ex.3 \`
			`libssh2_sftp_rmdir_ex.3 \`
Add libssh2_sftp_shutdown.3, libssh2_sftp_stat_ex.3, libssh2_sftp_symlink_ex.3 and libssh2_sftp_tell.3 2007-06-14 18:33:38 +02:00			`libssh2_sftp_seek.3 \`
			`libssh2_sftp_shutdown.3 \`
			`libssh2_sftp_stat_ex.3 \`
			`libssh2_sftp_symlink_ex.3 \`
Add libssh2_sftp_unlink_ex.3 and libssh2_sftp_write.3 2007-06-14 18:46:14 +02:00			`libssh2_sftp_tell.3 \`
wrote up a first libssh2_base64_decode man page, added a few missing man pages to the tarball 2008-12-23 14:23:45 +01:00			`libssh2_sftp_tell64.3 \`
Add libssh2_sftp_unlink_ex.3 and libssh2_sftp_write.3 2007-06-14 18:46:14 +02:00			`libssh2_sftp_unlink_ex.3 \`
Add libssh2_userauth_authenticated.3, libssh2_userauth_list.3, libssh2_userauth_password_ex.3 and libssh2_userauth_publickey_fromfile.3 2007-06-14 19:15:32 +02:00			`libssh2_sftp_write.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_trace.3 \`
Add libssh2_trace_sethandler() to the API (even more) 2010-01-15 22:58:44 +01:00			`libssh2_trace_sethandler.3 \`
Add libssh2_userauth_authenticated.3, libssh2_userauth_list.3, libssh2_userauth_password_ex.3 and libssh2_userauth_publickey_fromfile.3 2007-06-14 19:15:32 +02:00			`libssh2_userauth_authenticated.3 \`
Added the initial man pages for the 7 new functions for known host handling 2009-05-28 14:35:13 +02:00			`libssh2_userauth_hostbased_fromfile_ex.3 \`
Added manpage for libssh2_userauth_keyboard_interactive_ex(3) 2008-03-08 19:26:32 +01:00			`libssh2_userauth_keyboard_interactive_ex.3 \`
Add libssh2_userauth_authenticated.3, libssh2_userauth_list.3, libssh2_userauth_password_ex.3 and libssh2_userauth_publickey_fromfile.3 2007-06-14 19:15:32 +02:00			`libssh2_userauth_list.3 \`
			`libssh2_userauth_password_ex.3 \`
two more renaming of man pages to the actual function name 2009-03-16 15:40:37 +01:00			`libssh2_userauth_publickey_fromfile_ex.3 \`
- Added libssh2_version() 2009-02-23 17:22:46 +01:00			`libssh2_version.3`