.\" 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-golang 3"
.TH libnbd-golang 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"
libnbd\-golang \- how to use libnbd from Go
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& import "libguestfs.org/libnbd"
\&
\& h, err := libnbd.Create()
\& if err != nil {
\&     panic(err)
\& }
\& defer h.Close()
\& uri := "nbd://localhost"
\& err = h.ConnectUri(uri)
\& if err != nil {
\&     panic(err)
\& }
\& size, err := h.GetSize()
\& if err != nil {
\&     panic(err)
\& }
\& fmt.Printf("size of %s = %d\en", uri, size)
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This manual page documents how to use libnbd to access Network Block
Device (\s-1NBD\s0) servers from the Go programming language.  The Go
bindings work very similarly to the C bindings so you should start by
reading \fBlibnbd\fR\|(3).
.SH "HANDLES"
.IX Header "HANDLES"
Create a libnbd handle of type \f(CW\*(C`Libnbd\*(C'\fR by calling \f(CW\*(C`Create()\*(C'\fR.
.PP
You can either close the handle explicitly by a deferred call to
\&\f(CW\*(C`h.Close()\*(C'\fR or it will be closed automatically when it is garbage
collected.
.SH "ERRORS"
.IX Header "ERRORS"
Most calls return either a single \f(CW\*(C`LibnbdError\*(C'\fR or a pair
\&\f(CW\*(C`(ret, LibnbdError)\*(C'\fR.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
This directory contains examples written in Go:
.PP
https://github.com/libguestfs/libnbd/tree/master/golang/examples
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlibnbd\fR\|(3).
.SH "AUTHORS"
.IX Header "AUTHORS"
Richard W.M. Jones
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 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