wbrawner/openssl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openssl/doc/man3/BIO_s_fd.pod

99 lines
2.6 KiB
Text
Raw Normal View History

BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
=pod
=head1 NAME
BIO_seed() and BIO_tell() were documented in two other documents, which is redundant. They are now in their own document. Also, in the name section, all the functions described shoud be enumerated. This will also make it much simpler to generate softlinks name like each function to man-pages containing the info.
2000-09-14 20:24:56 +00:00
BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd - file descriptor BIO
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
=head1 SYNOPSIS
#include <openssl/bio.h>
Replace all #define's in pod pages. Function-like macros are replaced with prototypes and a note that they are implemented as macros. Constants are just referenced in-line in the text. Tweak BIO_TYPE_... documentation. Also fix RT4592. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-07-08 16:55:45 +00:00
const BIO_METHOD *BIO_s_fd(void);
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
Replace all #define's in pod pages. Function-like macros are replaced with prototypes and a note that they are implemented as macros. Constants are just referenced in-line in the text. Tweak BIO_TYPE_... documentation. Also fix RT4592. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-07-08 16:55:45 +00:00
int BIO_set_fd(BIO *b, int fd, int c);
int BIO_get_fd(BIO *b, int *c);
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
BIO *BIO_new_fd(int fd, int close_flag);
=head1 DESCRIPTION
Initial connect BIO docs.
2000-09-14 12:44:34 +00:00
BIO_s_fd() returns the file descriptor BIO method. This is a wrapper
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
round the platforms file descriptor routines such as read() and write().
Document the new BIO functions introduced as part of the size_t work Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-10-20 08:56:18 +00:00
BIO_read_ex() and BIO_write_ex() read or write the underlying descriptor.
Restore the descriptions to conform with the rest of the documentation. We'll work on better documents after the release of 0.9.6.
2000-09-17 19:20:17 +00:00
BIO_puts() is supported but BIO_gets() is not.
Correct another batch of typos Reviewed-by: Kurt Roeckx <kurt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-03-20 15:51:06 +00:00
If the close flag is set then close() is called on the underlying
Restore the descriptions to conform with the rest of the documentation. We'll work on better documents after the release of 0.9.6.
2000-09-17 19:20:17 +00:00
file descriptor when the BIO is freed.
BIO_reset() attempts to change the file pointer to the start of file
Replace all #define's in pod pages. Function-like macros are replaced with prototypes and a note that they are implemented as macros. Constants are just referenced in-line in the text. Tweak BIO_TYPE_... documentation. Also fix RT4592. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-07-08 16:55:45 +00:00
such as by using B<lseek(fd, 0, 0)>.
Restore the descriptions to conform with the rest of the documentation. We'll work on better documents after the release of 0.9.6.
2000-09-17 19:20:17 +00:00
BIO_seek() sets the file pointer to position B<ofs> from start of file
Replace all #define's in pod pages. Function-like macros are replaced with prototypes and a note that they are implemented as macros. Constants are just referenced in-line in the text. Tweak BIO_TYPE_... documentation. Also fix RT4592. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-07-08 16:55:45 +00:00
such as by using B<lseek(fd, ofs, 0)>.
Restore the descriptions to conform with the rest of the documentation. We'll work on better documents after the release of 0.9.6.
2000-09-17 19:20:17 +00:00
Replace all #define's in pod pages. Function-like macros are replaced with prototypes and a note that they are implemented as macros. Constants are just referenced in-line in the text. Tweak BIO_TYPE_... documentation. Also fix RT4592. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-07-08 16:55:45 +00:00
BIO_tell() returns the current file position such as by calling
B<lseek(fd, 0, 1)>.
Restore the descriptions to conform with the rest of the documentation. We'll work on better documents after the release of 0.9.6.
2000-09-17 19:20:17 +00:00
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
BIO_set_fd() sets the file descriptor of BIO B<b> to B<fd> and the close
flag to B<c>.
BIO_get_fd() places the file descriptor in B<c> if it is not NULL, it also
Replace all #define's in pod pages. Function-like macros are replaced with prototypes and a note that they are implemented as macros. Constants are just referenced in-line in the text. Tweak BIO_TYPE_... documentation. Also fix RT4592. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-07-08 16:55:45 +00:00
returns the file descriptor.
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
ispell and some other nit-picking
2000-09-16 15:39:28 +00:00
BIO_new_fd() returns a file descriptor BIO using B<fd> and B<close_flag>.
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
=head1 NOTES
Document the new BIO functions introduced as part of the size_t work Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-10-20 08:56:18 +00:00
The behaviour of BIO_read_ex() and BIO_write_ex() depends on the behavior of the
Fix nits in pod files. Add doc-nit-check to help find future issues. Make podchecker be almost clean. Remove trailing whitespace. Tab expansion Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-20 12:11:46 +00:00
platforms read() and write() calls on the descriptor. If the underlying
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
file descriptor is in a non blocking mode then the BIO will behave in the
Document the new BIO functions introduced as part of the size_t work Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-10-20 08:56:18 +00:00
manner described in the L<BIO_read_ex(3)> and L<BIO_should_retry(3)>
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
manual pages.
File descriptor BIOs should not be used for socket I/O. Use socket BIOs
instead.
Replace all #define's in pod pages. Function-like macros are replaced with prototypes and a note that they are implemented as macros. Constants are just referenced in-line in the text. Tweak BIO_TYPE_... documentation. Also fix RT4592. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-07-08 16:55:45 +00:00
BIO_set_fd() and BIO_get_fd() are implemented as macros.
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
=head1 RETURN VALUES
BIO_s_fd() returns the file descriptor BIO method.
BIO_set_fd() always returns 1.
BIO_get_fd() returns the file descriptor or -1 if the BIO has not
ispell and some other nit-picking
2000-09-16 15:39:28 +00:00
been initialized.
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
BIO_new_fd() returns the newly allocated BIO or NULL is an error
occurred.
=head1 EXAMPLE
This is a file descriptor BIO version of "Hello World":
BIO *out;
Fix some style issues... extra spacing and 80 cols Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1366)
2016-07-28 19:15:52 +00:00
BIO_s_fd() manual page.
2000-09-13 17:27:42 +00:00
out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
BIO_printf(out, "Hello World\n");
BIO_free(out);
=head1 SEE ALSO
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-17 19:21:33 +00:00
L<BIO_seek(3)>, L<BIO_tell(3)>,
Document the new BIO functions introduced as part of the size_t work Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-10-20 08:56:18 +00:00
L<BIO_reset(3)>, L<BIO_read_ex(3)>,
L<BIO_write_ex(3)>, L<BIO_puts(3)>,
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-17 19:21:33 +00:00
L<BIO_gets(3)>, L<BIO_printf(3)>,
L<BIO_set_close(3)>, L<BIO_get_close(3)>
Ensure =cut is last line in every file. Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 14:16:40 +00:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 15:44:05 +00:00
=head1 COPYRIGHT
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut
Reference in a new issue Copy permalink