]> git.phdru.name Git - m_librarian.git/blobdiff - docs-ru/command_line.rst
Docs: Document the second ml-web.py detects the first
[m_librarian.git] / docs-ru / command_line.rst
index 8bf74c88692ed5ba8d4fce1a463c88f17b4aa59d..5ce2389a0c64747194e6e01a595f5334a6ff44dc 100644 (file)
@@ -6,17 +6,19 @@
 .. contents::
    :local:
 
+.. highlight:: none
 
 ml-initdb.py
 ------------
 
 Использование::
 
-    ml-initdb.py [-d]
+    ml-initdb.py [-C] [-D]
 
 Опции::
 
-    -d, --database database  Использовать указанную БД
+    -C, --config config      Путь к файлу конфигурации
+    -D, --database database  Использовать указанную БД
 
 Инициализирует базу данных и импортирует список жанров. Этот скрипт не
 очень-то нужен, так как следующий скрипт делает всё указанное.
@@ -27,11 +29,13 @@ ml-import.py
 
 Использование::
 
-    ml-import.py [-d] [file.inpx ...]
+    ml-import.py [-C] [-D] [-P] [file.inpx ...]
 
 Опции::
 
-    -d, --database database  Использовать указанную БД
+    -C, --config config      Путь к файлу конфигурации
+    -D, --database database  Использовать указанную БД
+    -P, --no-pbar            Не показывать индикатор процесса
 
 Инициализирует базу данных, импортирует список жанров и список файлов
 INPX, перечисленных в командной строке. При повторных запусках не
@@ -44,14 +48,15 @@ ml-search.py
 
 Использование::
 
-    ml-search.py [-d] [-i] [-I] [-t] [-s] [-f] [-v] [-c] ...
+    ml-search.py [-C] [-D] [-i] [-I] [-t] [-s] [-f] [-v] [-c] ...
 
 Программа выполняет поиск по базе данных и показывает список
 результатов. В настоящее время может искать только в списке авторов.
 
 Глобальные опции::
 
-    -d, --database database  Использовать указанную БД
+    -C, --config config      Путь к файлу конфигурации
+    -D, --database database  Использовать указанную БД
     -i, --ignore-case        независимо от регистра (по умолчанию: угадать)
     -I, --case-sensitive     с учётом регистра
     -t, --start              тип поиска: подстрока в начале строки
@@ -121,7 +126,7 @@ ml-search.py
 
 Использование::
 
-    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]
+    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] [-P path] [-F format] [--get] [--get-many N]
 
 Искать и печатать список книг по заголовку, серии, архиву, имени файла.
 
@@ -131,10 +136,6 @@ 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            Искать по имени автора
@@ -148,6 +149,11 @@ ml-search.py
     --gid gid              Искать по id жанра
     -l, --lang lang        Искать по языку
     --lid lid              Искать по id языка
+    -P, --path path        Путь к директории с архивами библиотеки
+    --download-to [path]   Путь к директории для сохранения книг
+    -F, --format format    Формат имени сохраняемого файла
+    --get                  Загрузить ровно один файл
+    --get-many N           Загрузить не больше указанного числа файлов
 
 По умолчанию программы выводит список заголовков найденных книг. При
 использовании опции `-v` также выводится id из БД, список авторов и
@@ -157,22 +163,30 @@ ml-search.py
 выводятся имя архива, имя файла, расширение и размер файла, и признак,
 была ли книга помечена как удалённая.
 
-Опция `-p` задаёт путь к директории с архивами библиотеки. По умолчанию
-этот путь берётся из файла конфигурации `m_librarian`, секция
-`[library]`, ключ `path`, например::
+Опция `-P` задаёт путь к директории с архивами библиотеки. По умолчанию
+этот путь берётся из файла конфигурации, секция `[library]`, ключ
+`path`, например::
 
     [library]
     path = /var/lib/archives
 
 Опция полезна в ситуации работы с несколькими базами данных (глобальная
-опция `-d`).
+опция `-D`).
+
+Опция `--download-to` задаёт путь к директории для сохранения книг.
+По умолчанию скрипт сохраняет книги в текущую директорию.
+Если опция используется без указания аргумента `path` скрипт использует
+значение из файла конфигурации, секция `[download]`, ключ `path`::
+
+    [download]
+    path = /tmp
 
 Опция `--get` позволяет загрузить книгу из библиотеки в файл. Опция
 позволяет загрузить ровно одну книгу, поэтому самый простой способ
 использовать эту команду — совместно с опцией `--id`. Файл сохраняется в
 текущую директорию с тем именем, под которым он храниться в библиотеке.
 
-Ключ `format` в секции `[download]` файла конфигурации m_librarian.conf
+Ключ `format` в секции `[download]` файла конфигурации
 
 |    [download]
 |    format = %a/%s/%n %t
@@ -196,7 +210,7 @@ ml-search.py
 в конец с точкой в качестве разделителя. Т.о. формат `%f` эквивалентен
 формату `%f.%e`.
 
-Опция `--format format` позволяет указать формат в командной строке.
+Опция `-F|--format format` позволяет указать формат в командной строке.
 
 Опция `--get-many N` позволяет загрузить указанное число книг (не больше
 чем N, где N — целое число.) Опции `--get-many N` и `--get` взаимно
@@ -252,4 +266,25 @@ ml-search.py
 
 При использовании опции `-v` также выводится id из БД.
 
+
+ml-web.py
+------------
+
+Использование::
+
+    ml-web.py [-p port]
+
+Опции::
+
+    -p, --port port      Порт протокола HTTP
+
+Запускает web-сервер. Если указан порт, то используется указанный порт.
+Иначе выбирается случайный порт из числа свободных. Программа запускает
+браузер (или открывает новое окно уже запущенного web-обозревателя) с
+адресом, указывающим на сервер.
+
+Если одна копия программы уже запущена, а пользователь запустил вторую,
+вторая копия определяет наличие первой, запускает браузер с адресом
+первого web-сервера и останавливается.
+
 .. vim: set tw=72 :