← Back to branch summary

~ubuntu-branches/ubuntu/wily/davix/wily

« back to all changes in this revision

Viewing changes to doc/man/davix-ls.1

  • Committer: Package Import Robot
  • Author(s): Mattias Ellert
  • Date: 2014-07-08 09:59:36 UTC
  • mfrom: (1.1.3)
  • Revision ID: package-import@ubuntu.com-20140708095936-imto9hahxsnxwvw5
Tags: 0.3.1-1
Update to version 0.3.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/davix-ls.1
 
1
.\" @(#)$RCSfile: davix-ls.man,v $ $Revision: 1 $ $Date: 2014/05/24 $ CERN Adrien Devresse
 
2
.\" Copyright (C) 2014 by CERN
 
3
.\" All rights reserved
 
4
.\"
 
5
.TH DAVIX-LS 1 "$Date: 2014/05/24 $" davix "listing tool"
 
6
.SH NAME
 
7
davix-ls \- Listing tool based on libdavix
 
8
.SH SYNOPSIS
 
9
.PP             
 
10
            davix-ls [options]... url
 
11
.PP     
 
12
                      
 
13
.SH DESCRIPTION
 
14
\fBdavix-ls\fR is a tool to list resources in directories or collection with HTTP, Webdav or REST compatible services.
 
15
.br
 
16
The command supports the WebDav (dav(s)://) and S3 (s3(s)://).
 
17
.br
 
18
.PP     
 
19
davix-ls is powered by libdavix. See libdavix(3) for details.
 
20
 
 
21
.br
 
22
 
 
23
.SH OPTIONS
 
24
.PP
 
25
 
 
26
\fBListing Options:\fR
 
27
.PP
 
28
 
 
29
.RS 2
 
30
\fB\-l --long-list:\fR
 
31
.RE
 
32
.RS 5
 
33
long Listing mode
 
34
.RE
 
35
.PP     
 
36
 
 
37
 
 
38
\fBCommon Options:\fR
 
39
.PP
 
40
.RS 2   
 
41
\fB\--debug\fR
 
42
.RE
 
43
.RS 5
 
44
Debug mode
 
45
.RE
 
46
.PP
 
47
 
 
48
.RS 2   
 
49
\fB\--header, -H\fR
 
50
.RE
 
51
.RS 5
 
52
Add a header field to the request (eg: -H "Depth: 1" )  
 
53
.RE
 
54
.PP
 
55
 
 
56
.RS 2   
 
57
\fB\--help, -h\fR
 
58
.RE
 
59
.RS 5
 
60
Display this help message  
 
61
.RE
 
62
.PP
 
63
 
 
64
.RS 2
 
65
\fB\--module, -P plugin_name\fR
 
66
.RE
 
67
.RS 5
 
68
Load a plugin or profile by name
 
69
.RE
 
70
.PP
 
71
 
 
72
 
 
73
 
 
74
.RS 2
 
75
\fB\--proxy, -x url\fR
 
76
.RE
 
77
.RS 5
 
78
SOCKS5 proxy server URL (ex: socks5://login:pass@socks.example.org)
 
79
.RE
 
80
.PP
 
81
 
 
82
.RS 2   
 
83
\fB\--trace-headers\fR
 
84
.RE
 
85
.RS 5
 
86
Trace all HTTP queries headers  
 
87
.RE
 
88
.PP
 
89
 
 
90
.RS 2
 
91
\fB\--verbose\fR
 
92
.RE
 
93
.RS 5
 
94
Verbose mode 
 
95
.RE
 
96
.PP
 
97
 
 
98
.RS 2
 
99
\fB\--version\fR
 
100
.RE
 
101
.RS 5
 
102
Display version  
 
103
.RE
 
104
.PP
 
105
 
 
106
          
 
107
\fBSecurity Options:\fR
 
108
.PP
 
109
 
 
110
.RS 2
 
111
\fB\--capath CA_path\fR
 
112
.RE
 
113
.RS 5
 
114
Add an additional certificate authority directory  
 
115
.RE
 
116
.PP
 
117
 
 
118
.RS 2
 
119
\fB\--cert, -E cred_path\fR
 
120
.RE
 
121
.RS 5
 
122
Client Certificate in PEM format 
 
123
.RE
 
124
.PP
 
125
 
 
126
.RS 2
 
127
\fB\--key priv_path\fR
 
128
.RE
 
129
.RS 5
 
130
Private key in PEM format  
 
131
.RE
 
132
.PP
 
133
   
 
134
.RS 2
 
135
\fB\--insecure, -k\fR
 
136
.RE
 
137
.RS 5
 
138
Disable SSL credential checks 
 
139
.RE
 
140
.PP
 
141
 
 
142
.RS 2
 
143
\fB\--userlogin\fR
 
144
.RE
 
145
.RS 5
 
146
User login for login/password authentication  
 
147
.RE
 
148
.PP
 
149
 
 
150
.RS 2
 
151
\fB\--userpass\fR
 
152
.RE
 
153
.RS 5
 
154
User password for login/password authentication 
 
155
.RE
 
156
.PP
 
157
    
 
158
.RS 2
 
159
\fB\--s3secretkey\fR
 
160
.RE
 
161
.RS 5
 
162
AWS S3 authentication: secret key
 
163
.RE
 
164
.PP         
 
165
 
 
166
.RS 2
 
167
\fB\--s3accesskey\fR
 
168
.RE
 
169
.RS 5
 
170
AWS S3 authentication: access key 
 
171
.RE
 
172
.PP
 
173
 
 
174
  
 
175
           
 
176
.SH EXAMPLES
 
177
.PP
 
178
\fBWebDav directory file listing
 
179
.BR
 
180
        davix-ls dav://example.org/dir1/dir2/
 
181
.BR
 
182
.PP
 
183
\fBAWS S3 bucket listing
 
184
.BR
 
185
        davix-ls s3://bucket.example.org/collection/
 
186
.BR
 
187
.PP
 
188
\fBLong listing with WebDav with VOMS authentication in a Grid environment
 
189
.BR
 
190
        davix-ls -P grid davs://grid-storage.example.org/dir1/dir2/
 
191
 
 
192
\fBLong listing with WebDav + TLS directory file listing
 
193
.BR
 
194
        davix-ls -l davs://example.org/dir1/dir2/
 
195
.BR
 
196
 
 
197
.SH SEE ALSO
 
198
.BR libdavix(3), davix-get(1), davix-put(1),
 
199
.BR
 
200
 
 
201
.SH LINKS
 
202
.BR http://dmc.web.cern.ch/projects/davix/home
 
203
 
 
204
 
 
205
.SH AUTHORS
 
206
Adrien Devresse <adrien.devresse@cern.ch>, IT-SDC-ID, CERN