~didrocks/ubuntuone-client/use_result_var

« back to all changes in this revision

Viewing changes to docs/man/u1sync.1

  • Committer: Bazaar Package Importer
  • Author(s): Rodney Dawes
  • Date: 2011-02-11 16:18:11 UTC
  • mto: This revision was merged to the branch mainline in revision 67.
  • Revision ID: james.westby@ubuntu.com-20110211161811-n18dj9lde7dxqjzr
Tags: upstream-1.5.4
ImportĀ upstreamĀ versionĀ 1.5.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH U1SYNC 1
2
 
.SH NAME
3
 
u1sync - locally mirror an Ubuntu One share or storage volume
4
 
.SH SYNOPSYS
5
 
.B u1sync
6
 
[\fIOPTION\fR]... [\fIDIRECTORY\fR]
7
 
.br
8
 
.B u1sync
9
 
\-\-authorize [\fIOPTION\fR]...
10
 
.br
11
 
.B u1sync
12
 
\-\-list\-shares [\fIOPTION\fR]...
13
 
.br
14
 
.B u1sync
15
 
\-\-init [\fI\-\-share=SHARE_UUID\fR] [\fI\-\-subtree=PATH\fR]
16
 
[\fIOPTION\fR]... \fIDIRECTORY\fR
17
 
.br
18
 
.B u1sync
19
 
\-\-diff [\fI\-\-share=SHARE_UUID\fR] [\fI\-\-subtree=PATH\fR]
20
 
[\fIOPTION\fR]... \fIDIRECTORY\fR
21
 
 
22
 
.SH DESCRIPTION
23
 
u1sync synchronizes a local directory with the Ubuntu One storage
24
 
service.  It can also be used to authorize a new machine for use with
25
 
Ubuntu One or compare the contents of a local directory with contents
26
 
stored in the storage service.
27
 
.PP
28
 
To initialize a directory for use as a mirror of your Ubuntu One
29
 
Storage volume, use the \-\-init option and supply the name of the
30
 
directory to initialize as a mirror.  The directory will be created if it
31
 
doesn't already exist.  u1sync operates separately from the Ubuntu One
32
 
synchronization daemon and shouldn't normally be used with directories
33
 
under "$HOME/Ubuntu One" (although \-\-diff is always safe).
34
 
.PP
35
 
Once the directory has been initialized, running u1sync within it (or
36
 
by supplying the directory as an argument) will bring the mirror
37
 
up to date.  Subsequent changes will not be propagated until u1sync is
38
 
run again.  By default, synchronization is bidirectional, applying local
39
 
changes to the server and server-side changes to the local mirror,
40
 
although different behavior can be selected using \-\-action.
41
 
.PP
42
 
In addition to "My Files", u1sync can also manage local mirrors of shares
43
 
which have been offered to you by other users.  You can use the
44
 
\-\-list\-shares option to see the shares currently available to you, and
45
 
the \-\-share option can be used with \-\-init to initialize a directory as
46
 
a mirror of a particular share rather than your personal storage.
47
 
.PP
48
 
If your machine is not authorized with Ubuntu One, you can authorize it
49
 
by calling u1sync with the \-\-authorize option.  It will open a browser
50
 
window to conduct the authorization process using your Launchpad credentials
51
 
and store the resulting token in the gnome keyring.
52
 
.SH OPTIONS
53
 
.TP
54
 
\fB\-\-action\fR=\fIACTION\fR
55
 
selects the synchronization action to use; ACTION may be one of:
56
 
.RS
57
 
.TP
58
 
.I upload
59
 
apply local changes to the server (preserving non-conflicting server-side changes)
60
 
.TP
61
 
.I download
62
 
apply server-side changes to the local mirror (preserving non-conflicting local changes)
63
 
.TP
64
 
.I sync
65
 
perform a bi-directional sync
66
 
.TP
67
 
.I clobber\-local
68
 
make the local mirror match what is on the server
69
 
.TP
70
 
.I clobber\-server
71
 
make the server match what is in the local mirror
72
 
.TP
73
 
.I auto
74
 
the default; \fIdownload\fR from read-only shares, otherwise \fIsync\fR
75
 
.RE
76
 
.TP
77
 
\fB\-\-authorize\fR
78
 
authorizes your machine for use with Ubuntu One
79
 
.TP
80
 
\fB\-\-diff\fR
81
 
shows the differences between the contents of a directory and
82
 
your Ubuntu One storage (the directory doesn't need to be an
83
 
initialized mirror)
84
 
.TP
85
 
\fB\-\-dry\-run\fR
86
 
go through the motions but don't actually modify anything
87
 
.TP
88
 
\fB\-\-init\fR
89
 
initializes the provided directory for use as a mirror
90
 
.TP
91
 
\fB\-h\fR, \fB\-\-help\fR
92
 
displays a brief help message summarizing usage and options
93
 
.TP
94
 
\fB\-\-host\fR=\fIHOST\fR
95
 
connects to the specified hostname rather than the default API service
96
 
.TP
97
 
\fB\-\-list\-shares\fR
98
 
lists available shares
99
 
.TP
100
 
\fB\-\-oauth\fR=\fIKEY\fR:\fISECRET\fR
101
 
explicitly specify an OAuth token to use rather than querying the keyring
102
 
.TP
103
 
\fB\-\-port\fR=\fIPORT\fR
104
 
specify a non-default port to connect to
105
 
.TP
106
 
\fB\-\-quiet\fR
107
 
produce less output
108
 
.TP
109
 
\fB\-\-share\fR=\fISHARE_UUID\fR
110
 
specify a share to mirror (instead of "My Files"); share UUIDs can be
111
 
obtained from \-\-list\-shares
112
 
.TP
113
 
\fB\-\-subtree\fR=\fIPATH\fR
114
 
used with \-\-init to set up a mirror of subtree rather than the
115
 
entirety of your personal storage (or the specified share); can also
116
 
be used with \-\-diff to compare the local directory against a subtree
117
 
.SH TIPS AND TRICKS
118
 
You can use u1sync's \-\-diff mode to see which files in your personal
119
 
storage the Ubuntu One synchronization daemon has yet to synchronize:
120
 
.PP
121
 
u1sync \-\-diff ~/Ubuntu\\ One/My\\ Files
122
 
.PP
123
 
You can also check the status of files in shares in a similar fashion if
124
 
you know the share's UUID (which you can obtain via \-\-list\-shares):
125
 
.PP
126
 
u1sync \-\-diff \-\-share=a4f57216\-6086\-45b6\-be26\-694e76ffa2f0 ~/Ubuntu\\ One/Shared\\ With\\ Me/awesome
127
 
.PP
128
 
u1sync \-\-authorize can be used to re-authorize a machine whose
129
 
authorization token has expired; it will replace the expired token in
130
 
your keyring with a new one.
131
 
.SH AUTHOR
132
 
This manual page was written by Tim Cole <tim.cole@canonical.com>.