lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-29 13:01:14 +03:00
Code Activity

sftp docs: show macro on macro page, only function on function page

Browse Source 
The individual man pages for macros now show the full convenience
macro as defined, and then the man page for the actual function
only shows the function.
This commit is contained in:
Daniel Stenberg
2010-06-14 20:02:55 +02:00
parent 2fd044fdf5
commit 897f8463d8
6 changed files with 26 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/libssh2_sftp_readlink.3
View File

@ -2,12 +2,14 @@
.\"
.TH libssh2_sftp_readlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
.SH NAME
libssh2_sftp_readlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP calls
libssh2_sftp_readlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP
.SH SYNOPSIS
.nf
#include <libssh2.h>
libssh2_sftp_readlink(arguments)
#define libssh2_sftp_readlink(sftp, path, target, maxlen) \\
libssh2_sftp_symlink_ex((sftp), (path), strlen(path), (target), (maxlen), \\
LIBSSH2_SFTP_READLINK)
.SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_sftp_symlink_ex(3)\fP.