.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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 "xenhypfs 1"
.TH xenhypfs 1 2024-02-04 4.17.4-pre Xen
.\" 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
xenhypfs \- Xen tool to access Xen hypervisor file system
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBxenhypfs\fR \fIsubcommand\fR [\fIoptions\fR] [\fIargs\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBxenhypfs\fR program is used to access the Xen hypervisor file system.
It can be used to show the available entries, to show their contents and
(if allowed) to modify their contents.
.SH SUBCOMMANDS
.IX Header "SUBCOMMANDS"
.IP "\fBls\fR \fIpath\fR" 4
.IX Item "ls path"
List the available entries below \fIpath\fR.
.IP "\fBcat\fR [\fI\-b\fR] \fIpath\fR" 4
.IX Item "cat [-b] path"
Show the contents of the entry specified by \fIpath\fR. Non-printable characters
other than white space characters (like tab, new line) will be shown as
\&\fB\exnn\fR (\fBnn\fR being a two digit hex number) unless the option \fB\-b\fR is
specified.
.IP "\fBwrite\fR \fIpath\fR \fIvalue\fR" 4
.IX Item "write path value"
Set the contents of the entry specified by \fIpath\fR to \fIvalue\fR.
.IP \fBtree\fR 4
.IX Item "tree"
Show all the entries of the file system as a tree.
.SH "RETURN CODES"
.IX Header "RETURN CODES"
.IP \fB0\fR 4
.IX Item "0"
Success
.IP \fB1\fR 4
.IX Item "1"
Invalid usage (e.g. unknown subcommand, unknown option, missing parameter).
.IP \fB2\fR 4
.IX Item "2"
Entry not found while traversing the tree.
.IP \fB3\fR 4
.IX Item "3"
Access right violation.