Add dd and rm --exact|--matching documentation

2024-09-05 02:22:05 +03:00
parent 70d6fcd32a
commit d5f7005ddd
3 changed files with 114 additions and 33 deletions
@@ -17,6 +17,7 @@ vitastor-cli - интерфейс командной строки для адм
 - [create](#create)
 - [snap-create](#create)
 - [modify](#modify)
+- [dd](#dd)
 - [rm](#rm)
 - [flatten](#flatten)
 - [rm-data](#rm-data)
@@ -151,23 +152,61 @@ vitastor-cli snap-create [-p|--pool <id|name>] <image>@<snapshot>
 * `-f|--force` - Разрешить уменьшение или перевод в чтение-запись образа, у которого есть клоны.
 * `--down-ok` - Разрешить уменьшение, даже если часть данных останется неудалённой на недоступных OSD.

+## dd
+
+```
+vitastor-cli dd [iimg=<image> | if=<file>] [oimg=<image> | of=<file>] [bs=1M] \
+    [count=N] [seek/oseek=N] [skip/iseek=M] [iodepth=N] [status=progress] \
+    [conv=nocreat,noerror,nofsync,trunc,nosparse] [iflag=direct] [oflag=direct,append]
+```
+
+Копировать данные между образами Vitastor, файлами и каналами.
+
+Опции можно передавать в классическом стиле dd (`key=value`) или как обычно (`--key value`).
+
+| <!-- -->        | <!-- -->                                                                |
+|-----------------|-------------------------------------------------------------------------|
+| `iimg=<image>`  | Копировать из образа Vitastor `<image>`                                 |
+| `if=<file>`     | Копировать из файла `<file>`                                            |
+| `oimg=<image>`  | Копировать в образ Vitastor `<image>`                                   |
+| `of=<file>`     | Копировать в файл `<file>`                                              |
+| `bs=1M`         | Задать размер блока копирования                                         |
+| `count=N`       | Копировать не более N блоков. Если N заканчивается на B - то N байт.    |
+| `seek/oseek=N`  | Пропустить N выходных блоков. Если N заканчивается на B - то N байт.    |
+| `skip/iseek=N`  | Пропустить N входных блоков. Если N заканчивается на B - то N байт.     |
+| `iodepth=N`     | Отправлять N чтений/записей параллельно (по умолчанию 4).               |
+| `status=LEVEL`  | Уровень вывода в консоль: none/noxfer/progress                          |
+| `size=N`        | Задать размер выходного файла/образа (по умолчанию равен размеру входа).|
+| `iflag=direct`  | Только для входного файла: использовать прямой ввод-вывод               |
+| `oflag=direct`  | Только для выходного файла: использовать прямой ввод-вывод              |
+| `oflag=append`  | Только для файлов: дописывать в конец выходного файла                   |
+| `conv=nocreat`  | Не создавать выходной файл/образ                                        |
+| `conv=trunc`    | Обрезать выходной файл/образ до размера входа                           |
+| `conv=noerror`  | Продолжать копирование после ошибок                                     |
+| `conv=nofsync`  | Не вызывать fsync перед завершением                                     |
+| `conv=nosparse` | Записывать все выходные блоки, включая пустые                           |
+
 ## rm

 `vitastor-cli rm <from> [<to>] [--writers-stopped] [--down-ok]`

-Удалить образ `<from>` или все слои от `<from>` до `<to>` (`<to>` должен быть дочерним
-образом `<from>`), одновременно меняя родительские образы их клонов (если таковые есть).
+`vitastor-cli rm (--exact|--matching) <glob> ...`

-`--writers-stopped` позволяет чуть более эффективно удалять образы в частом случае, когда
-у удаляемой цепочки есть только один дочерний образ, содержащий небольшой объём данных.
-В этом случае дочерний образ вливается в родительский и удаляется, а родительский
-переименовывается в дочерний.
+Удалить образ(ы), корректно перебазируя их дочерние образы.

-В других случаях родительские слои вливаются в дочерние.
+В первой форме удаляет один образ `<from>` или все слои между `<from>` и его дочерним `<to>`.

-Другие опции:
+Во второй форме, удаляет все образы с точными именами или именами, подходящими под шаблон(ы).

-* `--down-ok` - Продолжать удаление/слияние, даже если часть данных останется неудалённой на недоступных OSD.
+Опции:
+
+* `--writers-stopped` позволяет чуть более эффективно удалять образы в частом случае, когда
+  у удаляемой цепочки есть только один дочерний образ, содержащий небольшой объём данных.
+  В этом случае дочерний образ вливается в родительский и удаляется, а родительский
+  переименовывается в дочерний.
+* `--exact` - удалить все образы с именами, подходящими под переданные glob-шаблоны.
+* `--matching` - удалить все образы с точно заданными именами.
+* `--down-ok` - продолжать удаление/слияние, даже если часть данных останется неудалённой на недоступных OSD.

 ## flatten