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