Commit manual pages after running 'man-update' and add new manual pages.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_s_file.3
CommitLineData
74dab6c2
JR
1.rn '' }`
2''' $RCSfile$$Revision$$Date$
3'''
4''' $Log$
5'''
6.de Sh
984263bc
MD
7.br
8.if t .Sp
9.ne 5
10.PP
11\fB\\$1\fR
12.PP
13..
74dab6c2 14.de Sp
984263bc
MD
15.if t .sp .5v
16.if n .sp
17..
74dab6c2 18.de Ip
984263bc
MD
19.br
20.ie \\n(.$>=3 .ne \\$3
21.el .ne 3
22.IP "\\$1" \\$2
23..
74dab6c2 24.de Vb
984263bc
MD
25.ft CW
26.nf
27.ne \\$1
28..
74dab6c2 29.de Ve
984263bc
MD
30.ft R
31
32.fi
33..
74dab6c2
JR
34'''
35'''
36''' Set up \*(-- to give an unbreakable dash;
37''' string Tr holds user defined translation string.
38''' Bell System Logo is used as a dummy character.
39'''
984263bc 40.tr \(*W-|\(bv\*(Tr
984263bc 41.ie n \{\
74dab6c2
JR
42.ds -- \(*W-
43.ds PI pi
44.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
45.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
46.ds L" ""
47.ds R" ""
48''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of
49''' \*(L" and \*(R", except that they are used on ".xx" lines,
50''' such as .IP and .SH, which do another additional levels of
51''' double-quote interpretation
52.ds M" """
53.ds S" """
54.ds N" """""
55.ds T" """""
56.ds L' '
57.ds R' '
58.ds M' '
59.ds S' '
60.ds N' '
61.ds T' '
984263bc
MD
62'br\}
63.el\{\
74dab6c2
JR
64.ds -- \(em\|
65.tr \*(Tr
66.ds L" ``
67.ds R" ''
68.ds M" ``
69.ds S" ''
70.ds N" ``
71.ds T" ''
72.ds L' `
73.ds R' '
74.ds M' `
75.ds S' '
76.ds N' `
77.ds T' '
78.ds PI \(*p
984263bc 79'br\}
74dab6c2
JR
80.\" If the F register is turned on, we'll generate
81.\" index entries out stderr for the following things:
82.\" TH Title
83.\" SH Header
84.\" Sh Subsection
85.\" Ip Item
86.\" X<> Xref (embedded
87.\" Of course, you have to process the output yourself
88.\" in some meaninful fashion.
89.if \nF \{
90.de IX
91.tm Index:\\$1\t\\n%\t"\\$2"
984263bc 92..
74dab6c2
JR
93.nr % 0
94.rr F
984263bc 95.\}
74dab6c2
JR
96.TH BIO_s_file 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
97.UC
98.if n .hy 0
984263bc 99.if n .na
74dab6c2
JR
100.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
101.de CQ \" put $1 in typewriter font
102.ft CW
103'if n "\c
104'if t \\&\\$1\c
105'if n \\&\\$1\c
106'if n \&"
107\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
108'.ft R
109..
110.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
111. \" AM - accent mark definitions
984263bc 112.bd B 3
74dab6c2 113. \" fudge factors for nroff and troff
984263bc 114.if n \{\
74dab6c2
JR
115. ds #H 0
116. ds #V .8m
117. ds #F .3m
118. ds #[ \f1
119. ds #] \fP
984263bc
MD
120.\}
121.if t \{\
74dab6c2
JR
122. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
123. ds #V .6m
124. ds #F 0
125. ds #[ \&
126. ds #] \&
984263bc 127.\}
74dab6c2 128. \" simple accents for nroff and troff
984263bc 129.if n \{\
74dab6c2
JR
130. ds ' \&
131. ds ` \&
132. ds ^ \&
133. ds , \&
134. ds ~ ~
135. ds ? ?
136. ds ! !
137. ds /
138. ds q
984263bc
MD
139.\}
140.if t \{\
74dab6c2
JR
141. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
142. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
143. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
144. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
145. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
146. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
147. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
148. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
149. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
984263bc 150.\}
74dab6c2 151. \" troff and (daisy-wheel) nroff accents
984263bc
MD
152.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
153.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
74dab6c2
JR
154.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
155.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
156.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
157.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
984263bc
MD
158.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
159.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
160.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
161.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
162.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
163.ds ae a\h'-(\w'a'u*4/10)'e
164.ds Ae A\h'-(\w'A'u*4/10)'E
74dab6c2
JR
165.ds oe o\h'-(\w'o'u*4/10)'e
166.ds Oe O\h'-(\w'O'u*4/10)'E
167. \" corrections for vroff
984263bc
MD
168.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
169.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
74dab6c2 170. \" for low resolution devices (crt and lpr)
984263bc
MD
171.if \n(.H>23 .if \n(.V>19 \
172\{\
74dab6c2
JR
173. ds : e
174. ds 8 ss
175. ds v \h'-1'\o'\(aa\(ga'
176. ds _ \h'-1'^
177. ds . \h'-1'.
178. ds 3 3
179. ds o a
180. ds d- d\h'-1'\(ga
181. ds D- D\h'-1'\(hy
182. ds th \o'bp'
183. ds Th \o'LP'
184. ds ae ae
185. ds Ae AE
186. ds oe oe
187. ds Oe OE
984263bc
MD
188.\}
189.rm #[ #] #H #V #F C
984263bc
MD
190.SH "NAME"
191BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp,
192BIO_read_filename, BIO_write_filename, BIO_append_filename,
74dab6c2 193BIO_rw_filename \- FILE bio
984263bc 194.SH "SYNOPSIS"
74dab6c2 195.PP
984263bc
MD
196.Vb 1
197\& #include <openssl/bio.h>
198.Ve
199.Vb 3
200\& BIO_METHOD * BIO_s_file(void);
201\& BIO *BIO_new_file(const char *filename, const char *mode);
202\& BIO *BIO_new_fp(FILE *stream, int flags);
203.Ve
204.Vb 2
205\& BIO_set_fp(BIO *b,FILE *fp, int flags);
206\& BIO_get_fp(BIO *b,FILE **fpp);
207.Ve
208.Vb 4
209\& int BIO_read_filename(BIO *b, char *name)
210\& int BIO_write_filename(BIO *b, char *name)
211\& int BIO_append_filename(BIO *b, char *name)
212\& int BIO_rw_filename(BIO *b, char *name)
213.Ve
214.SH "DESCRIPTION"
74dab6c2
JR
215\fIBIO_s_file()\fR returns the BIO file method. As its name implies it
216is a wrapper round the stdio FILE structure and it is a
217source/sink BIO.
984263bc
MD
218.PP
219Calls to \fIBIO_read()\fR and \fIBIO_write()\fR read and write data to the
220underlying stream. \fIBIO_gets()\fR and \fIBIO_puts()\fR are supported on file BIOs.
221.PP
74dab6c2 222\fIBIO_flush()\fR on a file BIO calls the \fIfflush()\fR function on the wrapped
984263bc
MD
223stream.
224.PP
74dab6c2
JR
225\fIBIO_reset()\fR attempts to change the file pointer to the start of file
226using \fIfseek\fR\|(stream, 0, 0).
984263bc 227.PP
74dab6c2
JR
228\fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
229using \fIfseek\fR\|(stream, ofs, 0).
984263bc 230.PP
74dab6c2 231\fIBIO_eof()\fR calls \fIfeof()\fR.
984263bc 232.PP
74dab6c2 233Setting the BIO_CLOSE flag calls \fIfclose()\fR on the stream when the BIO
984263bc
MD
234is freed.
235.PP
74dab6c2
JR
236\fIBIO_new_file()\fR creates a new file BIO with mode \fBmode\fR the meaning
237of \fBmode\fR is the same as the stdio function \fIfopen()\fR. The BIO_CLOSE
238flag is set on the returned BIO.
984263bc 239.PP
74dab6c2
JR
240\fIBIO_new_fp()\fR creates a file BIO wrapping \fBstream\fR. Flags can be:
241BIO_CLOSE, BIO_NOCLOSE (the close flag) BIO_FP_TEXT (sets the underlying
984263bc
MD
242stream to text mode, default is binary: this only has any effect under
243Win32).
244.PP
74dab6c2 245\fIBIO_set_fp()\fR set the fp of a file BIO to \fBfp\fR. \fBflags\fR has the same
984263bc
MD
246meaning as in \fIBIO_new_fp()\fR, it is a macro.
247.PP
74dab6c2 248\fIBIO_get_fp()\fR retrieves the fp of a file BIO, it is a macro.
984263bc 249.PP
74dab6c2 250\fIBIO_seek()\fR is a macro that sets the position pointer to \fBoffset\fR bytes
984263bc
MD
251from the start of file.
252.PP
74dab6c2 253\fIBIO_tell()\fR returns the value of the position pointer.
984263bc 254.PP
74dab6c2
JR
255\fIBIO_read_filename()\fR, \fIBIO_write_filename()\fR, \fIBIO_append_filename()\fR and
256\fIBIO_rw_filename()\fR set the file BIO \fBb\fR to use file \fBname\fR for
984263bc
MD
257reading, writing, append or read write respectively.
258.SH "NOTES"
984263bc 259When wrapping stdout, stdin or stderr the underlying stream should not
74dab6c2 260normally be closed so the BIO_NOCLOSE flag should be set.
984263bc 261.PP
74dab6c2
JR
262Because the file BIO calls the underlying stdio functions any quirks
263in stdio behaviour will be mirrored by the corresponding BIO.
984263bc 264.SH "EXAMPLES"
74dab6c2 265File BIO \*(L"hello world":
984263bc
MD
266.PP
267.Vb 3
268\& BIO *bio_out;
269\& bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
270\& BIO_printf(bio_out, "Hello World\en");
271.Ve
272Alternative technique:
273.PP
274.Vb 5
275\& BIO *bio_out;
276\& bio_out = BIO_new(BIO_s_file());
277\& if(bio_out == NULL) /* Error ... */
278\& if(!BIO_set_fp(bio_out, stdout, BIO_NOCLOSE)) /* Error ... */
279\& BIO_printf(bio_out, "Hello World\en");
280.Ve
281Write to a file:
282.PP
283.Vb 5
284\& BIO *out;
285\& out = BIO_new_file("filename.txt", "w");
286\& if(!out) /* Error occurred */
287\& BIO_printf(out, "Hello World\en");
288\& BIO_free(out);
289.Ve
290Alternative technique:
291.PP
292.Vb 6
293\& BIO *out;
294\& out = BIO_new(BIO_s_file());
295\& if(out == NULL) /* Error ... */
296\& if(!BIO_write_filename(out, "filename.txt")) /* Error ... */
297\& BIO_printf(out, "Hello World\en");
298\& BIO_free(out);
299.Ve
300.SH "RETURN VALUES"
74dab6c2 301\fIBIO_s_file()\fR returns the file BIO method.
984263bc 302.PP
74dab6c2 303\fIBIO_new_file()\fR and \fIBIO_new_fp()\fR return a file BIO or NULL if an error
984263bc
MD
304occurred.
305.PP
74dab6c2 306\fIBIO_set_fp()\fR and \fIBIO_get_fp()\fR return 1 for success or 0 for failure
984263bc
MD
307(although the current implementation never return 0).
308.PP
74dab6c2 309\fIBIO_seek()\fR returns the same value as the underlying \fIfseek()\fR function:
984263bc
MD
3100 for success or \-1 for failure.
311.PP
74dab6c2 312\fIBIO_tell()\fR returns the current file position.
984263bc 313.PP
74dab6c2
JR
314\fIBIO_read_filename()\fR, \fIBIO_write_filename()\fR, \fIBIO_append_filename()\fR and
315\fIBIO_rw_filename()\fR return 1 for success or 0 for failure.
984263bc 316.SH "BUGS"
74dab6c2 317\fIBIO_reset()\fR and \fIBIO_seek()\fR are implemented using \fIfseek()\fR on the underlying
984263bc 318stream. The return value for \fIfseek()\fR is 0 for success or \-1 if an error
74dab6c2 319occurred this differs from other types of BIO which will typically return
984263bc
MD
3201 for success and a non positive value if an error occurred.
321.SH "SEE ALSO"
984263bc
MD
322BIO_seek(3), BIO_tell(3),
323BIO_reset(3), BIO_flush(3),
324BIO_read(3),
325BIO_write(3), BIO_puts(3),
326BIO_gets(3), BIO_printf(3),
327BIO_set_close(3), BIO_get_close(3)
74dab6c2
JR
328
329.rn }` ''
330.IX Title "BIO_s_file 3"
331.IX Name "BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp,
332BIO_read_filename, BIO_write_filename, BIO_append_filename,
333BIO_rw_filename - FILE bio"
334
335.IX Header "NAME"
336
337.IX Header "SYNOPSIS"
338
339.IX Header "DESCRIPTION"
340
341.IX Header "NOTES"
342
343.IX Header "EXAMPLES"
344
345.IX Header "RETURN VALUES"
346
347.IX Header "BUGS"
348
349.IX Header "SEE ALSO"
350