.\" Automatically generated by Podwrapper::Man 1.6.1 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" 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'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "nbd_get_version 3" .TH nbd_get_version 3 "2021-02-09" "libnbd-1.6.1" "LIBNBD" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" nbd_get_version \- return the version of the library .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #include \& \& const char * nbd_get_version (struct nbd_handle *h); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Return the version of libnbd. This is returned as a string in the form \f(CW"major.minor.release"\fR where each of major, minor and release is a small positive integer. For example: .PP .Vb 5 \& minor \& ↓ \& "1.0.3" \& ↑ ↑ \& major release .Ve .IP "major = 0" 4 .IX Item "major = 0" The major number was \f(CW0\fR for the early experimental versions of libnbd where we still had an unstable \s-1API.\s0 .IP "major = 1" 4 .IX Item "major = 1" The major number is \f(CW1\fR for the versions of libnbd with a long-term stable \s-1API\s0 and \s-1ABI.\s0 It is not anticipated that major will be any number other than \f(CW1\fR. .IP "minor = 0, 2, ... (even)" 4 .IX Item "minor = 0, 2, ... (even)" The minor number is even for stable releases. .IP "minor = 1, 3, ... (odd)" 4 .IX Item "minor = 1, 3, ... (odd)" The minor number is odd for development versions. Note that new APIs added in a development version remain experimental and subject to change in that branch until they appear in a stable release. .IP "release" 4 .IX Item "release" The release number is incremented for each release along a particular branch. .SH "RETURN VALUE" .IX Header "RETURN VALUE" This call returns a statically allocated string, valid for the lifetime of the process or until libnbd is unloaded by \&\fBdlclose\fR\|(3). You \fBmust not\fR try to free the string. .SH "ERRORS" .IX Header "ERRORS" This function does not fail. .SH "VERSION" .IX Header "VERSION" This function first appeared in libnbd 1.0. .PP If you need to test if this function is available at compile time check if the following macro is defined: .PP .Vb 1 \& #define LIBNBD_HAVE_NBD_GET_VERSION 1 .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBnbd_create\fR\|(3), \&\fBnbd_get_package_name\fR\|(3), \&\fBlibnbd\fR\|(3). .SH "AUTHORS" .IX Header "AUTHORS" Eric Blake .PP Richard W.M. Jones .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2019\-2020 Red Hat Inc. .SH "LICENSE" .IX Header "LICENSE" This library is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This library is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \s-1GNU\s0 Lesser General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, \s-1MA 02110\-1301 USA\s0