Commit manual pages after running 'man-update' and add new manual pages.
[dragonfly.git] / secure / lib / libcrypto / man / X509_NAME_print_ex.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 X509_NAME_print_ex 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"
191X509_NAME_print_ex, X509_NAME_print_ex_fp, X509_NAME_print,
192X509_NAME_oneline \- X509_NAME printing routines.
193.SH "SYNOPSIS"
74dab6c2 194.PP
984263bc
MD
195.Vb 1
196\& #include <openssl/x509.h>
197.Ve
198.Vb 4
199\& int X509_NAME_print_ex(BIO *out, X509_NAME *nm, int indent, unsigned long flags);
200\& int X509_NAME_print_ex_fp(FILE *fp, X509_NAME *nm, int indent, unsigned long flags);
201\& char * X509_NAME_oneline(X509_NAME *a,char *buf,int size);
202\& int X509_NAME_print(BIO *bp, X509_NAME *name, int obase);
203.Ve
204.SH "DESCRIPTION"
74dab6c2 205\fIX509_NAME_print_ex()\fR prints a human readable version of \fBnm\fR to BIO \fBout\fR. Each
984263bc
MD
206line (for multiline formats) is indented by \fBindent\fR spaces. The output format
207can be extensively customised by use of the \fBflags\fR parameter.
208.PP
74dab6c2
JR
209\fIX509_NAME_print_ex_fp()\fR is identical to \fIX509_NAME_print_ex()\fR except the output is
210written to FILE pointer \fBfp\fR.
984263bc 211.PP
74dab6c2
JR
212\fIX509_NAME_oneline()\fR prints an ASCII version of \fBa\fR to \fBbuf\fR. At most \fBsize\fR
213bytes will be written. If \fBbuf\fR is \fBNULL\fR then a buffer is dynamically allocated
984263bc
MD
214and returned, otherwise \fBbuf\fR is returned.
215.PP
74dab6c2 216\fIX509_NAME_print()\fR prints out \fBname\fR to \fBbp\fR indenting each line by \fBobase\fR
984263bc
MD
217characters. Multiple lines are used if the output (including indent) exceeds
21880 characters.
219.SH "NOTES"
984263bc
MD
220The functions \fIX509_NAME_oneline()\fR and \fIX509_NAME_print()\fR are legacy functions which
221produce a non standard output form, they don't handle multi character fields and
222have various quirks and inconsistencies. Their use is strongly discouraged in new
223applications.
224.PP
225Although there are a large number of possible flags for most purposes
74dab6c2 226\fBXN_FLAG_ONELINE\fR, \fBXN_FLAG_MULTILINE\fR or \fBXN_FLAG_RFC2253\fR will suffice.
984263bc 227As noted on the ASN1_STRING_print_ex(3) manual page
74dab6c2
JR
228for UTF8 terminals the \fBASN1_STRFLAGS_ESC_MSB\fR should be unset: so for example
229\fBXN_FLAG_ONELINE & ~ASN1_STRFLAGS_ESC_MSB\fR would be used.
984263bc
MD
230.PP
231The complete set of the flags supported by \fIX509_NAME_print_ex()\fR is listed below.
232.PP
233Several options can be ored together.
234.PP
74dab6c2
JR
235The options \fBXN_FLAG_SEP_COMMA_PLUS\fR, \fBXN_FLAG_SEP_CPLUS_SPC\fR,
236\fBXN_FLAG_SEP_SPLUS_SPC\fR and \fBXN_FLAG_SEP_MULTILINE\fR determine the field separators
984263bc 237to use. Two distinct separators are used between distinct RelativeDistinguishedName
74dab6c2 238components and separate values in the same RDN for a multi-valued RDN. Multi-valued
984263bc
MD
239RDNs are currently very rare so the second separator will hardly ever be used.
240.PP
74dab6c2 241\fBXN_FLAG_SEP_COMMA_PLUS\fR uses comma and plus as separators. \fBXN_FLAG_SEP_CPLUS_SPC\fR
984263bc 242uses comma and plus with spaces: this is more readable that plain comma and plus.
74dab6c2 243\fBXN_FLAG_SEP_SPLUS_SPC\fR uses spaced semicolon and plus. \fBXN_FLAG_SEP_MULTILINE\fR uses
984263bc
MD
244spaced newline and plus respectively.
245.PP
74dab6c2 246If \fBXN_FLAG_DN_REV\fR is set the whole DN is printed in reversed order.
984263bc 247.PP
74dab6c2
JR
248The fields \fBXN_FLAG_FN_SN\fR, \fBXN_FLAG_FN_LN\fR, \fBXN_FLAG_FN_OID\fR,
249\fBXN_FLAG_FN_NONE\fR determine how a field name is displayed. It will
250use the short name (e.g. CN) the long name (e.g. commonName) always
251use OID numerical form (normally OIDs are only used if the field name is not
984263bc
MD
252recognised) and no field name respectively.
253.PP
74dab6c2 254If \fBXN_FLAG_SPC_EQ\fR is set then spaces will be placed around the \*(L'=\*(R' character
984263bc
MD
255separating field names and values.
256.PP
74dab6c2 257If \fBXN_FLAG_DUMP_UNKNOWN_FIELDS\fR is set then the encoding of unknown fields is
984263bc
MD
258printed instead of the values.
259.PP
74dab6c2 260If \fBXN_FLAG_FN_ALIGN\fR is set then field names are padded to 20 characters: this
984263bc
MD
261is only of use for multiline format.
262.PP
263Additionally all the options supported by \fIASN1_STRING_print_ex()\fR can be used to
264control how each field value is displayed.
265.PP
266In addition a number options can be set for commonly used formats.
267.PP
74dab6c2 268\fBXN_FLAG_RFC2253\fR sets options which produce an output compatible with RFC2253 it
984263bc 269is equivalent to:
74dab6c2 270 \fBASN1_STRFLGS_RFC2253 | XN_FLAG_SEP_COMMA_PLUS | XN_FLAG_DN_REV | XN_FLAG_FN_SN | XN_FLAG_DUMP_UNKNOWN_FIELDS\fR
984263bc 271.PP
74dab6c2
JR
272\fBXN_FLAG_ONELINE\fR is a more readable one line format it is the same as:
273 \fBASN1_STRFLGS_RFC2253 | ASN1_STRFLGS_ESC_QUOTE | XN_FLAG_SEP_CPLUS_SPC | XN_FLAG_SPC_EQ | XN_FLAG_FN_SN\fR
984263bc 274.PP
74dab6c2
JR
275\fBXN_FLAG_MULTILINE\fR is a multiline format is is the same as:
276 \fBASN1_STRFLGS_ESC_CTRL | ASN1_STRFLGS_ESC_MSB | XN_FLAG_SEP_MULTILINE | XN_FLAG_SPC_EQ | XN_FLAG_FN_LN | XN_FLAG_FN_ALIGN\fR
984263bc 277.PP
74dab6c2 278\fBXN_FLAG_COMPAT\fR uses a format identical to \fIX509_NAME_print()\fR: in fact it calls \fIX509_NAME_print()\fR internally.
984263bc 279.SH "SEE ALSO"
984263bc
MD
280ASN1_STRING_print_ex(3)
281.SH "HISTORY"
74dab6c2
JR
282TBA
283
284.rn }` ''
285.IX Title "X509_NAME_print_ex 3"
286.IX Name "X509_NAME_print_ex, X509_NAME_print_ex_fp, X509_NAME_print,
287X509_NAME_oneline - X509_NAME printing routines."
288
289.IX Header "NAME"
290
291.IX Header "SYNOPSIS"
292
293.IX Header "DESCRIPTION"
294
295.IX Header "NOTES"
296
297.IX Header "SEE ALSO"
298
984263bc 299.IX Header "HISTORY"
74dab6c2 300