/usr/share/doc/libgcrypt20-doc/html/Header.html is in libgcrypt20-doc 1.7.6-2+deb9u3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for Libgcrypt
(version 1.7.6-beta, 18 January 2017),
which is GNU's library of cryptographic building blocks.
Copyright (C) 2000, 2002, 2003, 2004, 2006, 2007, 2008, 2009, 2011, 2012 Free Software Foundation, Inc.
Copyright (C) 2012, 2013, 2016 g10 Code GmbH
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version. The text of the license can be found in the
section entitled "GNU General Public License". -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>The Libgcrypt Reference Manual: Header</title>
<meta name="description" content="The Libgcrypt Reference Manual: Header">
<meta name="keywords" content="The Libgcrypt Reference Manual: Header">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Preparation.html#Preparation" rel="up" title="Preparation">
<link href="Building-sources.html#Building-sources" rel="next" title="Building sources">
<link href="Preparation.html#Preparation" rel="prev" title="Preparation">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<a name="Header"></a>
<div class="header">
<p>
Next: <a href="Building-sources.html#Building-sources" accesskey="n" rel="next">Building sources</a>, Up: <a href="Preparation.html#Preparation" accesskey="u" rel="up">Preparation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Header-1"></a>
<h3 class="section">2.1 Header</h3>
<p>All interfaces (data types and functions) of the library are defined
in the header file <samp>gcrypt.h</samp>. You must include this in all source
files using the library, either directly or through some other header
file, like this:
</p>
<div class="example">
<pre class="example">#include <gcrypt.h>
</pre></div>
<p>The name space of Libgcrypt is <code>gcry_*</code> for function
and type names and <code>GCRY*</code> for other symbols. In addition the
same name prefixes with one prepended underscore are reserved for
internal use and should never be used by an application. Note that
Libgcrypt uses libgpg-error, which uses <code>gpg_*</code> as
name space for function and type names and <code>GPG_*</code> for other
symbols, including all the error codes.
</p>
<p>Certain parts of gcrypt.h may be excluded by defining these macros:
</p>
<dl compact="compact">
<dt><code>GCRYPT_NO_MPI_MACROS</code></dt>
<dd><p>Do not define the shorthand macros <code>mpi_*</code> for <code>gcry_mpi_*</code>.
</p>
</dd>
<dt><code>GCRYPT_NO_DEPRECATED</code></dt>
<dd><p>Do not include definitions for deprecated features. This is useful to
make sure that no deprecated features are used.
</p></dd>
</dl>
</body>
</html>
|