.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Podwrapper::Man 1.52.0 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 "guestfs-gobject 3" .TH guestfs-gobject 3 2024-01-05 libguestfs-1.52.0 "Virtualization Support" .\" 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 guestfs\-gobject \- How to use libguestfs with the GObject bindings .SH SYNOPSIS .IX Header "SYNOPSIS" From Javascript using gjs: .PP .Vb 5 \& const Guestfs = imports.gi.Guestfs; \& var g = new Guestfs.Session(); \& g.add_drive(\*(Aqdisk.img\*(Aq, null); \& g.launch(); \& g.close(); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This manual page documents how to call libguestfs using GObject bindings, especially from Javascript. .PP Note that the GObject bindings have problems handling 64 bit values. You should not use the GObject bindings if there are native bindings for your language. For example, to use libguestfs from Python you are strongly advised to use the Python native bindings instead (see \&\fBguestfs\-python\fR\|(3)). .PP This page just documents the differences from the C API and gives some examples. If you are not familiar with using libguestfs, you also need to read \fBguestfs\fR\|(3). .SH JAVASCRIPT .IX Header "JAVASCRIPT" Using gjs, you can write a \f(CW\*(C`.js\*(C'\fR file containing: .PP .Vb 5 \& const Guestfs = imports.gi.Guestfs; \& var g = new Guestfs.Session(); \& g.add_drive(\*(Aqdisk.img\*(Aq, null); \& g.launch(); \& g.close(); .Ve .PP and then run it using: .PP .Vb 1 \& gjs program.js .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBguestfs\fR\|(3), \&\fBguestfs\-examples\fR\|(3), \&\fBguestfs\-erlang\fR\|(3), \&\fBguestfs\-golang\fR\|(3), \&\fBguestfs\-java\fR\|(3), \&\fBguestfs\-lua\fR\|(3), \&\fBguestfs\-perl\fR\|(3), \&\fBguestfs\-python\fR\|(3), \&\fBguestfs\-recipes\fR\|(1), \&\fBguestfs\-ruby\fR\|(3), http://libguestfs.org/. .SH AUTHORS .IX Header "AUTHORS" Richard W.M. Jones (\f(CW\*(C`rjones at redhat dot com\*(C'\fR) .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 2012\-2023 Red Hat Inc. .SH LICENSE .IX Header "LICENSE" This manual page contains examples which we hope you will use in your programs. The examples may be freely copied, modified and distributed for any purpose without any restrictions. .SH BUGS .IX Header "BUGS" To get a list of bugs against libguestfs, use this link: https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools .PP To report a new bug against libguestfs, use this link: https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools .PP When reporting a bug, please supply: .IP \(bu 4 The version of libguestfs. .IP \(bu 4 Where you got libguestfs (eg. which Linux distro, compiled from source, etc) .IP \(bu 4 Describe the bug accurately and give a way to reproduce it. .IP \(bu 4 Run \fBlibguestfs\-test\-tool\fR\|(1) and paste the \fBcomplete, unedited\fR output into the bug report.