Complete rewrite to improve clarity.

Add some cross references and STANDARDS.

1 files changed, 49 insertions, 61 deletions

diff --git a/src/lib/libcrypto/man/d2i_X509_NAME.3 b/src/lib/libcrypto/man/d2i_X509_NAME.3
index 2817a7f3ce..1f1836abaf 100644
--- a/src/lib/libcrypto/man/d2i_X509_NAME.3
+++ b/src/lib/libcrypto/man/d2i_X509_NAME.3
@@ -1,83 +1,71 @@
-.\"     $OpenBSD: d2i_X509_NAME.3,v 1.4 2016/12/08 20:22:08 jmc Exp $
+.\"     $OpenBSD: d2i_X509_NAME.3,v 1.5 2016/12/14 16:18:31 schwarze Exp $
 .\"     OpenSSL d900a015 Oct 8 14:40:42 2015 +0200
 .\"
-.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
-.\" Copyright (c) 2002, 2015 The OpenSSL Project.  All rights reserved.
+.\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
 .\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
 .\"
-.\" 1. Redistributions of source code must retain the above copyright
-.\"    notice, this list of conditions and the following disclaimer.
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\"    notice, this list of conditions and the following disclaimer in
-.\"    the documentation and/or other materials provided with the
-.\"    distribution.
-.\"
-.\" 3. All advertising materials mentioning features or use of this
-.\"    software must display the following acknowledgment:
-.\"    "This product includes software developed by the OpenSSL Project
-.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
-.\"
-.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
-.\"    endorse or promote products derived from this software without
-.\"    prior written permission. For written permission, please contact
-.\"    openssl-core@openssl.org.
-.\"
-.\" 5. Products derived from this software may not be called "OpenSSL"
-.\"    nor may "OpenSSL" appear in their names without prior written
-.\"    permission of the OpenSSL Project.
-.\"
-.\" 6. Redistributions of any form whatsoever must retain the following
-.\"    acknowledgment:
-.\"    "This product includes software developed by the OpenSSL Project
-.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
-.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
-.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
-.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-.\" OF THE POSSIBILITY OF SUCH DAMAGE.
-.\"
-.Dd $Mdocdate: December 8 2016 $
+.Dd $Mdocdate: December 14 2016 $
 .Dt D2I_X509_NAME 3
 .Os
 .Sh NAME
 .Nm d2i_X509_NAME ,
 .Nm i2d_X509_NAME
-.Nd X509_NAME encoding functions
+.\" In the following line, "X.501" and "Name" are not typos.
+.\" The "Name" type is defined in X.501, not in X.509.
+.\" The type in called "Name" with capital "N", not "name".
+.Nd decode and encode X.501 Name objects
 .Sh SYNOPSIS
 .In openssl/x509.h
 .Ft X509_NAME *
 .Fo d2i_X509_NAME
-.Fa "X509_NAME **a"
-.Fa "unsigned char **pp"
+.Fa "X509_NAME **name"
+.Fa "unsigned char **in"
 .Fa "long length"
 .Fc
 .Ft int
 .Fo i2d_X509_NAME
-.Fa "X509_NAME *a"
-.Fa "unsigned char **pp"
+.Fa "X509_NAME *name"
+.Fa "unsigned char **out"
 .Fc
 .Sh DESCRIPTION
-These functions decode and encode an
+.Fn d2i_X509_NAME
+decodes
+.Fa length
+bytes of the DER-encoded string
+.Pf * Fa in
+and stores the resulting Name object in
+.Pf * Fa name .
+.Pp
+.Fn i2d_X509_NAME
+encodes
+.Fa name
+into DER format and stores the result to
+.Pf * Fa out .
+.Pp
+For details of the behaviour, see
+.Xr d2i_X509 3 .
+.Pp
+Regarding
 .Vt X509_NAME
-structure, which is the same as the
-.Sy Name
-type defined in RFC 2459 (and elsewhere) and used, for example, in
-certificate subject and issuer names.
-They otherwise behave in a way similar to
-.Xr d2i_X509 3
-and
-.Xr i2d_X509 3 .
+objects, see
+.Xr X509_NAME_new 3 .
 .Sh SEE ALSO
-.Xr d2i_X509 3
+.Xr d2i_X509 3 ,
+.Xr X509_NAME_new 3 ,
+.Xr X509_NAME_print_ex 3
+.Sh STANDARDS
+ITU-T Recommendation X.690, also known as ISO/IEC 8825-1:
+Information technology - ASN.1 encoding rules:
+Specification of Basic Encoding Rules (BER), Canonical Encoding
+Rules (CER) and Distinguished Encoding Rules (DER).