[sheepdog] WG: AW: [sheepdog-users] collie.8 man page?
Jens WEBER
jweber at tek2b.org
Tue Jun 26 16:40:33 CEST 2012
Hi folks,
patch included or pull it from here http://tek2b.org/git/projects/sheepdog.git (/debian/patches/collie_manpage)
Cheers Jens
---- snip ----
Index: sheepdog-0.3.0-0~bpo60+tek2b-2/man/collie.8
===================================================================
--- /dev/null 1970-01-01 00:00:00.000000000 +0000
+++ sheepdog-0.3.0-0~bpo60+tek2b-2/man/collie.8 2012-06-26 12:38:25.848225274 +0200
@@ -0,0 +1,127 @@
+.TH SHEEPDOG 2012-06-26
+.SH NAME
+collie \- Command line utility for the sheep daemon
+.SH SNYNOPSIS
+.B "collie <command> <subcommand> [options]"
+.SH DESCRIPTION
+.B collie
+- Sheepdog is a distributed storage system for KVM/QEMU. It provides
+highly available block level storage volumes to virtual machines.
+Sheepdog supports advanced volume management features such as snapshot,
+cloning, and thin provisioning. The architecture of Sheepdog is fully
+symmetric; there is no central node such as a meta-data server.
+
+The server daemon is called sheep(8). A command line utility is available
+via collie(8). KVM/QEMU virtual machines use the sheep daemon via a block
+driver available in qemu(1).
+
+For more information, run 'collie <command> <subcommand> --help'.
+.SH OPTIONS
+.TP
+.BI \-a "\fR, \fP" \--address
+This option specify the daemon address (default: localhost).
+.TP
+.BI \-p "\fR, \fP" \--port
+This option specify the daemon port.
+.TP
+.BI \-i "\fR, \fP" \--index
+This option specify the index of data objects.
+.TP
+.BI \-s "\fR, \fP" \--snapshot
+This option specify a snapshot id or tag name.
+.TP
+.BI \-P "\fR, \fP" \--prealloc
+This option preallocate all the data objects.
+.TP
+.BI \-r "\fR, \fP" \--raw
+This option set raw output mode: omit headers, separate fields with single spaces and print all sizes in decimal bytes.
+.TP
+.BI \-d "\fR, \fP" \--delete
+This option delete a key.
+.TP
+.BI \-x "\fR, \fP" \--exclusive
+This option write in an exclusive mode.
+.TP
+.BI \-c "\fR, \fP" \--copies
+This option specify the data redundancy (number of copies).
+.TP
+.BI \-H "\fR, \fP" \--nohalt
+This option serve IO requests even if there are too few nodes for the configured redundancy.
+.TP
+.BI \-f "\fR, \fP" \--force
+Do not prompt for confirmation.
+.TP
+.BI \-h "\fR, \fP" \--help
+Display help and exit.
+.SH COMMAND & SUBCOMMAND
+.TP
+.BI "vdi create [-P|--prealloc] [-a|--address address] [-p|--port port] [-h|--help] <vdiname> <size>"
+This command create an image.
+.TP
+.BI "vdi snapshot [-s snapshot] [-a address] [-p port] [-h] <vdiname>"
+This command create a snapshot.
+.TP
+.BI "vdi clone [-s snapshot] [-P] [-a address] [-p port] [-h] <src vdi> <dst vdi>"
+This command clone an image.
+.TP
+.BI "vdi delete [-s snapshot] [-a address] [-p port] [-h] <vdiname>"
+This command delete an image.
+.TP
+.BI "collie vdi list [-a address] [-p port] [-r] [-h] [vdiname]"
+This command list images.
+.TP
+.BI "vdi tree [-a address] [-p port] [-h]"
+This command show images in tree view format.
+.TP
+.BI "vdi graph [-a address] [-p port] [-h]"
+This command show images in Graphviz dot format.
+.TP
+.BI "vdi object [-i index] [-s snapshot] [-a address] [-p port] [-h] <vdiname>"
+This command show object information in the image.
+.TP
+.BI "vdi setattr [-d] [-x] [-a address] [-p port] [-h] <vdiname> <key> [value]"
+This command set a VDI attribute.
+.TP
+.BI "vdi getattr [-a address] [-p port] [-h] <vdiname> <key>"
+This command get a VDI attribute.
+.TP
+.BI "vdi resize [-a address] [-p port] [-h] <vdiname> <new size>"
+This command resize an image.
+.TP
+.BI "vdi read [-s snapshot] [-a address] [-p port] [-h] <vdiname> [<offset> [<len>]]"
+This command read data from an image.
+.TP
+.BI "vdi write [-a address] [-p port] [-h] <vdiname> [<offset> [<len>]]"
+This command write data to an image.
+.TP
+.BI "node list [-a address] [-p port] [-r] [-h]"
+This command list nodes.
+.TP
+.BI "node info [-a address] [-p port] [-r] [-h]"
+This command show information about each node.
+.TP
+.BI "cluster info [-a address] [-p port] [-r] [-h]"
+This command show cluster information.
+.TP
+.BI "cluster format [-c copies] [-H] [-a address] [-p port] [-h]"
+This command create a Sheepdog store.
+.TP
+.BI "cluster shutdown [-a address] [-p port] [-h]"
+This command stop Sheepdog.
+.TP
+.BI "cluster recover [-a address] [-f] [-p port] [-h]"
+This command manually recover the cluster.
+
+.SH DEPENDENCIES
+\fBsheepdog\fP requires QEMU 0.13.z or later and Corosync 1.y.z.
+
+.SH FILES
+none
+
+.SH SEE ALSO
+.BR collie(8),qemu(1),corosync_overview(8)
+
+.SH AUTHORS
+This software is developed by the sheepdog community which may be reached
+via mailing list at <sheepdog at lists.wpkg.org>.
+.PP
Index: sheepdog-0.3.0-0~bpo60+tek2b-2/man/sheep.8
===================================================================
--- sheepdog-0.3.0-0~bpo60+tek2b-2.orig/man/sheep.8 2012-06-26 10:47:30.148220042 +0200
+++ sheepdog-0.3.0-0~bpo60+tek2b-2/man/sheep.8 2012-06-26 12:35:59.217218066 +0200
@@ -1,11 +1,11 @@
-.TH SHEEPDOG 2010-08-24
+.TH SHEEPDOG 2012-06-26
.SH NAME
sheep \- Distributed Block Storage System for KVM
.SH SNYNOPSIS
.B "sheep [options] [PATH]"
.SH DESCRIPTION
.B sheep
-Sheepdog is a distributed storage system for KVM/QEMU. It provides
+- Sheepdog is a distributed storage system for KVM/QEMU. It provides
highly available block level storage volumes to virtual machines.
Sheepdog supports advanced volume management features such as snapshot,
cloning, and thin provisioning. The architecture of Sheepdog is fully
@@ -29,8 +29,18 @@
.BI \-d "\fR, \fP" \--debug
This option displays debug messages.
.TP
+.BI \-D "\fR, \fP" \--directio
+This option use direct IO when accessing the object store.
+.TP
+.BI \-z "\fR, \fP" \--zone
+This option specify the zone id.
+.TP
+.BI \-c "\fR, \fP" \--cluster
+This option specify the cluster driver.
+.TP
.BI \-h "\fR, \fP" \--help
Display help and exit.
+
.SH PATH
Proper LSB systems will store sheepdog files in /var/lib/sheepdog. The init
script uses this directory by default. The directory must be on a filesystem
Index: sheepdog-0.3.0-0~bpo60+tek2b-2/man/Makefile.am
===================================================================
--- sheepdog-0.3.0-0~bpo60+tek2b-2.orig/man/Makefile.am 2012-06-26 10:46:24.776220133 +0200
+++ sheepdog-0.3.0-0~bpo60+tek2b-2/man/Makefile.am 2012-06-26 12:40:13.657218296 +0200
@@ -1,3 +1,3 @@
MAINTAINERCLEANFILES = Makefile.in
-dist_man_MANS = sheep.8
+dist_man_MANS = sheep.8 collie.8
---- snip ----
-----Ursprüngliche Nachricht-----
Von:Liu Yuan <namei.unix at gmail.com>
Gesendet:Di 26.06.2012 15:40
Betreff:Re: AW: [sheepdog-users] collie.8 man page?
An:Jens WEBER <jweber at tek2b.org>;
CC:MORITA Kazutaka <morita.kazutaka at gmail.com>; sheepdog-users at lists.wpkg.org;
On 06/26/2012 09:34 PM, Jens WEBER wrote:
> Hi,
>
>
>
> here comes collie.8 manpage and updated sheep.8 manpage for release 0.3.0.
>
>
>
> You can pull it from here http://tek2b.org/gitweb/?p=sheepdog.git;a=summary
>
>
>
Hi Jens
Thanks for your good job. We'd like to merge these manpage into the
upstream sheepdog git repo too. Would you please send patches to devel-list?
Thanks,
Yuan
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.wpkg.org/pipermail/sheepdog/attachments/20120626/9fb027cd/attachment-0002.html>
More information about the sheepdog
mailing list