-
Notifications
You must be signed in to change notification settings - Fork 23
/
ydcmd.ru.1
299 lines (299 loc) · 12.8 KB
/
ydcmd.ru.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
.TH ydcmd 1 "22 Июля 2014"
.nh
.ad left
.SH НАЗВАНИЕ
ydcmd \- консольный клиент для работы с облачным хранилищем Яндекс.Диск посредством REST API.
.SH СИНТАКСИС
.B ydcmd
.RI [ command ] " " [ options ] " " [ args ]
.SH КОМАНДЫ
.TP
.B help
Получение краткой справки по командам и опциям приложения.
.TP
.B ls
Получение списка файлов и директорий.
.TP
.B rm
Удаление файла или директории.
.TP
.B cp
Копирование файла или директории.
.TP
.B mv
Перемещение файла или директории.
.TP
.B put
Загрузка файла или директории в хранилище.
.TP
.B get
Получение файла или директории из хранилища.
.TP
.B cat
Вывод файла из хранилища в stdout.
.TP
.B mkdir
Создание директории.
.TP
.B stat
Получение метаинформации об объекте.
.TP
.B info
Получение метаинформации о хранилище.
.TP
.B last
Получение метаинформации о последних загруженных файлах.
.TP
.B share
Публикация объекта (получение прямой ссылки).
.TP
.B revoke
Закрытие доступа к опубликованному ранее объекту.
.TP
.B du
Оценка места, занимаемого файлами в хранилище.
.TP
.B clean
Очистка файлов и директорий.
.TP
.B restore
Восстановление файла или директории из корзины.
.TP
.B download
Загрузка файла из интернета в хранилище.
.TP
.B token
Получение OAuth токена для работы приложения.
.SH ОПЦИИ
.TP
.B --config=<S>
Имя файла конфигурации (если отличается от файла по умолчанию).
.TP
.B --timeout=<N>
Таймаут в секундах на установку сетевого соединения.
.TP
.B --retries=<N>
Количество попыток вызова метода api перед возвратом кода ошибки.
.TP
.B --delay=<N>
Таймаут между попытками вызова метода api в секундах.
.TP
.B --limit=<N>
Количество элементов, возвращаемое одним вызовом метода получения списка файлов и директорий.
.TP
.B --token=<S>
OAuth токен (в целях безопасности рекомендуется указывать в конфигурационном файле или через переменную окружения YDCMD_TOKEN). Инструкцию по получению отладочного токена можно найти на странице http://api.yandex.ru/oauth/doc/dg/tasks/get-oauth-token.xml.
.TP
.B --quiet
Подавление вывода об ошибках.
.TP
.B --verbose
Вывод расширенной информации.
.TP
.B --debug
Вывод отладочной информации.
.TP
.B --chunk=<N>
Размер блока данных в КБ для операций ввода/вывода.
.TP
.B --ca-file=<S>
Имя файла с сертификатами доверенных центров сертификации (при пустом значении проверка валидности сертификата не производится).
.TP
.B --ciphers=<S>
Набор алгоритмов шифрования (см. ciphers(1)).
.TP
.B --version
Вывод версии и завершение работы.
.SH ДОПОЛНИТЕЛЬНЫЕ ОПЦИИ
.SS ls
.TP
.B --human
Вывод размера файла в человеко-читаемом виде.
.TP
.B --short
Вывод списка файлов и директорий без дополнительной информации (одно имя в одну строку).
.TP
.B --long
Вывод расширенного списка (время создания, время модификации, размер, имя файла).
.TP
Если целевой объект не указан, то будет использоваться корневая директория хранилища.
.SS rm
.TP
.B --trash
Удаление в корзину.
.TP
.B --poll=<N>
Время в секундах между опросом состояния при выполнении асинхронной операции.
.TP
.B --async
Выполнение команды без ожидания завершения (poll) операции.
.TP
Файлы удаляются без возможности восстановления. Директории удаляются рекурсивно (включая вложенные файлы и директории).
.SS cp
.TP
.B --poll=<N>
Время в секундах между опросом состояния при выполнении асинхронной операции.
.TP
.B --async
Выполнение команды без ожидания завершения (poll) операции.
.TP
В случае совпадения имен, директории и файлы будут перезаписаны. Директории копируются рекурсивно (включая вложенные файлы и директории).
.SS mv
.TP
.B --poll=<N>
Время в секундах между опросом состояния при выполнении асинхронной операции.
.TP
.B --async
Выполнение команды без ожидания завершения (poll) операции.
.TP
В случае совпадения имени, директории и файлы будут перезаписаны.
.SS put
.TP
.B --rsync
Синхронизация дерева файлов и директорий в хранилище с локальным деревом.
.TP
.B --no-recursion
Не загружать содержимое вложенных директорий.
.TP
.B --no-recursion-tag=<S>
Не загружать содержимое вложенных директорий, для директорий содержащих файл.
.TP
.B --exclude-tag=<S>
Пропускать загрузку директорий, содержащих файл.
.TP
.B --skip-hash
Пропускать проверки целостности md5/sha256.
.TP
.B --threads=<N>
Количество рабочих процессов.
.TP
.B --iconv=<S>
При необходимости пытаться восстанавливать имена файлов и директорий из указанной кодировки (например cp1251).
.TP
.B --progress
Выводить прогресс операции (рекомендуется установить модуль python-progressbar).
.TP
Если целевой объект не указан, то для загрузки файла будет использоваться корневая директория хранилища. Если целевой объект указывает на директорию (заканчивается на '/'), то к имени директории будет добавлено имя исходного файла. Если целевой объект существует, то он будет перезаписан без запроса подтверждения. Символические ссылки игнорируются.
.SS get
.TP
.B --rsync
Синхронизация локального дерева файлов и директорий с деревом в хранилище.
.TP
.B --no-recursion
Не загружать содержимое вложенных директорий.
.TP
.B --skip-hash
Пропускать проверки целостности md5/sha256.
.TP
.B --threads=<N>
Количество рабочих процессов.
.TP
.B --progress
Выводить прогресс операции (рекомендуется установить модуль python-progressbar).
.TP
Если не указано имя целевого файла, будет использовано имя файла в хранилище. Если целевой объект существует, то он будет перезаписан без запроса подтверждения.
.SS info
.TP
.B --long
Отображать размеры в байтах вместо человеко-читаемого вида.
.SS last
.TP
.B --human
Вывод размера файла в человеко-читаемом виде.
.TP
.B --short
Вывод списка файлов без дополнительной информации (одно имя в одну строку).
.TP
.B --long
Вывод расширенного списка (время создания, время модификации, размер, имя файла).
.TP
Если параметр N не задан, будет использовано значение по умолчанию из REST API.
.SS du
.TP
.B --depth=<N>
Отображать размеры директорий до уровня N.
.TP
.B --long
Отображать размеры в байтах вместо человеко-читаемого вида.
.TP
Если целевой объект не указан, то будет использоваться корневая директория хранилища.
.SS clean
.TP
.B --dry
Не выполнять удаление, а вывести список объектов для удаления.
.TP
.B --type=<S>
Тип объектов для удаления ('file' - файлы, 'dir' - директории, 'all' - все).
.TP
.B --keep=<S>
Критерий выборки объектов, которые требуется сохранить:
.br
* Для выбора даты до которой требуется удалить данные, можно использовать строку даты в формате ISO (например, '2014-02-12T12:19:05+04:00');
.br
* Для выбора относительного времени, можно использовать число и размерность (например, '7d', '4w', '1m', '1y');
.br
* Для выбора количества копий, можно использовать число без размерности (например, '31').
.SS restore
.TP
.B --poll=<N>
Время в секундах между опросом состояния при выполнении асинхронной операции.
.TP
.B --async
Выполнение команды без ожидания завершения (poll) операции.
.TP
В случае совпадения имен, директории и файлы будут перезаписаны. Директории восстанавливаются рекурсивно (включая вложенные файлы и директории).
.SS download
.TP
.B --poll=<N>
Время в секундах между опросом состояния при выполнении асинхронной операции.
.TP
.B --async
Выполнение команды без ожидания завершения (poll) операции.
.TP
.B --no-redirects
Запрещение редиректов при загрузке.
.TP
Если целевой объект не указан, то будет использоваться корневая директория хранилища, а имя файла будет выбрано исходя из содержимого URL (если это возможно).
.SH КОНФИГУРАЦИЯ
.TP
Для удобства работы рекомендуется создать конфигурационный файл с именем ~/.ydcmd.cfg и установить на него права 0600 или 0400. Формат файла:
.P
.RS
[ydcmd]
.br
# комментарий
.br
<option> = <value>
.RE
.TP
Например:
.P
.RS
[ydcmd]
.br
token = 1234567890
.br
verbose = yes
.br
ca-file = /etc/ssl/certs/ca-certificates.crt
.RE
.SH ПЕРЕМЕННЫЕ ОКРУЖЕНИЯ
.TP
.B YDCMD_TOKEN
OAuth токен. Имеет приоритет перед опцией --token.
.TP
.B SSL_CERT_FILE
Имя файла с сертификатами доверенных центров сертификации. Имеет приоритет перед опцией --ca-file.
.SH КОД ВЫХОДА
.TP
.B 0
Успешное завершение.
.TP
.B 1
Общая ошибка приложения.
.TP
.B 4
Код состояния HTTP-4xx (ошибка клиента).
.TP
.B 5
Код состояния HTTP-5xx (ошибка сервера).