libcrypto/man/OPENSSL_FILE.3

 $NetBSD: OPENSSL_FILE.3,v 1.6 2025/04/16 15:23:15 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

 Standard preamble:
 ========================================================================
..
..

..
 \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 If the F register is >0, we'll generate index entries on stderr for
 titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 entries marked with X<> in POD. Of course, you'll have to process the
 output yourself in some meaningful fashion.

 Avoid warning from groff about undefined register 'F'.
..
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
 ========================================================================

 Title "OPENSSL_FILE 3"  OPENSSL_FILE 3 2025-02-11 3.0.16 OpenSSL
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
.nh
 NAME
OPENSSL_FILE, OPENSSL_LINE, OPENSSL_FUNC,
OPENSSL_MSTR, OPENSSL_MSTR_HELPER
\- generic C programming utility macros
 SYNOPSIS
 Header "SYNOPSIS" .Vb 1
 #include <openssl/macros.h>
\&
 #define OPENSSL_FILE /* typically: _\|_FILE_\|_ */
 #define OPENSSL_LINE /* typically: _\|_LINE_\|_ */
 #define OPENSSL_FUNC /* typically: _\|_func_\|_ */
\&
 #define OPENSSL_MSTR_HELPER(x) #x
 #define OPENSSL_MSTR(x) OPENSSL_MSTR_HELPER(x)
.Ve
 DESCRIPTION
 Header "DESCRIPTION" The macros OPENSSL_FILE and OPENSSL_LINE
typically yield the current filename and line number during C compilation.
When OPENSSL_NO_FILENAMES is defined they yield "" and 0, respectively.

The macro OPENSSL_FUNC attempts to yield the name of the C function
currently being compiled, as far as language and compiler versions allow.
Otherwise, it yields "(unknown function)".

The macro OPENSSL_MSTR yields the expansion of the macro given as argument,
which is useful for concatenation with string constants.
The macro OPENSSL_MSTR_HELPER is an auxiliary macro for this purpose.
 "RETURN VALUES"
 Header "RETURN VALUES" see above
 "SEE ALSO"
 Header "SEE ALSO" \fBcrypto\|(7)
 HISTORY
 Header "HISTORY" \fBOPENSSL_FUNC, OPENSSL_MSTR, and OPENSSL_MSTR_HELPER
were added in OpenSSL 3.0.
 COPYRIGHT
 Header "COPYRIGHT" Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (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
<https://www.openssl.org/source/license.html>.