]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
obsync: section 8 -> 1
authorSage Weil <sage.weil@dreamhost.com>
Thu, 19 Apr 2012 05:08:28 +0000 (22:08 -0700)
committerSage Weil <sage.weil@dreamhost.com>
Thu, 19 Apr 2012 19:47:50 +0000 (12:47 -0700)
Fixes: #2263
Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
ceph.spec.in
debian/obsync.install
doc/man/1/obsync.rst [new file with mode: 0644]
doc/man/8/obsync.rst [deleted file]
man/Makefile.am
man/obsync.1 [new file with mode: 0644]
man/obsync.8 [deleted file]

index 5b2f23309948ae39cd6b5b4fd6bb067e52f389fa..32192097d56aafe594dba893ec60ecd1137089ee 100644 (file)
@@ -341,7 +341,7 @@ fi
 %{_mandir}/man8/mount.ceph.8*
 %{_mandir}/man8/rados.8*
 %{_mandir}/man8/rbd.8*
-%{_mandir}/man8/obsync.8*
+%{_mandir}/man1/obsync.1*
 %{_mandir}/man8/ceph-rbdnamer.8*
 %{_mandir}/man8/ceph-authtool.8*
 %{_mandir}/man8/ceph-debugpack.8*
index 5ac05ab12e9c4955906023e654268f7d752b946f..04f485c5e50f1e82b918337cd13b0f69693b155d 100644 (file)
@@ -1,2 +1,2 @@
 usr/bin/obsync
-usr/share/man/man8/obsync.8
+usr/share/man/man1/obsync.1
diff --git a/doc/man/1/obsync.rst b/doc/man/1/obsync.rst
new file mode 100644 (file)
index 0000000..0963e89
--- /dev/null
@@ -0,0 +1,143 @@
+========================================
+ obsync -- The object synchronizer tool
+========================================
+
+.. program:: obsync
+
+Synopsis
+========
+
+| **obsync** [ *options* ] *source-url* *destination-url*
+
+
+Description
+===========
+
+**obsync** is an object syncrhonizer tool designed to transfer objects
+between different object storage systems. Similar to rsync, you
+specify a source and a destination, and it will transfer objects
+between them until the destination has all the objects in the
+source. Obsync will never modify the source -- only the destination.
+
+By default, obsync does not delete anything. However, by specifying
+``--delete-after`` or ``--delete-before``, you can ask it to delete
+objects from the destination that are not in the source.
+
+
+Target types
+============
+
+Obsync supports S3 via ``libboto``. To use the s3 target, your URL
+should look like this: ``s3://host-name/bucket-name``
+
+Obsync supports storing files locally via the ``file://`` target. To
+use the file target, your URL should look like this:
+``file://directory-name``
+
+Alternately, give no prefix, like this: ``./directory-name``
+
+Obsync supports storing files in a RADOS Gateway backend via the
+``librados`` Python bindings. To use the ``rgw` target, your URL
+should look like this: ``rgw:ceph-configuration-path:rgw-bucket-name``
+
+
+Options
+=======
+
+.. option:: -h, --help
+
+   Display a help message
+
+.. option:: -n, --dry-run
+
+   Show what would be done, but do not modify the destination.
+
+.. option:: -c, --create-dest
+
+   Create the destination if it does not exist.
+
+.. option:: --delete-before
+
+   Before copying any files, delete objects in the destination that
+   are not in the source.
+
+.. option:: -L, --follow-symlinks
+
+   Follow symlinks when dealing with ``file://`` targets.
+
+.. option:: --no-preserve-acls
+
+   Don't preserve ACLs when copying objects.
+
+.. option:: -v, --verbose
+
+   Be verbose.
+
+.. option:: -V, --more-verbose
+
+   Be really, really verbose (developer mode)
+
+.. option:: -x SRC=DST, --xuser SRC=DST
+
+   Set up a user translation. You can specify multiple user
+   translations with multiple ``--xuser`` arguments.
+
+.. option:: --force
+
+   Overwrite all destination objects, even if they appear to be the
+   same as the source objects.
+
+
+Environment variables
+=====================
+
+.. envvar:: SRC_AKEY
+
+   Access key for the source URL
+
+.. envvar:: SRC_SKEY
+
+   Secret access key for the source URL
+
+.. envvar:: DST_AKEY
+
+   Access key for the destination URL
+
+.. envvar:: DST_SKEY
+
+   Secret access key for the destination URL
+
+.. envvar:: AKEY
+
+   Access key for both source and dest
+
+.. envvar:: SKEY
+
+   Secret access key for both source and dest
+
+.. envvar:: DST_CONSISTENCY
+
+   Set to 'eventual' if the destination is eventually consistent. If the destination
+   is eventually consistent, we may have to retry certain operations multiple times.
+
+
+Examples
+========
+
+::
+
+        AKEY=... SKEY=... obsync -c -d -v ./backup-directory s3://myhost1/mybucket1
+
+Copy objects from backup-directory to mybucket1 on myhost1::
+
+        SRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=... obsync -c -d -v s3://myhost1/mybucket1 s3://myhost1/mybucket2
+
+Copy objects from mybucket1 to mybucket2
+
+
+Availability
+============
+
+**obsync** is part of the Ceph distributed file system. Please refer
+to the Ceph wiki at http://ceph.newdream.net/wiki for more
+information.
diff --git a/doc/man/8/obsync.rst b/doc/man/8/obsync.rst
deleted file mode 100644 (file)
index 0963e89..0000000
+++ /dev/null
@@ -1,143 +0,0 @@
-========================================
- obsync -- The object synchronizer tool
-========================================
-
-.. program:: obsync
-
-Synopsis
-========
-
-| **obsync** [ *options* ] *source-url* *destination-url*
-
-
-Description
-===========
-
-**obsync** is an object syncrhonizer tool designed to transfer objects
-between different object storage systems. Similar to rsync, you
-specify a source and a destination, and it will transfer objects
-between them until the destination has all the objects in the
-source. Obsync will never modify the source -- only the destination.
-
-By default, obsync does not delete anything. However, by specifying
-``--delete-after`` or ``--delete-before``, you can ask it to delete
-objects from the destination that are not in the source.
-
-
-Target types
-============
-
-Obsync supports S3 via ``libboto``. To use the s3 target, your URL
-should look like this: ``s3://host-name/bucket-name``
-
-Obsync supports storing files locally via the ``file://`` target. To
-use the file target, your URL should look like this:
-``file://directory-name``
-
-Alternately, give no prefix, like this: ``./directory-name``
-
-Obsync supports storing files in a RADOS Gateway backend via the
-``librados`` Python bindings. To use the ``rgw` target, your URL
-should look like this: ``rgw:ceph-configuration-path:rgw-bucket-name``
-
-
-Options
-=======
-
-.. option:: -h, --help
-
-   Display a help message
-
-.. option:: -n, --dry-run
-
-   Show what would be done, but do not modify the destination.
-
-.. option:: -c, --create-dest
-
-   Create the destination if it does not exist.
-
-.. option:: --delete-before
-
-   Before copying any files, delete objects in the destination that
-   are not in the source.
-
-.. option:: -L, --follow-symlinks
-
-   Follow symlinks when dealing with ``file://`` targets.
-
-.. option:: --no-preserve-acls
-
-   Don't preserve ACLs when copying objects.
-
-.. option:: -v, --verbose
-
-   Be verbose.
-
-.. option:: -V, --more-verbose
-
-   Be really, really verbose (developer mode)
-
-.. option:: -x SRC=DST, --xuser SRC=DST
-
-   Set up a user translation. You can specify multiple user
-   translations with multiple ``--xuser`` arguments.
-
-.. option:: --force
-
-   Overwrite all destination objects, even if they appear to be the
-   same as the source objects.
-
-
-Environment variables
-=====================
-
-.. envvar:: SRC_AKEY
-
-   Access key for the source URL
-
-.. envvar:: SRC_SKEY
-
-   Secret access key for the source URL
-
-.. envvar:: DST_AKEY
-
-   Access key for the destination URL
-
-.. envvar:: DST_SKEY
-
-   Secret access key for the destination URL
-
-.. envvar:: AKEY
-
-   Access key for both source and dest
-
-.. envvar:: SKEY
-
-   Secret access key for both source and dest
-
-.. envvar:: DST_CONSISTENCY
-
-   Set to 'eventual' if the destination is eventually consistent. If the destination
-   is eventually consistent, we may have to retry certain operations multiple times.
-
-
-Examples
-========
-
-::
-
-        AKEY=... SKEY=... obsync -c -d -v ./backup-directory s3://myhost1/mybucket1
-
-Copy objects from backup-directory to mybucket1 on myhost1::
-
-        SRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=... obsync -c -d -v s3://myhost1/mybucket1 s3://myhost1/mybucket2
-
-Copy objects from mybucket1 to mybucket2
-
-
-Availability
-============
-
-**obsync** is part of the Ceph distributed file system. Please refer
-to the Ceph wiki at http://ceph.newdream.net/wiki for more
-information.
index 9959eb8a2b4a3f73d8d6f5d80ced457f5cd2f8a9..fcc5487d4023ead29af4cc2afd38ea94d5faec50 100644 (file)
@@ -25,4 +25,4 @@ dist_man_MANS = \
        cephfs.8 \
        ceph-dencoder.8 \
        ceph-rbdnamer.8 \
-       obsync.8
+       obsync.1
diff --git a/man/obsync.1 b/man/obsync.1
new file mode 100644 (file)
index 0000000..dac18f8
--- /dev/null
@@ -0,0 +1,180 @@
+.TH "OBSYNC" "1" "September 22, 2011" "dev" "Ceph"
+.SH NAME
+obsync \- The object synchronizer tool
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.nf
+\fBobsync\fP [ \fIoptions\fP ] \fIsource\-url\fP \fIdestination\-url\fP
+.fi
+.sp
+.SH DESCRIPTION
+.sp
+\fBobsync\fP is an object syncrhonizer tool designed to transfer objects
+between different object storage systems. Similar to rsync, you
+specify a source and a destination, and it will transfer objects
+between them until the destination has all the objects in the
+source. Obsync will never modify the source \-\- only the destination.
+.sp
+By default, obsync does not delete anything. However, by specifying
+\fB\-\-delete\-after\fP or \fB\-\-delete\-before\fP, you can ask it to delete
+objects from the destination that are not in the source.
+.SH TARGET TYPES
+.sp
+Obsync supports S3 via \fBlibboto\fP. To use the s3 target, your URL
+should look like this: \fBs3://host\-name/bucket\-name\fP
+.sp
+Obsync supports storing files locally via the \fBfile://\fP target. To
+use the file target, your URL should look like this:
+\fBfile://directory\-name\fP
+.sp
+Alternately, give no prefix, like this: \fB./directory\-name\fP
+.sp
+Obsync supports storing files in a RADOS Gateway backend via the
+\fBlibrados\fP Python bindings. To use the \fBrgw\(ga target, your URL
+should look like this: \(ga\(gargw:ceph\-configuration\-path:rgw\-bucket\-name\fP
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-h, \-\-help
+Display a help message
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-n, \-\-dry\-run
+Show what would be done, but do not modify the destination.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-c, \-\-create\-dest
+Create the destination if it does not exist.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-delete\-before
+Before copying any files, delete objects in the destination that
+are not in the source.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-L, \-\-follow\-symlinks
+Follow symlinks when dealing with \fBfile://\fP targets.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-no\-preserve\-acls
+Don\(aqt preserve ACLs when copying objects.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-v, \-\-verbose
+Be verbose.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-V, \-\-more\-verbose
+Be really, really verbose (developer mode)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-x SRC=DST, \-\-xuser SRC=DST
+Set up a user translation. You can specify multiple user
+translations with multiple \fB\-\-xuser\fP arguments.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-force
+Overwrite all destination objects, even if they appear to be the
+same as the source objects.
+.UNINDENT
+.SH ENVIRONMENT VARIABLES
+.INDENT 0.0
+.TP
+.B SRC_AKEY
+Access key for the source URL
+.UNINDENT
+.INDENT 0.0
+.TP
+.B SRC_SKEY
+Secret access key for the source URL
+.UNINDENT
+.INDENT 0.0
+.TP
+.B DST_AKEY
+Access key for the destination URL
+.UNINDENT
+.INDENT 0.0
+.TP
+.B DST_SKEY
+Secret access key for the destination URL
+.UNINDENT
+.INDENT 0.0
+.TP
+.B AKEY
+Access key for both source and dest
+.UNINDENT
+.INDENT 0.0
+.TP
+.B SKEY
+Secret access key for both source and dest
+.UNINDENT
+.INDENT 0.0
+.TP
+.B DST_CONSISTENCY
+Set to \(aqeventual\(aq if the destination is eventually consistent. If the destination
+is eventually consistent, we may have to retry certain operations multiple times.
+.UNINDENT
+.SH EXAMPLES
+.sp
+.nf
+.ft C
+AKEY=... SKEY=... obsync \-c \-d \-v ./backup\-directory s3://myhost1/mybucket1
+.ft P
+.fi
+.sp
+Copy objects from backup\-directory to mybucket1 on myhost1:
+.sp
+.nf
+.ft C
+SRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=... obsync \-c \-d \-v s3://myhost1/mybucket1 s3://myhost1/mybucket2
+.ft P
+.fi
+.sp
+Copy objects from mybucket1 to mybucket2
+.SH AVAILABILITY
+.sp
+\fBobsync\fP is part of the Ceph distributed file system. Please refer
+to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
+information.
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\" 
+.
diff --git a/man/obsync.8 b/man/obsync.8
deleted file mode 100644 (file)
index 57b44a0..0000000
+++ /dev/null
@@ -1,180 +0,0 @@
-.TH "OBSYNC" "8" "September 22, 2011" "dev" "Ceph"
-.SH NAME
-obsync \- The object synchronizer tool
-.
-.nr rst2man-indent-level 0
-.
-.de1 rstReportMargin
-\\$1 \\n[an-margin]
-level \\n[rst2man-indent-level]
-level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
--
-\\n[rst2man-indent0]
-\\n[rst2man-indent1]
-\\n[rst2man-indent2]
-..
-.de1 INDENT
-.\" .rstReportMargin pre:
-. RS \\$1
-. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
-. nr rst2man-indent-level +1
-.\" .rstReportMargin post:
-..
-.de UNINDENT
-. RE
-.\" indent \\n[an-margin]
-.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
-.nr rst2man-indent-level -1
-.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
-.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
-..
-.\" Man page generated from reStructeredText.
-.
-.SH SYNOPSIS
-.nf
-\fBobsync\fP [ \fIoptions\fP ] \fIsource\-url\fP \fIdestination\-url\fP
-.fi
-.sp
-.SH DESCRIPTION
-.sp
-\fBobsync\fP is an object syncrhonizer tool designed to transfer objects
-between different object storage systems. Similar to rsync, you
-specify a source and a destination, and it will transfer objects
-between them until the destination has all the objects in the
-source. Obsync will never modify the source \-\- only the destination.
-.sp
-By default, obsync does not delete anything. However, by specifying
-\fB\-\-delete\-after\fP or \fB\-\-delete\-before\fP, you can ask it to delete
-objects from the destination that are not in the source.
-.SH TARGET TYPES
-.sp
-Obsync supports S3 via \fBlibboto\fP. To use the s3 target, your URL
-should look like this: \fBs3://host\-name/bucket\-name\fP
-.sp
-Obsync supports storing files locally via the \fBfile://\fP target. To
-use the file target, your URL should look like this:
-\fBfile://directory\-name\fP
-.sp
-Alternately, give no prefix, like this: \fB./directory\-name\fP
-.sp
-Obsync supports storing files in a RADOS Gateway backend via the
-\fBlibrados\fP Python bindings. To use the \fBrgw\(ga target, your URL
-should look like this: \(ga\(gargw:ceph\-configuration\-path:rgw\-bucket\-name\fP
-.SH OPTIONS
-.INDENT 0.0
-.TP
-.B \-h, \-\-help
-Display a help message
-.UNINDENT
-.INDENT 0.0
-.TP
-.B \-n, \-\-dry\-run
-Show what would be done, but do not modify the destination.
-.UNINDENT
-.INDENT 0.0
-.TP
-.B \-c, \-\-create\-dest
-Create the destination if it does not exist.
-.UNINDENT
-.INDENT 0.0
-.TP
-.B \-\-delete\-before
-Before copying any files, delete objects in the destination that
-are not in the source.
-.UNINDENT
-.INDENT 0.0
-.TP
-.B \-L, \-\-follow\-symlinks
-Follow symlinks when dealing with \fBfile://\fP targets.
-.UNINDENT
-.INDENT 0.0
-.TP
-.B \-\-no\-preserve\-acls
-Don\(aqt preserve ACLs when copying objects.
-.UNINDENT
-.INDENT 0.0
-.TP
-.B \-v, \-\-verbose
-Be verbose.
-.UNINDENT
-.INDENT 0.0
-.TP
-.B \-V, \-\-more\-verbose
-Be really, really verbose (developer mode)
-.UNINDENT
-.INDENT 0.0
-.TP
-.B \-x SRC=DST, \-\-xuser SRC=DST
-Set up a user translation. You can specify multiple user
-translations with multiple \fB\-\-xuser\fP arguments.
-.UNINDENT
-.INDENT 0.0
-.TP
-.B \-\-force
-Overwrite all destination objects, even if they appear to be the
-same as the source objects.
-.UNINDENT
-.SH ENVIRONMENT VARIABLES
-.INDENT 0.0
-.TP
-.B SRC_AKEY
-Access key for the source URL
-.UNINDENT
-.INDENT 0.0
-.TP
-.B SRC_SKEY
-Secret access key for the source URL
-.UNINDENT
-.INDENT 0.0
-.TP
-.B DST_AKEY
-Access key for the destination URL
-.UNINDENT
-.INDENT 0.0
-.TP
-.B DST_SKEY
-Secret access key for the destination URL
-.UNINDENT
-.INDENT 0.0
-.TP
-.B AKEY
-Access key for both source and dest
-.UNINDENT
-.INDENT 0.0
-.TP
-.B SKEY
-Secret access key for both source and dest
-.UNINDENT
-.INDENT 0.0
-.TP
-.B DST_CONSISTENCY
-Set to \(aqeventual\(aq if the destination is eventually consistent. If the destination
-is eventually consistent, we may have to retry certain operations multiple times.
-.UNINDENT
-.SH EXAMPLES
-.sp
-.nf
-.ft C
-AKEY=... SKEY=... obsync \-c \-d \-v ./backup\-directory s3://myhost1/mybucket1
-.ft P
-.fi
-.sp
-Copy objects from backup\-directory to mybucket1 on myhost1:
-.sp
-.nf
-.ft C
-SRC_AKEY=... SRC_SKEY=... DST_AKEY=... DST_SKEY=... obsync \-c \-d \-v s3://myhost1/mybucket1 s3://myhost1/mybucket2
-.ft P
-.fi
-.sp
-Copy objects from mybucket1 to mybucket2
-.SH AVAILABILITY
-.sp
-\fBobsync\fP is part of the Ceph distributed file system. Please refer
-to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
-information.
-.SH COPYRIGHT
-2011, New Dream Network
-.\" Generated by docutils manpage writer.
-.\" 
-.