Fix some doc nits
[oweals/openssl.git] / doc / crypto / BIO_parse_hostserv.pod
index 56b71446837bc416c502ec2c161492a91a172016..426e4de999a60530f3badabd2821181a855e4fd9 100644 (file)
@@ -2,8 +2,9 @@
 
 =head1 NAME
 
-BIO_parse_hostserv - utility routines to parse a standard host and service
-string
+BIO_hostserv_priorities,
+BIO_parse_hostserv
+- utility routines to parse a standard host and service string
 
 =head1 SYNOPSIS
 
@@ -21,7 +22,7 @@ BIO_parse_hostserv() will parse the information given in B<hostserv>,
 create strings with the host name and service name and give those
 back via B<host> and B<service>.  Those will need to be freed after
 they are used.  B<hostserv_prio> helps determine if B<hostserv> shall
-be interpreted primarly as a host name or a service name in ambiguous
+be interpreted primarily as a host name or a service name in ambiguous
 cases.
 
 The syntax the BIO_parse_hostserv() recognises is:
@@ -42,26 +43,32 @@ The service part can  be a service name or its port number.
 The returned values will depend on the given B<hostserv> string
 and B<hostserv_prio>, as follows:
 
-=for comment
-The following is ONE verbatim block.  To make sure it's rendered as
-one block and not several, the blank lines in between have one space.
-They should be left as is.
-
  host + ':' + service  => *host = "host", *service = "service"
  host + ':' + '*'      => *host = "host", *service = NULL
  host + ':'            => *host = "host", *service = NULL
         ':' + service  => *host = NULL, *service = "service"
   '*' + ':' + service  => *host = NULL, *service = "service"
+
  in case no ':' is present in the string, the result depends on
  hostserv_prio, as follows:
+
  when hostserv_prio == BIO_PARSE_PRIO_HOST
  host                 => *host = "host", *service untouched
+
  when hostserv_prio == BIO_PARSE_PRIO_SERV
  service              => *host untouched, *service = "service"
 
 =head1 SEE ALSO
 
 L<BIO_ADDRINFO(3)>
+
+=head1 COPYRIGHT
+
+Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
+
+Licensed under the OpenSSL license (the "License").  You may not use
+this file except in compliance with the License.  You can obtain a copy
+in the file LICENSE in the source distribution or at
+L<https://www.openssl.org/source/license.html>.
+
+=cut