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