Debian Codegraph @

upstream/debian-unstable/man3/BIO_f_prefix.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "BIO_F_PREFIX 3SSL"
58 .TH BIO_F_PREFIX 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 BIO_f_prefix, BIO_set_prefix, BIO_set_indent, BIO_get_indent
65 \&\- prefix BIO filter
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/bio.h>
70 \&
71 \& const BIO_METHOD *BIO_f_prefix(void);
72 \& long BIO_set_prefix(BIO *b, const char *prefix);
73 \& long BIO_set_indent(BIO *b, long indent);
74 \& long BIO_get_indent(BIO *b);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 \&\fBBIO_f_cipher()\fR returns the prefix BIO method. This is a filter for
79 text output, where each line gets automatically prefixed and indented
80 according to user input.
81 .PP
82 The prefix and the indentation are combined. For each line of output
83 going through this filter, the prefix is output first, then the amount
84 of additional spaces indicated by the indentation, and then the line
85 itself.
86 .PP
87 By default, there is no prefix, and indentation is set to 0.
88 .PP
89 \&\fBBIO_set_prefix()\fR sets the prefix to be used for future lines of
90 text, using \fIprefix\fR. \fIprefix\fR may be NULL, signifying that there
91 should be no prefix. If \fIprefix\fR isn't NULL, this function makes a
92 copy of it.
93 .PP
94 \&\fBBIO_set_indent()\fR sets the indentation to be used for future lines of
95 text, using \fIindent\fR. Negative values are not allowed.
96 .PP
97 \&\fBBIO_get_indent()\fR gets the current indentation.
98 .SH NOTES
99 .IX Header "NOTES"
100 \&\fBBIO_set_prefix()\fR, \fBBIO_set_indent()\fR and \fBBIO_get_indent()\fR are
101 implemented as macros.
102 .SH "RETURN VALUES"
103 .IX Header "RETURN VALUES"
104 \&\fBBIO_f_prefix()\fR returns the prefix BIO method.
105 .PP
106 \&\fBBIO_set_prefix()\fR returns 1 if the prefix was correctly set, or <=0 on
107 failure.
108 .PP
109 \&\fBBIO_set_indent()\fR returns 1 if the prefix was correctly set, or <=0 on
110 failure.
111 .PP
112 \&\fBBIO_get_indent()\fR returns the current indentation, or a negative value for failure.
113 .SH "SEE ALSO"
114 .IX Header "SEE ALSO"
115 \&\fBbio\fR\|(7)
116 .SH HISTORY
117 .IX Header "HISTORY"
118 \&\fBBIO_get_indent()\fR, \fBBIO_set_indent()\fR, \fBBIO_set_prefix()\fR were added in OpenSSL 3.0.
119 .SH COPYRIGHT
120 .IX Header "COPYRIGHT"
121 Copyright 2019\-2025 The OpenSSL Project Authors. All Rights Reserved.
122 .PP
123 Licensed under the Apache License 2.0 (the "License"). You may not use
124 this file except in compliance with the License. You can obtain a copy
125 in the file LICENSE in the source distribution or at
126 <https://www.openssl.org/source/license.html>.