openssl: Adjust manual pages for 1.0.1o.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_s_fd.3
CommitLineData
5a44c043 1.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
8b0cefbb 5.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
6.if t .sp .5v
7.if n .sp
8..
8b0cefbb 9.de Vb \" Begin verbatim text
984263bc
MD
10.ft CW
11.nf
12.ne \\$1
13..
8b0cefbb 14.de Ve \" End verbatim text
984263bc 15.ft R
984263bc
MD
16.fi
17..
8b0cefbb
JR
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
8b0cefbb 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 26.ie n \{\
8b0cefbb
JR
27. ds -- \(*W-
28. ds PI pi
29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31. ds L" ""
32. ds R" ""
33. ds C` ""
34. ds C' ""
984263bc
MD
35'br\}
36.el\{\
8b0cefbb
JR
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
5a44c043
SW
41. ds C`
42. ds C'
984263bc 43'br\}
8b0cefbb 44.\"
e257b235
PA
45.\" Escape single quotes in literal strings from groff's Unicode transform.
46.ie \n(.g .ds Aq \(aq
47.el .ds Aq '
48.\"
8b0cefbb 49.\" If the F register is turned on, we'll generate index entries on stderr for
01185282 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
8b0cefbb
JR
51.\" entries marked with X<> in POD. Of course, you'll have to process the
52.\" output yourself in some meaningful fashion.
5a44c043
SW
53.\"
54.\" Avoid warning from groff about undefined register 'F'.
55.de IX
984263bc 56..
5a44c043
SW
57.nr rF 0
58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{
60. if \nF \{
61. de IX
62. tm Index:\\$1\t\\n%\t"\\$2"
e257b235 63..
5a44c043
SW
64. if !\nF==2 \{
65. nr % 0
66. nr F 2
67. \}
68. \}
e257b235 69.\}
5a44c043 70.rr rF
aac4ff6f 71.\"
8b0cefbb
JR
72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73.\" Fear. Run. Save yourself. No user-serviceable parts.
74. \" fudge factors for nroff and troff
984263bc 75.if n \{\
8b0cefbb
JR
76. ds #H 0
77. ds #V .8m
78. ds #F .3m
79. ds #[ \f1
80. ds #] \fP
984263bc
MD
81.\}
82.if t \{\
8b0cefbb
JR
83. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84. ds #V .6m
85. ds #F 0
86. ds #[ \&
87. ds #] \&
984263bc 88.\}
8b0cefbb 89. \" simple accents for nroff and troff
984263bc 90.if n \{\
8b0cefbb
JR
91. ds ' \&
92. ds ` \&
93. ds ^ \&
94. ds , \&
95. ds ~ ~
96. ds /
984263bc
MD
97.\}
98.if t \{\
8b0cefbb
JR
99. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 105.\}
8b0cefbb 106. \" troff and (daisy-wheel) nroff accents
984263bc
MD
107.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114.ds ae a\h'-(\w'a'u*4/10)'e
115.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 116. \" corrections for vroff
984263bc
MD
117.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 119. \" for low resolution devices (crt and lpr)
984263bc
MD
120.if \n(.H>23 .if \n(.V>19 \
121\{\
8b0cefbb
JR
122. ds : e
123. ds 8 ss
124. ds o a
125. ds d- d\h'-1'\(ga
126. ds D- D\h'-1'\(hy
127. ds th \o'bp'
128. ds Th \o'LP'
129. ds ae ae
130. ds Ae AE
984263bc
MD
131.\}
132.rm #[ #] #H #V #F C
8b0cefbb
JR
133.\" ========================================================================
134.\"
135.IX Title "BIO_s_fd 3"
46af7d9a 136.TH BIO_s_fd 3 "2015-06-12" "1.0.1o" "OpenSSL"
e257b235
PA
137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
138.\" way too many mistakes in technical documents.
139.if n .ad l
140.nh
984263bc 141.SH "NAME"
74dab6c2 142BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd \- file descriptor BIO
984263bc 143.SH "SYNOPSIS"
8b0cefbb 144.IX Header "SYNOPSIS"
984263bc
MD
145.Vb 1
146\& #include <openssl/bio.h>
e257b235 147\&
984263bc 148\& BIO_METHOD * BIO_s_fd(void);
e257b235 149\&
984263bc
MD
150\& #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
151\& #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
e257b235 152\&
984263bc
MD
153\& BIO *BIO_new_fd(int fd, int close_flag);
154.Ve
155.SH "DESCRIPTION"
8b0cefbb
JR
156.IX Header "DESCRIPTION"
157\&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method. This is a wrapper
984263bc
MD
158round the platforms file descriptor routines such as \fIread()\fR and \fIwrite()\fR.
159.PP
8b0cefbb
JR
160\&\fIBIO_read()\fR and \fIBIO_write()\fR read or write the underlying descriptor.
161\&\fIBIO_puts()\fR is supported but \fIBIO_gets()\fR is not.
984263bc
MD
162.PP
163If the close flag is set then then \fIclose()\fR is called on the underlying
8b0cefbb 164file descriptor when the \s-1BIO\s0 is freed.
984263bc 165.PP
8b0cefbb
JR
166\&\fIBIO_reset()\fR attempts to change the file pointer to the start of file
167using lseek(fd, 0, 0).
984263bc 168.PP
8b0cefbb
JR
169\&\fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
170using lseek(fd, ofs, 0).
984263bc 171.PP
8b0cefbb 172\&\fIBIO_tell()\fR returns the current file position by calling lseek(fd, 0, 1).
984263bc 173.PP
5a44c043 174\&\fIBIO_set_fd()\fR sets the file descriptor of \s-1BIO \s0\fBb\fR to \fBfd\fR and the close
984263bc
MD
175flag to \fBc\fR.
176.PP
5a44c043 177\&\fIBIO_get_fd()\fR places the file descriptor in \fBc\fR if it is not \s-1NULL,\s0 it also
8b0cefbb 178returns the file descriptor. If \fBc\fR is not \s-1NULL\s0 it should be of type
984263bc
MD
179(int *).
180.PP
8b0cefbb 181\&\fIBIO_new_fd()\fR returns a file descriptor \s-1BIO\s0 using \fBfd\fR and \fBclose_flag\fR.
984263bc 182.SH "NOTES"
8b0cefbb 183.IX Header "NOTES"
984263bc
MD
184The behaviour of \fIBIO_read()\fR and \fIBIO_write()\fR depends on the behavior of the
185platforms \fIread()\fR and \fIwrite()\fR calls on the descriptor. If the underlying
8b0cefbb
JR
186file descriptor is in a non blocking mode then the \s-1BIO\s0 will behave in the
187manner described in the \fIBIO_read\fR\|(3) and \fIBIO_should_retry\fR\|(3)
984263bc
MD
188manual pages.
189.PP
190File descriptor BIOs should not be used for socket I/O. Use socket BIOs
191instead.
192.SH "RETURN VALUES"
8b0cefbb
JR
193.IX Header "RETURN VALUES"
194\&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method.
984263bc 195.PP
8b0cefbb
JR
196\&\fIBIO_reset()\fR returns zero for success and \-1 if an error occurred.
197\&\fIBIO_seek()\fR and \fIBIO_tell()\fR return the current file position or \-1
984263bc
MD
198is an error occurred. These values reflect the underlying \fIlseek()\fR
199behaviour.
200.PP
8b0cefbb 201\&\fIBIO_set_fd()\fR always returns 1.
984263bc 202.PP
8b0cefbb 203\&\fIBIO_get_fd()\fR returns the file descriptor or \-1 if the \s-1BIO\s0 has not
984263bc
MD
204been initialized.
205.PP
8b0cefbb 206\&\fIBIO_new_fd()\fR returns the newly allocated \s-1BIO\s0 or \s-1NULL\s0 is an error
984263bc
MD
207occurred.
208.SH "EXAMPLE"
8b0cefbb
JR
209.IX Header "EXAMPLE"
210This is a file descriptor \s-1BIO\s0 version of \*(L"Hello World\*(R":
984263bc
MD
211.PP
212.Vb 4
213\& BIO *out;
214\& out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
215\& BIO_printf(out, "Hello World\en");
216\& BIO_free(out);
217.Ve
218.SH "SEE ALSO"
74dab6c2 219.IX Header "SEE ALSO"
8b0cefbb
JR
220\&\fIBIO_seek\fR\|(3), \fIBIO_tell\fR\|(3),
221\&\fIBIO_reset\fR\|(3), \fIBIO_read\fR\|(3),
222\&\fIBIO_write\fR\|(3), \fIBIO_puts\fR\|(3),
223\&\fIBIO_gets\fR\|(3), \fIBIO_printf\fR\|(3),
224\&\fIBIO_set_close\fR\|(3), \fIBIO_get_close\fR\|(3)