Fix many doc L<> errors
[openssl.git] / doc / man3 / X509_cmp_time.pod
1 =pod
2
3 =head1 NAME
4
5 X509_cmp_time - X509 time functions
6
7 =head1 SYNOPSIS
8
9  X509_cmp_time(const ASN1_TIME *asn1_time, time_t *cmp_time);
10
11 =head1 DESCRIPTION
12
13 X509_cmp_time() compares the ASN1_TIME in B<asn1_time> with the time in
14 <cmp_time>.
15
16 B<asn1_time> must satisfy the ASN1_TIME format mandated by RFC 5280, i.e.,
17 its format must be either YYMMDDHHMMSSZ or YYYYMMDDHHMMSSZ.
18
19 If B<cmp_time> is NULL the current time is used.
20
21 =head1 BUGS
22
23 Unlike many standard comparison functions, X509_cmp_time returns 0 on error.
24
25 =head1 RETURN VALUES
26
27 X509_cmp_time() returns -1 if B<asn1_time> is earlier than, or equal to,
28 B<cmp_time>, and 1 otherwise. It returns 0 on error.
29
30 =head1 COPYRIGHT
31
32 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
33
34 Licensed under the OpenSSL license (the "License").  You may not use
35 this file except in compliance with the License.  You can obtain a copy
36 in the file LICENSE in the source distribution or at
37 L<https://www.openssl.org/source/license.html>.
38
39 =cut