Xen devel - Jul 2013 - [PATCHv2 0/3] docs: add (some) xenstore utility man pages

This series adds a few man pages for the xenstore utility and some of
its sub-commands.

Changes in v2:

- add xenstore(1) and xenstore-chmod(1) pages

David

From: David Vrabel <david.vrabel@citrix.com>

Signed-off-by: David Vrabel <david.vrabel@citrix.com>
---
 docs/man/xenstore.pod.1 |   52 +++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 52 insertions(+), 0 deletions(-)
 create mode 100644 docs/man/xenstore.pod.1

diff --git a/docs/man/xenstore.pod.1 b/docs/man/xenstore.pod.1
new file mode 100644
index 0000000..7417289
--- /dev/null
+++ b/docs/man/xenstore.pod.1
@@ -0,0 +1,52 @@
+=head1 NAME
+
+xenstore - interact with Xenstore
+
+=head1 SYNOPSIS
+
+B<xenstore> I<CMD> ...
+
+=head1 DESCRIPTION
+
+A set of utilities for interacting with Xenstore.
+
+=over
+
+=item B<xenstore-chmod>(1)
+
+Sets the permissions of keys.
+
+=item B<xenstore-exists>(1)
+
+Test for the existance of a key.
+
+=item B<xenstore-list>(1)
+
+List keys.
+
+=item B<xenstore-ls>(1)
+
+List keys, values and permissions.
+
+=item B<xenstore-read>(1)
+
+Read the value of a key.
+
+=item B<xenstore-rm>(1)
+
+Remove keys.
+
+=item B<xenstore-watch>(1)
+
+Watch for changes to keys or values.
+
+=item B<xenstore-write>(1)
+
+Add or modify keys and values.
+
+=back
+
+=head1 BUGS
+
+Send bugs to xen-devel@lists.xen.org, see
+http://wiki.xen.org/xenwiki/ReportingBugs on how to send bug reports.
-- 
1.7.2.5

From: David Vrabel <david.vrabel@citrix.com>

Signed-off-by: David Vrabel <david.vrabel@citrix.com>
---
 docs/man/xenstore-ls.pod.1 |   62 ++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 62 insertions(+), 0 deletions(-)
 create mode 100644 docs/man/xenstore-ls.pod.1

diff --git a/docs/man/xenstore-ls.pod.1 b/docs/man/xenstore-ls.pod.1
new file mode 100644
index 0000000..e04a509
--- /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.
-- 
1.7.2.5

From: David Vrabel <david.vrabel@citrix.com>

Signed-off-by: David Vrabel <david.vrabel@citrix.com>
---
 docs/man/xenstore-chmod.pod.1 |   62 +++++++++++++++++++++++++++++++++++++++++
 1 files changed, 62 insertions(+), 0 deletions(-)
 create mode 100644 docs/man/xenstore-chmod.pod.1

diff --git a/docs/man/xenstore-chmod.pod.1 b/docs/man/xenstore-chmod.pod.1
new file mode 100644
index 0000000..cb1dc2e
--- /dev/null
+++ b/docs/man/xenstore-chmod.pod.1
@@ -0,0 +1,62 @@
+=head1 NAME
+
+xenstore-chmod - set the permissions of a Xenstore key
+
+=head1 SYNOPSIS
+
+B<xenstore-chmod> [I<OPTION>]... [I<KEY>] [I<PERM>]...
+
+=head1 DESCRIPTION
+
+Sets the permissions of the Xenstore I<KEY>.
+
+I<PERM> has the format 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).
+
+=over
+
+=item B<-r>
+
+Apply the permissions to the key and all its I<children>.
+
+=item B<-s>
+
+Connect to the Xenstore daemon using a local socket only.
+
+=item B<-u>
+
+Apply the permissions to the key and all its I<parents>.
+
+=back
+
+=head1 BUGS
+
+Send bugs to xen-devel@lists.xen.org, see
+http://wiki.xen.org/xenwiki/ReportingBugs on how to send bug reports.
-- 
1.7.2.5

On 04/07/13 15:25, David Vrabel wrote:
> This series adds a few man pages for the xenstore utility and some of
> its sub-commands.
Ping?

David

On Fri, 2013-07-12 at 11:07 +0100, David Vrabel wrote:
> On 04/07/13 15:25, David Vrabel wrote:
> > This series adds a few man pages for the xenstore utility and some of
> > its sub-commands.
> 
> Ping?
Sorry for the silence. It''s in my queue folder but I''ve not
looked at it
while I''m travelling.

Ian.

David Vrabel writes ("[PATCHv2 0/3] docs: add (some) xenstore utility man
pages"):
> This series adds a few man pages for the xenstore utility and some of
> its sub-commands.
Applied all three, thanks.

Ian.