Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_s_file.3
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
8b0cefbb
JR
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 112. \" corrections for vroff
984263bc
MD
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "BIO_s_file 3"
aac4ff6f 132.TH BIO_s_file 3 "2008-09-06" "0.9.8h" "OpenSSL"
984263bc
MD
133.SH "NAME"
134BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp,
135BIO_read_filename, BIO_write_filename, BIO_append_filename,
74dab6c2 136BIO_rw_filename \- FILE bio
984263bc 137.SH "SYNOPSIS"
8b0cefbb 138.IX Header "SYNOPSIS"
984263bc
MD
139.Vb 1
140\& #include <openssl/bio.h>
aac4ff6f
PA
141.Ve
142.PP
143.Vb 3
984263bc
MD
144\& BIO_METHOD * BIO_s_file(void);
145\& BIO *BIO_new_file(const char *filename, const char *mode);
146\& BIO *BIO_new_fp(FILE *stream, int flags);
aac4ff6f
PA
147.Ve
148.PP
149.Vb 2
984263bc
MD
150\& BIO_set_fp(BIO *b,FILE *fp, int flags);
151\& BIO_get_fp(BIO *b,FILE **fpp);
aac4ff6f
PA
152.Ve
153.PP
154.Vb 4
984263bc
MD
155\& int BIO_read_filename(BIO *b, char *name)
156\& int BIO_write_filename(BIO *b, char *name)
157\& int BIO_append_filename(BIO *b, char *name)
158\& int BIO_rw_filename(BIO *b, char *name)
159.Ve
160.SH "DESCRIPTION"
8b0cefbb
JR
161.IX Header "DESCRIPTION"
162\&\fIBIO_s_file()\fR returns the \s-1BIO\s0 file method. As its name implies it
163is a wrapper round the stdio \s-1FILE\s0 structure and it is a
164source/sink \s-1BIO\s0.
984263bc
MD
165.PP
166Calls to \fIBIO_read()\fR and \fIBIO_write()\fR read and write data to the
167underlying stream. \fIBIO_gets()\fR and \fIBIO_puts()\fR are supported on file BIOs.
168.PP
8b0cefbb 169\&\fIBIO_flush()\fR on a file \s-1BIO\s0 calls the \fIfflush()\fR function on the wrapped
984263bc
MD
170stream.
171.PP
8b0cefbb
JR
172\&\fIBIO_reset()\fR attempts to change the file pointer to the start of file
173using fseek(stream, 0, 0).
984263bc 174.PP
8b0cefbb
JR
175\&\fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
176using fseek(stream, ofs, 0).
984263bc 177.PP
8b0cefbb 178\&\fIBIO_eof()\fR calls \fIfeof()\fR.
984263bc 179.PP
8b0cefbb 180Setting the \s-1BIO_CLOSE\s0 flag calls \fIfclose()\fR on the stream when the \s-1BIO\s0
984263bc
MD
181is freed.
182.PP
8b0cefbb
JR
183\&\fIBIO_new_file()\fR creates a new file \s-1BIO\s0 with mode \fBmode\fR the meaning
184of \fBmode\fR is the same as the stdio function \fIfopen()\fR. The \s-1BIO_CLOSE\s0
185flag is set on the returned \s-1BIO\s0.
984263bc 186.PP
8b0cefbb
JR
187\&\fIBIO_new_fp()\fR creates a file \s-1BIO\s0 wrapping \fBstream\fR. Flags can be:
188\&\s-1BIO_CLOSE\s0, \s-1BIO_NOCLOSE\s0 (the close flag) \s-1BIO_FP_TEXT\s0 (sets the underlying
984263bc
MD
189stream to text mode, default is binary: this only has any effect under
190Win32).
191.PP
8b0cefbb 192\&\fIBIO_set_fp()\fR set the fp of a file \s-1BIO\s0 to \fBfp\fR. \fBflags\fR has the same
984263bc
MD
193meaning as in \fIBIO_new_fp()\fR, it is a macro.
194.PP
8b0cefbb 195\&\fIBIO_get_fp()\fR retrieves the fp of a file \s-1BIO\s0, it is a macro.
984263bc 196.PP
8b0cefbb 197\&\fIBIO_seek()\fR is a macro that sets the position pointer to \fBoffset\fR bytes
984263bc
MD
198from the start of file.
199.PP
8b0cefbb 200\&\fIBIO_tell()\fR returns the value of the position pointer.
984263bc 201.PP
8b0cefbb
JR
202\&\fIBIO_read_filename()\fR, \fIBIO_write_filename()\fR, \fIBIO_append_filename()\fR and
203\&\fIBIO_rw_filename()\fR set the file \s-1BIO\s0 \fBb\fR to use file \fBname\fR for
984263bc
MD
204reading, writing, append or read write respectively.
205.SH "NOTES"
8b0cefbb 206.IX Header "NOTES"
984263bc 207When wrapping stdout, stdin or stderr the underlying stream should not
8b0cefbb 208normally be closed so the \s-1BIO_NOCLOSE\s0 flag should be set.
984263bc 209.PP
8b0cefbb
JR
210Because the file \s-1BIO\s0 calls the underlying stdio functions any quirks
211in stdio behaviour will be mirrored by the corresponding \s-1BIO\s0.
984263bc 212.SH "EXAMPLES"
8b0cefbb
JR
213.IX Header "EXAMPLES"
214File \s-1BIO\s0 \*(L"hello world\*(R":
984263bc
MD
215.PP
216.Vb 3
217\& BIO *bio_out;
218\& bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
219\& BIO_printf(bio_out, "Hello World\en");
220.Ve
8b0cefbb 221.PP
984263bc
MD
222Alternative technique:
223.PP
224.Vb 5
225\& BIO *bio_out;
226\& bio_out = BIO_new(BIO_s_file());
227\& if(bio_out == NULL) /* Error ... */
228\& if(!BIO_set_fp(bio_out, stdout, BIO_NOCLOSE)) /* Error ... */
229\& BIO_printf(bio_out, "Hello World\en");
230.Ve
8b0cefbb 231.PP
984263bc
MD
232Write to a file:
233.PP
234.Vb 5
235\& BIO *out;
236\& out = BIO_new_file("filename.txt", "w");
237\& if(!out) /* Error occurred */
238\& BIO_printf(out, "Hello World\en");
239\& BIO_free(out);
240.Ve
8b0cefbb 241.PP
984263bc
MD
242Alternative technique:
243.PP
244.Vb 6
245\& BIO *out;
246\& out = BIO_new(BIO_s_file());
247\& if(out == NULL) /* Error ... */
248\& if(!BIO_write_filename(out, "filename.txt")) /* Error ... */
249\& BIO_printf(out, "Hello World\en");
250\& BIO_free(out);
251.Ve
252.SH "RETURN VALUES"
8b0cefbb
JR
253.IX Header "RETURN VALUES"
254\&\fIBIO_s_file()\fR returns the file \s-1BIO\s0 method.
984263bc 255.PP
8b0cefbb 256\&\fIBIO_new_file()\fR and \fIBIO_new_fp()\fR return a file \s-1BIO\s0 or \s-1NULL\s0 if an error
984263bc
MD
257occurred.
258.PP
8b0cefbb 259\&\fIBIO_set_fp()\fR and \fIBIO_get_fp()\fR return 1 for success or 0 for failure
984263bc
MD
260(although the current implementation never return 0).
261.PP
8b0cefbb 262\&\fIBIO_seek()\fR returns the same value as the underlying \fIfseek()\fR function:
984263bc
MD
2630 for success or \-1 for failure.
264.PP
8b0cefbb 265\&\fIBIO_tell()\fR returns the current file position.
984263bc 266.PP
8b0cefbb
JR
267\&\fIBIO_read_filename()\fR, \fIBIO_write_filename()\fR, \fIBIO_append_filename()\fR and
268\&\fIBIO_rw_filename()\fR return 1 for success or 0 for failure.
984263bc 269.SH "BUGS"
8b0cefbb
JR
270.IX Header "BUGS"
271\&\fIBIO_reset()\fR and \fIBIO_seek()\fR are implemented using \fIfseek()\fR on the underlying
984263bc 272stream. The return value for \fIfseek()\fR is 0 for success or \-1 if an error
8b0cefbb 273occurred this differs from other types of \s-1BIO\s0 which will typically return
984263bc
MD
2741 for success and a non positive value if an error occurred.
275.SH "SEE ALSO"
74dab6c2 276.IX Header "SEE ALSO"
8b0cefbb
JR
277\&\fIBIO_seek\fR\|(3), \fIBIO_tell\fR\|(3),
278\&\fIBIO_reset\fR\|(3), \fIBIO_flush\fR\|(3),
279\&\fIBIO_read\fR\|(3),
280\&\fIBIO_write\fR\|(3), \fIBIO_puts\fR\|(3),
281\&\fIBIO_gets\fR\|(3), \fIBIO_printf\fR\|(3),
282\&\fIBIO_set_close\fR\|(3), \fIBIO_get_close\fR\|(3)