Skip to content

Commit

Permalink
obsync: improve formatting a little bit
Browse files Browse the repository at this point in the history
Signed-off-by: Colin McCabe <[email protected]>
  • Loading branch information
cmccabe committed Jul 1, 2011
1 parent da917ad commit 924a322
Showing 1 changed file with 33 additions and 9 deletions.
42 changes: 33 additions & 9 deletions man/obsync.8
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
.SH NAME
obsync \- The object synchronizer tool
.SH SYNOPSIS
.B obsync [ \fIoptions\fP ] \fIsource\fP \fIdestination\fP
.B obsync [ \fIoptions\fP ] <\fIsource-url\fP> <\fIdestination-url\fP>

.SH DESCRIPTION
.B obsync
Obsync is an object syncrhonizer tool designed to transfer objects between
is an object syncrhonizer tool designed to transfer objects between
different object storage systems. Similar to rsync, you specify a source and a
deestination, 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
Expand All @@ -33,52 +33,76 @@ To use the rgw target, your URL should look like this:
rgw:\fIceph-configuration-path\fP:\fIrgw-bucket-name\fP

.SH OPTIONS
.TP
\fB\-h\fP | \fB\-\-help\fP
Display a help message

.TP
\fB\-n\fP | \fB\-\-dry-run\fP
Show what would be done, but do not modify the destination.

.TP
\fB\-c\fP | \fB\-\-create-dest\fP
Create the destination if it does not exist.

.TP
\fB\-\-delete-before\fP
Before copying any files, delete objects in the destination that are not in the source.

.TP
\fB\-L\fP | \fB\-\-follow-symlinks\fP
Follow symlinks when dealing with \fIfile://\fP targets.

.TP
\fB\-\-no-preserve-acls\fP
Don't preserve ACLs when copying objects.

.TP
\fB\-v\fP | \fB\-\-verbose\fP
Be verbose.

.TP
\fB\-V\fP | \fB\-\-more-verbose\fP
Be really, really verbose (developer mode)

.TP
\fB\-x\fP \fBSRC\fP=\fBDST\fP | \fB\-\-xuser\fP \fBSRC\fP=\fBDST\fP
Set up a user translation. You can specify multiple user translations with
multiple \fB--xuser\fP arguments.

.TP
\fB\-\-force\fP
Overwrite all destination objects, even if they appear to be the same as the
source objects.

.SH ENVIRONMENT VARIABLES
\fBSRC_AKEY\fP Access key for the source URL
.TP
\fBSRC_AKEY\fP
Access key for the source URL

\fBSRC_SKEY\fP Secret access key for the source URL
.TP
\fBSRC_SKEY\fP
Secret access key for the source URL

\fBDST_AKEY\fP Access key for the destination URL
.TP
\fBDST_AKEY\fP
Access key for the destination URL

\fBDST_SKEY\fP Secret access key for the destination URL
.TP
\fBDST_SKEY\fP
Secret access key for the destination URL

\fBAKEY\fP Access key for both source and dest
.TP
\fBAKEY\fP
Access key for both source and dest

\fBSKEY\fP Secret access key for both source and dest
.TP
\fBSKEY\fP
Secret access key for both source and dest

\fBDST_CONSISTENCY\fP Set to 'eventual' if the destination is eventually consistent.
.TP
\fBDST_CONSISTENCY\fP
Set to 'eventual' if the destination is eventually consistent.
If the destination is eventually consistent, we may have to retry certain operations
multiple times.

Expand Down

0 comments on commit 924a322

Please sign in to comment.