openssl: Adjust manual pages for 1.0.1m.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_s_file.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
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-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
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' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
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"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
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
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
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'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
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
116 .    \" corrections for vroff
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'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
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
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "BIO_s_file 3"
136 .TH BIO_s_file 3 "2015-03-19" "1.0.1m" "OpenSSL"
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
141 .SH "NAME"
142 BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp,
143 BIO_read_filename, BIO_write_filename, BIO_append_filename,
144 BIO_rw_filename \- FILE bio
145 .SH "SYNOPSIS"
146 .IX Header "SYNOPSIS"
147 .Vb 1
148 \& #include <openssl/bio.h>
149 \&
150 \& BIO_METHOD *   BIO_s_file(void);
151 \& BIO *BIO_new_file(const char *filename, const char *mode);
152 \& BIO *BIO_new_fp(FILE *stream, int flags);
153 \&
154 \& BIO_set_fp(BIO *b,FILE *fp, int flags);
155 \& BIO_get_fp(BIO *b,FILE **fpp);
156 \&
157 \& int BIO_read_filename(BIO *b, char *name)
158 \& int BIO_write_filename(BIO *b, char *name)
159 \& int BIO_append_filename(BIO *b, char *name)
160 \& int BIO_rw_filename(BIO *b, char *name)
161 .Ve
162 .SH "DESCRIPTION"
163 .IX Header "DESCRIPTION"
164 \&\fIBIO_s_file()\fR returns the \s-1BIO\s0 file method. As its name implies it
165 is a wrapper round the stdio \s-1FILE\s0 structure and it is a
166 source/sink \s-1BIO.\s0
167 .PP
168 Calls to \fIBIO_read()\fR and \fIBIO_write()\fR read and write data to the
169 underlying stream. \fIBIO_gets()\fR and \fIBIO_puts()\fR are supported on file BIOs.
170 .PP
171 \&\fIBIO_flush()\fR on a file \s-1BIO\s0 calls the \fIfflush()\fR function on the wrapped
172 stream.
173 .PP
174 \&\fIBIO_reset()\fR attempts to change the file pointer to the start of file
175 using fseek(stream, 0, 0).
176 .PP
177 \&\fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
178 using fseek(stream, ofs, 0).
179 .PP
180 \&\fIBIO_eof()\fR calls \fIfeof()\fR.
181 .PP
182 Setting the \s-1BIO_CLOSE\s0 flag calls \fIfclose()\fR on the stream when the \s-1BIO\s0
183 is freed.
184 .PP
185 \&\fIBIO_new_file()\fR creates a new file \s-1BIO\s0 with mode \fBmode\fR the meaning
186 of \fBmode\fR is the same as the stdio function \fIfopen()\fR. The \s-1BIO_CLOSE\s0
187 flag is set on the returned \s-1BIO.\s0
188 .PP
189 \&\fIBIO_new_fp()\fR creates a file \s-1BIO\s0 wrapping \fBstream\fR. Flags can be:
190 \&\s-1BIO_CLOSE, BIO_NOCLOSE \s0(the close flag) \s-1BIO_FP_TEXT \s0(sets the underlying
191 stream to text mode, default is binary: this only has any effect under
192 Win32).
193 .PP
194 \&\fIBIO_set_fp()\fR set the fp of a file \s-1BIO\s0 to \fBfp\fR. \fBflags\fR has the same
195 meaning as in \fIBIO_new_fp()\fR, it is a macro.
196 .PP
197 \&\fIBIO_get_fp()\fR retrieves the fp of a file \s-1BIO,\s0 it is a macro.
198 .PP
199 \&\fIBIO_seek()\fR is a macro that sets the position pointer to \fBoffset\fR bytes
200 from the start of file.
201 .PP
202 \&\fIBIO_tell()\fR returns the value of the position pointer.
203 .PP
204 \&\fIBIO_read_filename()\fR, \fIBIO_write_filename()\fR, \fIBIO_append_filename()\fR and
205 \&\fIBIO_rw_filename()\fR set the file \s-1BIO \s0\fBb\fR to use file \fBname\fR for
206 reading, writing, append or read write respectively.
207 .SH "NOTES"
208 .IX Header "NOTES"
209 When wrapping stdout, stdin or stderr the underlying stream should not
210 normally be closed so the \s-1BIO_NOCLOSE\s0 flag should be set.
211 .PP
212 Because the file \s-1BIO\s0 calls the underlying stdio functions any quirks
213 in stdio behaviour will be mirrored by the corresponding \s-1BIO.\s0
214 .PP
215 On Windows BIO_new_files reserves for the filename argument to be
216 \&\s-1UTF\-8\s0 encoded. In other words if you have to make it work in multi\-
217 lingual environment, encode file names in \s-1UTF\-8.\s0
218 .SH "EXAMPLES"
219 .IX Header "EXAMPLES"
220 File \s-1BIO \s0\*(L"hello world\*(R":
221 .PP
222 .Vb 3
223 \& BIO *bio_out;
224 \& bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
225 \& BIO_printf(bio_out, "Hello World\en");
226 .Ve
227 .PP
228 Alternative technique:
229 .PP
230 .Vb 5
231 \& BIO *bio_out;
232 \& bio_out = BIO_new(BIO_s_file());
233 \& if(bio_out == NULL) /* Error ... */
234 \& if(!BIO_set_fp(bio_out, stdout, BIO_NOCLOSE)) /* Error ... */
235 \& BIO_printf(bio_out, "Hello World\en");
236 .Ve
237 .PP
238 Write to a file:
239 .PP
240 .Vb 5
241 \& BIO *out;
242 \& out = BIO_new_file("filename.txt", "w");
243 \& if(!out) /* Error occurred */
244 \& BIO_printf(out, "Hello World\en");
245 \& BIO_free(out);
246 .Ve
247 .PP
248 Alternative technique:
249 .PP
250 .Vb 6
251 \& BIO *out;
252 \& out = BIO_new(BIO_s_file());
253 \& if(out == NULL) /* Error ... */
254 \& if(!BIO_write_filename(out, "filename.txt")) /* Error ... */
255 \& BIO_printf(out, "Hello World\en");
256 \& BIO_free(out);
257 .Ve
258 .SH "RETURN VALUES"
259 .IX Header "RETURN VALUES"
260 \&\fIBIO_s_file()\fR returns the file \s-1BIO\s0 method.
261 .PP
262 \&\fIBIO_new_file()\fR and \fIBIO_new_fp()\fR return a file \s-1BIO\s0 or \s-1NULL\s0 if an error
263 occurred.
264 .PP
265 \&\fIBIO_set_fp()\fR and \fIBIO_get_fp()\fR return 1 for success or 0 for failure
266 (although the current implementation never return 0).
267 .PP
268 \&\fIBIO_seek()\fR returns the same value as the underlying \fIfseek()\fR function:
269 0 for success or \-1 for failure.
270 .PP
271 \&\fIBIO_tell()\fR returns the current file position.
272 .PP
273 \&\fIBIO_read_filename()\fR, \fIBIO_write_filename()\fR,  \fIBIO_append_filename()\fR and
274 \&\fIBIO_rw_filename()\fR return 1 for success or 0 for failure.
275 .SH "BUGS"
276 .IX Header "BUGS"
277 \&\fIBIO_reset()\fR and \fIBIO_seek()\fR are implemented using \fIfseek()\fR on the underlying
278 stream. The return value for \fIfseek()\fR is 0 for success or \-1 if an error
279 occurred this differs from other types of \s-1BIO\s0 which will typically return
280 1 for success and a non positive value if an error occurred.
281 .SH "SEE ALSO"
282 .IX Header "SEE ALSO"
283 \&\fIBIO_seek\fR\|(3), \fIBIO_tell\fR\|(3),
284 \&\fIBIO_reset\fR\|(3), \fIBIO_flush\fR\|(3),
285 \&\fIBIO_read\fR\|(3),
286 \&\fIBIO_write\fR\|(3), \fIBIO_puts\fR\|(3),
287 \&\fIBIO_gets\fR\|(3), \fIBIO_printf\fR\|(3),
288 \&\fIBIO_set_close\fR\|(3), \fIBIO_get_close\fR\|(3)