.\" 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 "libnbd-release-notes-1.6 1"
.TH libnbd-release-notes-1.6 1 "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"
libnbd\-release\-notes\-1.6 \- release notes for libnbd 1.6
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
These are the release notes for libnbd stable release 1.6.
This describes the major changes since 1.4.
.PP
libnbd 1.6.0 was released on \fB7 January 2021\fR.
.SS "Security"
.IX Subsection "Security"
There were no security issues found in this release.
.PP
If you find a security issue, please read \fI\s-1SECURITY\s0\fR in the source
(online here:
https://github.com/libguestfs/libnbd/blob/master/SECURITY).  To
find out about previous security issues in libnbd, see
\&\fBlibnbd\-security\fR\|(3).
.SS "New APIs"
.IX Subsection "New APIs"
.IP "\fBnbd_set_strict_mode\fR\|(3)" 4
.IX Item "nbd_set_strict_mode"
.PD 0
.IP "\fBnbd_get_strict_mode\fR\|(3)" 4
.IX Item "nbd_get_strict_mode"
.PD
This \s-1API\s0 allows you to control how libnbd handles requests from the
program that it thinks would trigger undefined behaviour in the server
(such as sending unknown commands, zero-sized or out-of-bounds
requests, etc).  Normally libnbd is very strict and will prevent you
from sending such requests, but you can use this \s-1API\s0 to relax these
restrictions, leaving it up to the server to handle or reject them.
Some servers may crash if you do this.
.IP "\fBnbd_get_nr_meta_contexts\fR\|(3)" 4
.IX Item "nbd_get_nr_meta_contexts"
.PD 0
.IP "\fBnbd_get_meta_context\fR\|(3)" 4
.IX Item "nbd_get_meta_context"
.IP "\fBnbd_clear_meta_contexts\fR\|(3)" 4
.IX Item "nbd_clear_meta_contexts"
.PD
These APIs allow you to review or clear the requested metadata
contexts.
.IP "\fBnbd_opt_list_meta_context\fR\|(3)" 4
.IX Item "nbd_opt_list_meta_context"
.PD 0
.IP "\fBnbd_aio_opt_list_meta_context\fR\|(3)" 4
.IX Item "nbd_aio_opt_list_meta_context"
.PD
Request that the server lists available metadata contexts.  You can
only use this in opt mode.
.PP
Thanks: Eric Blake for all of the new APIs.
.SS "Enhancements to existing APIs"
.IX Subsection "Enhancements to existing APIs"
\&\fBnbd_shutdown\fR\|(3) new flag \f(CW\*(C`LIBNBD_SHUTDOWN_ABANDON_PENDING\*(C'\fR drops
any commands in flight which have not been sent to the server yet
(Eric Blake).
.PP
All APIs which have flag (bitmask) parameters now define a
\&\f(CW\*(C`LIBNBD_*_MASK\*(C'\fR constant allowing you to tell which bits represent
valid flags at compilation time (Eric Blake).
.SS "New features"
.IX Subsection "New features"
The performance of the \fBnbdcopy\fR\|(1) tool has been greatly improved.
Also it supports numerous new features.
.PP
New \fBnbdinfo\fR\|(1) \fI\-\-map\fR option showing the allocated and sparse
extents of an \s-1NBD\s0 server.  This can also show other information such
as dirty bitmaps.
.SS "Tools"
.IX Subsection "Tools"
\&\fBnbdfuse\fR\|(1) can now mount the \s-1NBD\s0 export on top of any regular file,
it does not have to mount over a directory.
.PP
\&\fBnbdsh\fR\|(1) now produces a nice error message if the \s-1URI\s0 in the \fI\-u\fR
option or the command in the \fI\-c\fR option is wrong (Eric Blake).
.PP
New \fBnbdsh\fR\|(1) \fI\-\-opt\-mode\fR option which requests opt mode on the
handle before connecting.
.PP
\&\fBnbdinfo\fR\|(1) \fI\-\-list\fR option now shows the supported metadata
contexts of the server (Eric Blake).
.PP
The output of \fBnbdinfo\fR\|(1) is now usually printed atomically, ie. it
will either print the complete output or an error message, but not
partial output followed by an error.
.PP
\&\fBnbdinfo\fR\|(1) can now decode \f(CW\*(C`qemu:allocation\-depth\*(C'\fR metacontext
(Eric Blake).
.SS "Other improvements and bug fixes"
.IX Subsection "Other improvements and bug fixes"
Multiple improvements to handling of \s-1NBD\s0 protocol (Eric Blake).
.PP
Fix handling of booleans in Python bindings (Eric Blake).
.PP
Fix handling of flags parameters in OCaml bindings (Eric Blake).
.PP
Python style fixes (Eric Blake).
.PP
Fix multiple memory leaks (Eric Blake).
.PP
OCaml bindings now include ocamldoc-generated documentation, if
ocamldoc is installed at build time.
.PP
The \*(L"vector\*(R" library from nbdkit is now used by libnbd, simplifying
places where we used to use \fBrealloc\fR\|(3).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlibnbd\fR\|(3).
.SH "AUTHORS"
.IX Header "AUTHORS"
Eric Blake
.PP
Richard W.M. Jones
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2020\-2021 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