aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDavid Vrabel <david.vrabel@citrix.com>2013-07-04 15:25:26 +0100
committerIan Jackson <Ian.Jackson@eu.citrix.com>2013-07-12 14:17:15 +0100
commit8cb199926cb71ef5863add46f42c5ab3cef8ea09 (patch)
treea3c9d19eb860e6797bfa56fc23ca06ceee5a7118 /docs
parentfbfcf225a4b726790a848692cc3830e29ef799b7 (diff)
downloadxen-8cb199926cb71ef5863add46f42c5ab3cef8ea09.tar.gz
xen-8cb199926cb71ef5863add46f42c5ab3cef8ea09.tar.bz2
xen-8cb199926cb71ef5863add46f42c5ab3cef8ea09.zip
docs: add xenstore-ls man page
Signed-off-by: David Vrabel <david.vrabel@citrix.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/man/xenstore-ls.pod.162
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/man/xenstore-ls.pod.1 b/docs/man/xenstore-ls.pod.1
new file mode 100644
index 0000000000..e04a509fa7
--- /dev/null
+++ b/docs/man/xenstore-ls.pod.1
@@ -0,0 +1,62 @@
+=head1 NAME
+
+xenstore-ls - list Xenstore keys and values
+
+=head1 SYNOPSIS
+
+B<xenstore-ls> [I<OPTION>]... [I<PATH>]...
+
+=head1 DESCRIPTION
+
+List keys, values and permissions of one or more Xenstore I<PATH>s,
+using a nested, tree-like view.
+
+=over
+
+=item B<-f>
+
+Show the full path for all keys.
+
+=item B<-p>
+
+Show permissions of all the listed keys as comma separated list. The
+format of each permission is I<LD>, where I<L> is a letter for the
+type of permission and I<D> is the corresponding domain ID.
+
+The types of permission are:
+
+=over
+
+=item B<r>
+
+read
+
+=item B<w>
+
+write
+
+=item B<b>
+
+read and write (both)
+
+=item B<n>
+
+no access
+
+=back
+
+The first permission entry is the domain owning the key (the owner)
+I<and> the permissions for any domain not explicitly listed in
+subsequent entries. The key owner always has full access (read,
+write, and set permissions).
+
+=item B<-s>
+
+Connect to the Xenstore daemon using a local socket only.
+
+=back
+
+=head1 BUGS
+
+Send bugs to xen-devel@lists.xen.org, see
+http://wiki.xen.org/xenwiki/ReportingBugs on how to send bug reports.