]> git.phdru.name Git - m_librarian.git/blobdiff - docs-ru/command_line.rst
Allow to set download format
[m_librarian.git] / docs-ru / command_line.rst
index 5bb369960fad4daffec8b85a68ca41655093c4f0..872ef5c9d1ebf16b02a51f960a5e9e69273b7a97 100644 (file)
 ml-initdb.py
 ------------
 
+Использование::
+
+    ml-initdb.py [-d]
+
+Опции::
+
+    -d, --database database  Использовать указанную БД
+
 Инициализирует базу данных и импортирует список жанров. Этот скрипт не
 очень-то нужен, так как следующий скрипт делает всё указанное.
 
@@ -19,7 +27,11 @@ ml-import.py
 
 Использование::
 
-    ml-import.py [file.inpx ...]
+    ml-import.py [-d] [file.inpx ...]
+
+Опции::
+
+    -d, --database database  Использовать указанную БД
 
 Инициализирует базу данных, импортирует список жанров и список файлов
 INPX, перечисленных в командной строке. При повторных запусках не
@@ -32,24 +44,25 @@ ml-search.py
 
 Использование::
 
-    ml-search.py [-i] [-I] [-t] [-s] [-f] [-d] [-c] ...
+    ml-search.py [-d] [-i] [-I] [-t] [-s] [-f] [-v] [-c] ...
 
 Программа выполняет поиск по базе данных и показывает список
 результатов. В настоящее время может искать только в списке авторов.
 
 Глобальные опции::
 
-    -i, --ignore-case     независимо от регистра (по умолчанию: угадать)
-    -I, --case-sensitive  с учётом регистра
-    -t, --start           тип поиска: подстрока в начале строки
-                          (это тип поиска по умолчанию)
-    -s, --substring       тип поиска: подстрока в любом месте
-    -f, --full            тип поиска: полное совпадение всей строки
-    -d, --details         Выводить больше информации о найденных
-                          объектах; повторите эту опцию несколько раз,
-                          чтобы получить ещё больше деталей
-    -c, --count           Выводить число найденных объектов, а не сами
-                          объекты
+    -d, --database database  Использовать указанную БД
+    -i, --ignore-case        независимо от регистра (по умолчанию: угадать)
+    -I, --case-sensitive     с учётом регистра
+    -t, --start              тип поиска: подстрока в начале строки
+                             (это тип поиска по умолчанию)
+    -s, --substring          тип поиска: подстрока в любом месте
+    -f, --full               тип поиска: полное совпадение всей строки
+    -c, --count              Выводить число найденных объектов, а не сами
+                             объекты
+    -v, --verbose            Выводить больше информации о найденных
+                             объектах; повторите эту опцию несколько раз,
+                             чтобы получить ещё больше деталей
 
 Опции ``-i/-I`` не могут использованы одновременно, поскольку означают
 противоположные команды. В случае, если ни одна из них не использована,
@@ -73,7 +86,7 @@ ml-search.py
 
 Использование::
 
-    ml-search.py [-i/-I] [-t/-s/-f] author [-s surname] [-n name] [-m misc-name] [--id id] [fullname]
+    ml-search.py author [-s surname] [-n name] [-m misc-name] [--id id] [fullname]
 
 Искать и печатать список авторов по фамилии, имени, доп. имени (обычно
 отчеству) или полному имени.
@@ -100,15 +113,15 @@ ml-search.py
 Искать и печатать список авторов, чья фамилия начинается на "друг" и имя
 начинается на "в", без учёта регистра.
 
-При использовании опции `-d` также выводится id из БД.
+При использовании опции `-v` также выводится id из БД.
 
 
-Поиск книг
-^^^^^^^^^^
+п÷п╬п╦я│п╨ п╦ п╥п╟пЁя─я┐п╥п╨п╟ п╨п╫п╦пЁ
+^^^^^^^^^^^^^^^^^^^^^
 
 Использование::
 
-    ml-search.py [-i/-I] [-t/-s/-f] 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] [--get] [--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]
 
 Искать и печатать список книг по заголовку, серии, архиву, имени файла.
 
@@ -118,6 +131,8 @@ ml-search.py
     -s, --series серия     Искать по серии
     -a, --archive архив    Искать по имени архива (zip-файла)
     -f, --file файл        Искать по имени файла (без расширения)
+    -p, --path path        Путь к директории с архивами библиотеки
+    --get                  Загрузить ровно один файл
     --id id                Искать по id книги
     --surname surname      Искать по фамилии автора
     --name name            Искать по имени автора
@@ -133,20 +148,59 @@ ml-search.py
     --lid lid              Искать по id языка
 
 По умолчанию программы выводит список заголовков найденных книг. При
-использовании опции `-d` также выводится id из БД, список авторов и
+использовании опции `-v` также выводится id из БД, список авторов и
 жанров, а также серия, к которой принадлежит книга (если принадлежит) и
-порядковый номер книги в этой серии. С двумя опциями `-d` (`-d -d` или
-просто `-dd`) программа выводит дату файла и язык. С тремя `-d`
+порядковый номер книги в этой серии. С двумя опциями `-v` (`-v -v` или
+просто `-vv`) программа выводит дату файла и язык. С тремя `-v`
 выводятся имя архива, имя файла, расширение и размер файла, и признак,
 была ли книга помечена как удалённая.
 
+Опция `-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`.
+
 
 Поиск расширений
 ^^^^^^^^^^^^^^^^
 
 Использование::
 
-    ml-search.py [-i/-I] [-t/-s/-f] ext [name] [--id id]
+    ml-search.py ext [name] [--id id]
 
 Опции::
 
@@ -154,7 +208,7 @@ ml-search.py
 
 Искать и печатать список расширений имён файлов по имени.
 
-При использовании опции `-d` также выводится id из БД.
+При использовании опции `-v` также выводится id из БД.
 
 
 Поиск жанров
@@ -162,7 +216,7 @@ ml-search.py
 
 Использование::
 
-    ml-search.py [-i/-I] [-t/-s/-f] genres [-n name] [-t title] [--id id]
+    ml-search.py genres [-n name] [-t title] [--id id]
 
 Искать и печатать список жанров по имени и заголовку.
 
@@ -172,7 +226,7 @@ ml-search.py
     -t, --title заголовок  Искать по заголовку
     --id id                Искать по id жанра
 
-При использовании опции `-d` также выводится id из БД.
+При использовании опции `-v` также выводится id из БД.
 
 
 Поиск языков
@@ -180,7 +234,7 @@ ml-search.py
 
 Использование::
 
-    ml-search.py [-i/-I] [-t/-s/-f] lang [name] [--id id]
+    ml-search.py lang [name] [--id id]
 
 Опции::
 
@@ -188,6 +242,6 @@ ml-search.py
 
 Искать и печатать список языков по имени.
 
-При использовании опции `-d` также выводится id из БД.
+При использовании опции `-v` также выводится id из БД.
 
 .. vim: set tw=72 :