Pass format of the downloaded file name in the command line

[m_librarian.git] / docs-ru / command_line.rst

diff --git a/docs-ru/command_line.rst b/docs-ru/command_line.rst
index 185505d25a327d55023bbddfd05f8cd68f85eb29..8bf74c88692ed5ba8d4fce1a463c88f17b4aa59d 100644 (file)
--- a/docs-ru/command_line.rst
+++ b/docs-ru/command_line.rst
@@ -116,12 +116,12 @@ ml-search.py
 При использовании опции `-v` также выводится id из БД.
 
 
-Поиск книг
-^^^^^^^^^^
+п÷п╬п╦я│п╨ п╦ п╥п╟пЁя─я┐п╥п╨п╟ п╨п╫п╦пЁ
+^^^^^^^^^^^^^^^^^^^^^
 
 Использование::
 
-    ml-search.py books [-t title] [-s series] [-a archive] [-f file] [--id id] [--surname name] [--name name] [--misc-name name] [--fullname name] [--aid aid] [-e ext] [--eid eid] [--gname name] [--gtitle title] [--gid gid] [-l lang] [--lid lid]
+    ml-search.py books [-t title] [-s series] [-a archive] [-f file] [-p path] [--format f] [--get] [--get-many N] [--id id] [--surname name] [--name name] [--misc-name name] [--fullname name] [--aid aid] [-e ext] [--eid eid] [--gname name] [--gtitle title] [--gid gid] [-l lang] [--lid lid]
 
 Искать и печатать список книг по заголовку, серии, архиву, имени файла.
 
@@ -131,6 +131,10 @@ ml-search.py
     -s, --series серия     Искать по серии
     -a, --archive архив    Искать по имени архива (zip-файла)
     -f, --file файл        Искать по имени файла (без расширения)
+    -p, --path path        Путь к директории с архивами библиотеки
+    --format format        Формат имени сохраняемого файла
+    --get                  Загрузить ровно один файл
+    --get-many N           Загрузить не больше указанного числа файлов
     --id id                Искать по id книги
     --surname surname      Искать по фамилии автора
     --name name            Искать по имени автора
@@ -153,6 +157,51 @@ ml-search.py
 выводятся имя архива, имя файла, расширение и размер файла, и признак,
 была ли книга помечена как удалённая.
 
+Опция `-p` задаёт путь к директории с архивами библиотеки. По умолчанию
+этот путь берётся из файла конфигурации `m_librarian`, секция
+`[library]`, ключ `path`, например::
+
+    [library]
+    path = /var/lib/archives
+
+Опция полезна в ситуации работы с несколькими базами данных (глобальная
+опция `-d`).
+
+Опция `--get` позволяет загрузить книгу из библиотеки в файл. Опция
+позволяет загрузить ровно одну книгу, поэтому самый простой способ
+использовать эту команду — совместно с опцией `--id`. Файл сохраняется в
+текущую директорию с тем именем, под которым он храниться в библиотеке.
+
+Ключ `format` в секции `[download]` файла конфигурации m_librarian.conf
+
+|    [download]
+|    format = %a/%s/%n %t
+
+позволяет управлять именами директорий и именем файла, куда m_Librarian
+будет сохранять файлы. Формат по умолчанию `%f`, т.е. просто имя файла.
+Другие доступные спецификаторы::
+
+    %a - автор (один из, если их несколько)
+    %e - расширение имени файла
+    %f - имя файла
+    %G - жанр (один из, если их несколько), имя из БД
+    %g - жанр (один из, если их несколько), название
+    %l - язык
+    %n - номер в серии (или 0)
+    %s - серия
+    %t - название
+
+Формат не должен заканчиваться на разделитель директорий (`/` или `\\`).
+Если спецификатор `%e` (расширение) не найден в формате, он добавляется
+в конец с точкой в качестве разделителя. Т.о. формат `%f` эквивалентен
+формату `%f.%e`.
+
+Опция `--format format` позволяет указать формат в командной строке.
+
+Опция `--get-many N` позволяет загрузить указанное число книг (не больше
+чем N, где N — целое число.) Опции `--get-many N` и `--get` взаимно
+исключают друг друга и не должны использоваться одновременно.
+
 
 Поиск расширений
 ^^^^^^^^^^^^^^^^