From: Oleg Broytman <phd@phdru.name>
Date: Mon, 2 May 2016 16:06:04 +0000 (+0300)
Subject: Document author search
X-Git-Tag: 0.0.4~12
X-Git-Url: https://git.phdru.name/?a=commitdiff_plain;h=3deac69630a6e95493973ea34c3770350b480db4;p=m_librarian.git

Document author search
---

diff --git a/docs-ru/command_line.rst b/docs-ru/command_line.rst
index 6d75df3..c29098d 100644
--- a/docs-ru/command_line.rst
+++ b/docs-ru/command_line.rst
@@ -61,4 +61,36 @@ ml-search.py
 * substring - поиск подстроки в любом месте; поиск "друг" найдёт "друг",
   "другой" и "подруга".
 
+
+Поиск авторов
+^^^^^^^^^^^^^
+
+Использование::
+
+    ml-search.py [-i] [-I] [-t ...] author [-s surname] [-n name] [-m misc]
+
+Искать и печатать список авторов по фамилии, имени и доп. имени (обычно
+отчеству).
+
+Опции::
+
+    -s, --surname фамилия  Искать по фамилии
+    -n, --name имя         Искать по имени
+    -m, --misc доп. имени  Искать по доп. имени
+
+Пример::
+
+    ml-search.py -i author -s друг
+
+Искать и печатать список авторов, чья фамилия начинается на "друг", без
+учёта регистра.
+
+Если использовать несколько опций, поиск будет сужен оператором "И".
+Пример::
+
+    ml-search.py -i author -s друг -n в
+
+Искать и печатать список авторов, чья фамилия начинается на "друг" и имя
+начинается на "в", без учёта регистра.
+
 .. vim: set tw=72 :
diff --git a/docs/command_line.rst b/docs/command_line.rst
index f3f2f58..3542054 100644
--- a/docs/command_line.rst
+++ b/docs/command_line.rst
@@ -60,4 +60,35 @@ Option ``-t/--search-type`` defines the search type. Search types are:
 * substring - search for any substring; "duck" => "duck", "duckling",
   "McDuck" (except for case-sensitive search, of course).
 
+
+Author search
+^^^^^^^^^^^^^
+
+Usage::
+
+    ml-search.py [-i] [-I] [-t ...] author [-s surname] [-n name] [-m misc]
+
+Search and print a list of authors by surname/name/misc name.
+
+Options::
+
+    -s, --surname surname  Search by surname
+    -n, --name name        Search by name
+    -m, --misc misc. name  Search by misc. name
+
+Example::
+
+    ml-search.py -i author -s duck
+
+Search and print a list of authors whose surname starts with "duck",
+case insensitive.
+
+If a few options are given the search is limited with operator AND.
+Example::
+
+    ml-search.py -i author -s duck -n mack
+
+Search and print a list of authors whose surname starts with "duck", and
+name starts with "mack", case insensitive.
+
 .. vim: set tw=72 :