← Back to branch summary

~verterok/ubuntuone-client/fix-435137

« back to all changes in this revision

Viewing changes to docs/man/u1sdtool.1

  • Committer: Rodney Dawes
  • Date: 2009-05-12 13:36:05 UTC
  • Revision ID: rodney.dawes@canonical.com-20090512133605-6aqs6e8xnnmp5u1p
        Import the code
        Hook up lint/trial tests in setup.py
        Use icontool now instead of including the render script
        Add missing python-gnome2-desktop to package dependencies
        Update debian/rules to fix the icon cache issue

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/u1sdtool.1
 
1
.TH SDTOOL 1
 
2
.SH NAME
 
3
u1sdtool \- command line utility for controlling ubuntuone-syncdaemon
 
4
.SH SYNOPSYS
 
5
.B u1sdtool
 
6
[\fIOPTION\fR]... [\fIARGS\fR]
 
7
.br
 
8
.B u1sdtool
 
9
\-\-wait       
 
10
.br
 
11
.B u1sdtool
 
12
\-\-accept-share=SHARE_ID
 
13
.br
 
14
.B u1sdtool
 
15
\-\-reject-share=SHARE_ID
 
16
.br
 
17
.B u1sdtool
 
18
\-\-list-shares
 
19
.br
 
20
.B u1sdtool
 
21
\-\-refresh-shares
 
22
.br
 
23
.B u1sdtool
 
24
\-\-offer-share PATH USER SHARE_NAME ACCESS_LEVEL
 
25
.br
 
26
.B u1sdtool
 
27
\-\-list-shared
 
28
.br
 
29
.B u1sdtool
 
30
\-\-refresh=PATH
 
31
.br
 
32
.B u1sdtool
 
33
\-\-info=PATH
 
34
 
 
35
.SH DESCRIPTION
 
36
u1sdtool is a command line command line utility for controlling 
 
37
ubuntuone-syncdaemon.
 
38
It can be used to get information about the metadata of ubuntuone-syncdaemon 
 
39
but also to create shares, accept or reject offered shares, to force a 
 
40
refresh the list of shares and force a refresh of a specific path in order 
 
41
to get the latest information from the server.
 
42
.PP
 
43
.SH OPTIONS
 
44
.TP
 
45
\fB\-\-wait\fR
 
46
Wait until SyncDaemon reachs nirvana
 
47
.TP
 
48
\fB\-\-accept-share\fR=\fISHARE_ID\fR
 
49
accept the share with the specified id
 
50
.RS
 
51
.TP
 
52
.I SHARE_ID
 
53
the share id, as returned by \-\-list-shares
 
54
.RE
 
55
.TP
 
56
\fB\-\-reject-share\fR=\fISHARE_ID\fR
 
57
reject the share with the specified id
 
58
.RS
 
59
.TP
 
60
.I SHARE_ID
 
61
the share id, as returned by \-\-list-shares
 
62
.RE
 
63
.TP
 
64
\fB\-\-list-shares\fR
 
65
get the list of shares
 
66
.TP
 
67
\fB\-\-refresh-shares\fR
 
68
request a refresh of the list of shares to the server
 
69
.TP
 
70
\fB\-\-offer-share\fR=\fIPATH\fR \fIUSER\fR \fISHARE_NAME\fR \fIACCESS_LEVEL\fR
 
71
share PATH to USER.
 
72
.RS
 
73
.TP
 
74
.I PATH
 
75
A path of a directory or file managed by ubuntuone-syncdaemon (can't be a path inside a Share)
 
76
.TP
 
77
.I USER
 
78
the (short) username, that this share is going to be offered
 
79
.TP
 
80
.I SHARE_NAME
 
81
the share name, as it's going to be offered to USER
 
82
.TP
 
83
.I ACCESS_LEVEL
 
84
the acces level of USER to this share, can be: "View" or "Modify"
 
85
.RE
 
86
.TP
 
87
\fB\-\-list-shared\fR
 
88
list the shared path's/shares offered.
 
89
.TP
 
90
\fB\-\-refresh\fR=\fIPATH\fR
 
91
request a refresh of PATH
 
92
.RS
 
93
.TP
 
94
.I PATH
 
95
A path of a directory or file managed by ubuntuone-syncdaemon
 
96
.RE
 
97
.TP
 
98
\fB\-\-info\fR=\fIPATH\fR
 
99
request the metadata of PATH
 
100
.RS
 
101
.TP
 
102
.I PATH
 
103
A path of a directory or file managed by ubuntuone-syncdaemon
 
104
.RE
 
105
.SH AUTHOR
 
106
This manual page was written by Guillermo Gonzalez <guillermo.gonzalez@canonical.com>.
 
107