1=head1 NAME
2
3xenhypfs - Xen tool to access Xen hypervisor file system
4
5=head1 SYNOPSIS
6
7B<xenhypfs> I<subcommand> [I<options>] [I<args>]
8
9=head1 DESCRIPTION
10
11The B<xenhypfs> program is used to access the Xen hypervisor file system.
12It can be used to show the available entries, to show their contents and
13(if allowed) to modify their contents.
14
15=head1 SUBCOMMANDS
16
17=over 4
18
19=item B<ls> I<path>
20
21List the available entries below I<path>.
22
23=item B<cat> [I<-b>] I<path>
24
25Show the contents of the entry specified by I<path>. Non-printable characters
26other than white space characters (like tab, new line) will be shown as
27B<\xnn> (B<nn> being a two digit hex number) unless the option B<-b> is
28specified.
29
30=item B<write> I<path> I<value>
31
32Set the contents of the entry specified by I<path> to I<value>.
33
34=item B<tree>
35
36Show all the entries of the file system as a tree.
37
38=back
39
40=head1 RETURN CODES
41
42=over 4
43
44=item B<0>
45
46Success
47
48=item B<1>
49
50Invalid usage (e.g. unknown subcommand, unknown option, missing parameter).
51
52=item B<2>
53
54Entry not found while traversing the tree.
55
56=item B<3>
57
58Access right violation.
59
60=back
61