Fix: misc => misc-name

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

diff --git a/docs-ru/command_line.rst b/docs-ru/command_line.rst
index 5f5081a56ecc6558c570c91f907c5dd9ca61fdc1..7a24bbc48981eb9e34ab2dc8dbf9eb217fa082f4 100644 (file)
--- a/docs-ru/command_line.rst
+++ b/docs-ru/command_line.rst
@@ -17,9 +17,80 @@ ml-initdb.py
 ml-import.py
 ------------
 
+Использование::
+
+    ml-import.py [file.inpx ...]
+
 Инициализирует базу данных, импортирует список жанров и список файлов
 INPX, перечисленных в командной строке. При повторных запусках не
 переинициализирует БД и не переимпортирует жанры; так же не
 переимпортирует уже проимпортированные книги, но импортирует в БД новые.
 
+
+ml-search.py
+------------
+
+Использование::
+
+    ml-search.py [-i] [-I] [-t {exact,start,substring}] ...
+
+Программа выполняет поиск по базе данных и показывает список
+результатов. В настоящее время может искать только в списке авторов.
+
+Глобальные опции::
+
+    -i, --ignore-case     независимо от регистра (по умолчанию: угадать)
+    -I, --case-sensitive  с учётом регистра
+    -t, --search-type {exact,start,substring}
+        тип поиска: точный, подстрока в начале (это тип по умолчанию),
+        подстрока в любом месте.
+
+Опции ``-i/-I`` не могут использованы одновременно, поскольку означают
+противоположные команды. В случае, если ни одна из них не использована,
+программа угадывает зависимость от регистра: если все параметры даны в
+нижнем регистре, программы выполнит поиск без учёта регистра. Если среди
+параметров есть параметры в ВЕРХНЕМ или Смешанном регистре - поиск будет
+с учётом регистра.
+
+Опция ``-t/--search-type`` определяет тип поиска. Возможные значения:
+
+* exact - поиск на точное совпадение; поиск "друг" найдёт только "друг",
+  но не "другой";
+* start - поиск подстроки в начале поля; поиск "друг" найдёт "друг" и
+  "другой", но не "подруга"; это тип по умолчанию;
+* substring - поиск подстроки в любом месте; поиск "друг" найдёт "друг",
+  "другой" и "подруга".
+
+
+Поиск авторов
+^^^^^^^^^^^^^
+
+Использование::
+
+    ml-search.py [-i] [-I] [-t ...] author [-s surname] [-n name] [-m misc-name]
+
+Искать и печатать список авторов по фамилии, имени и доп. имени (обычно
+отчеству).
+
+Опции::
+
+    -s, --surname фамилия       Искать по фамилии
+    -n, --name имя              Искать по имени
+    -m, --misc-name доп. имени  Искать по доп. имени
+
+Пример::
+
+    ml-search.py -i author -s друг
+
+Искать и печатать список авторов, чья фамилия начинается на "друг", без
+учёта регистра.
+
+Если использовать несколько опций, поиск будет сужен оператором "И".
+Пример::
+
+    ml-search.py -i author -s друг -n в
+
+Искать и печатать список авторов, чья фамилия начинается на "друг" и имя
+начинается на "в", без учёта регистра.
+
 .. vim: set tw=72 :