lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-11-02 10:53:16 +03:00
Code Activity
Files
31ec5a8b55cc90efb0bd1bb2be621e416f1444ef
libssh2/docs/libssh2_poll_channel_read.md
Viktor Szakats b889b39945 docs: convert man page sources to "curldown" format 
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
2025-10-09 04:05:38 +02:00

732 B
Raw Blame History

c, SPDX-License-Identifier, Title, Section, Source, See-also
c SPDX-License-Identifier Title Section Source See-also
Copyright (C) The libssh2 project and its contributors. BSD-3-Clause libssh2_poll_channel_read 3 libssh2
libssh2_poll(3)

NAME

libssh2_poll_channel_read - check if data is available

SYNOPSIS

#include <libssh2.h>

int
libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended);

DESCRIPTION

This function is deprecated. Do note use.

libssh2_poll_channel_read(3) checks to see if data is available in the channel's read buffer. No attempt is made with this method to see if packets are available to be processed. For full polling support, use libssh2_poll(3).

RETURN VALUE

Returns 1 when data is available and 0 otherwise.