Re: [Xen-devel] [PATCH] docs: add xenstore-ls man page

[Ian Campbell <Ian.Campbell@xxxxxxxxxx>]

On Tue, 2013-07-02 at 11:21 +0100, David Vrabel wrote:
> From: David Vrabel <david.vrabel@xxxxxxxxxx>
> 
> Signed-off-by: David Vrabel <david.vrabel@xxxxxxxxxx>

Cool, thanks.

Any reason not to do the others? (I'll assume lack of time...)

xenstore-ls is actually a pointer to the multifunction xenstore client
utility (i.e. you can run "xenstore ls ..." too).

Is the normal Unix idiom in this case to have a single manpage which
documents all the various sub-functions.

BTW I'm not suggesting you write them all but perhaps a single
xenstore.pod.1 with placeholders for the others would be a better start?

Ack on the actual text here.

> ---
>  docs/man/xenstore-ls.pod.1 |   60 
> ++++++++++++++++++++++++++++++++++++++++++++
>  1 files changed, 60 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..3990b9a
> --- /dev/null
> +++ b/docs/man/xenstore-ls.pod.1
> @@ -0,0 +1,60 @@
> +=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 key owner.  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@xxxxxxxxxxxxx, see
> +http://wiki.xen.org/xenwiki/ReportingBugs on how to send bug reports.



_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel