Project

General

Profile

Files » tiny_clipversion.3.html

tiny_clipversion(3) manual page - quintus, 01/13/2020 09:08 AM

 
<!-- Creator : groff version 1.22.4 -->
<!-- CreationDate: Mon Jan 13 08:04:29 2020 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>tiny_clipversion</title>

</head>
<body>

<h1 align="center">tiny_clipversion</h1>

<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#RETURN VALUE">RETURN VALUE</a><br>
<a href="#ERRORS">ERRORS</a><br>
<a href="#EXAMPLES">EXAMPLES</a><br>
<a href="#NOTES">NOTES</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<a href="#AUTHOR">AUTHOR</a><br>

<hr>


<h2>NAME
<a name="NAME"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em">tiny_clipversion
- tinyclipboard version information</p>

<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em"><b>#include
&lt;tinyclipboard.h&gt;</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>#define
TINYCLIPBOARD_VERSION</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>const char*
tiny_clipversion</b>(<b>void</b>);</p>

<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">The
<b>tiny_clipversion()</b> function gives information about
the version of the <i>tinyclipboard</i> library in use,
condensed into one string.</p>

<p style="margin-left:11%; margin-top: 1em">The
<b>TINYCLIPBOARD_VERSION</b> macro provides the same
information, but separated into components you can check
against. It is defined as the version number as an ordinary
number of form <b>YYYYMMPPL</b>, where <b>YYYY</b> denotes
the year, <b>MM</b> denotes the month (with a leading zero
if it is a month &lt; 10), <b>PP</b> denotes the patch
release number (again with a leading zero or even with two
zeros for the first release in a month) and <b>L</b> is
literal (i.e. denotes a <b>long int</b> constant value). For
example, it may have the value <b>20160100L</b>, which means
the release was made in January 2016, and it was the first
of any releases in January. If it had the value
<b>20160101L</b>, then it would be the second release in
January 2016.</p>

<h2>RETURN VALUE
<a name="RETURN VALUE"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">This function
returns a pointer to statically allocated memory that
contains the version information as a <b>NUL</b>-terminated
string that does not end with a newline. It must not be
freed.</p>

<p style="margin-left:11%; margin-top: 1em">The macro is
defined as a literal constant of type <b>long int</b>.</p>

<h2>ERRORS
<a name="ERRORS"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">None.</p>

<h2>EXAMPLES
<a name="EXAMPLES"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">None.</p>

<h2>NOTES
<a name="NOTES"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">The
<i>tinyclipboard</i> library follows a simplistic versioning
scheme that is mostly based on the release date. The version
number is of form <b>YY.MM</b>, which refers to the shorted
year and the number of the month the release was made in. If
multiple releases are made in the same month, the version
number becomes <b>YY.MM.PP</b>, where <b>PP</b> is the
number of the followup release (<b>PP</b> can never be zero,
as it then falls off). <b>PP</b> has no leading zeros, but
<b>MM</b> has. Note that it it rather unlikely that I do
more than nine releases in a month.</p>

<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">None.</p>

<h2>AUTHOR
<a name="AUTHOR"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">The
<i>tinyclipboard</i> library was written by Marvin
G&uuml;lker &lt;m-guelker@guelkerdev.de&gt;.</p>
<hr>
</body>
</html>
(3-3/4)