]> git.phdru.name Git - m_librarian.git/commitdiff
Document options -p and --get
authorOleg Broytman <phd@phdru.name>
Sun, 5 Jun 2016 15:02:55 +0000 (18:02 +0300)
committerOleg Broytman <phd@phdru.name>
Sun, 5 Jun 2016 15:02:55 +0000 (18:02 +0300)
docs-ru/command_line.rst
docs/command_line.rst

index 185505d25a327d55023bbddfd05f8cd68f85eb29..417955838a061b4bd3f709d27b5d1a6e66e5d2ac 100644 (file)
@@ -121,7 +121,7 @@ ml-search.py
 
 Использование::
 
 
 Использование::
 
-    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] [--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]
 
 Искать и печатать список книг по заголовку, серии, архиву, имени файла.
 
 
 Искать и печатать список книг по заголовку, серии, архиву, имени файла.
 
@@ -131,6 +131,8 @@ ml-search.py
     -s, --series серия     Искать по серии
     -a, --archive архив    Искать по имени архива (zip-файла)
     -f, --file файл        Искать по имени файла (без расширения)
     -s, --series серия     Искать по серии
     -a, --archive архив    Искать по имени архива (zip-файла)
     -f, --file файл        Искать по имени файла (без расширения)
+    -p, --path path        Путь к директории с архивами библиотеки
+    --get                  Загрузить ровно один файл
     --id id                Искать по id книги
     --surname surname      Искать по фамилии автора
     --name name            Искать по имени автора
     --id id                Искать по id книги
     --surname surname      Искать по фамилии автора
     --name name            Искать по имени автора
@@ -153,6 +155,21 @@ ml-search.py
 выводятся имя архива, имя файла, расширение и размер файла, и признак,
 была ли книга помечена как удалённая.
 
 выводятся имя архива, имя файла, расширение и размер файла, и признак,
 была ли книга помечена как удалённая.
 
+Опция `-p` задаёт путь к директории с архивами библиотеки. По умолчанию
+этот путь берётся из файла конфигурации `m_librarian`, секция
+`[library]`, ключ `path`, например::
+
+    [library]
+    path = /var/lib/archives
+
+Опция полезна в ситуации работы с несколькими базами данных (глобальная
+опция `-d`).
+
+Опция `--get` позволяет загрузить книгу из библиотеки в файл. Опция
+позволяет загрузить ровно одну книгу, поэтому самый простой способ
+использовать эту команду — совместно с опцией `--id`. Файл сохраняется в
+текущую директорию с тем именем, под которым он храниться в библиотеке.
+
 
 Поиск расширений
 ^^^^^^^^^^^^^^^^
 
 Поиск расширений
 ^^^^^^^^^^^^^^^^
index da05ed2ba537dd95ada4953d536d0b63eb2384b0..f9911a8f5f258aca274e080b7964d69165a218b1 100644 (file)
@@ -118,7 +118,7 @@ Book search
 
 Usage::
 
 
 Usage::
 
-    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] [--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]
 
 Search and print a list of books by title, series, archive or file name.
 
 
 Search and print a list of books by title, series, archive or file name.
 
@@ -128,6 +128,9 @@ Options::
     -s, --series series    Search by series
     -a, --archive archive  Search by archive (zip file)
     -f, --file file        Search by file name (without extension)
     -s, --series series    Search by series
     -a, --archive archive  Search by archive (zip file)
     -f, --file file        Search by file name (without extension)
+    -p, --path path        Path to the directory with the library
+                           archives
+    --get                  Download exactly one book
     --id id                Search by database id
     --surname surname      Search by author’s surname
     --name name            Search by author’s name
     --id id                Search by database id
     --surname surname      Search by author’s surname
     --name name            Search by author’s name
@@ -150,6 +153,20 @@ it also prints the file date and language. With three `-v` it prints
 archive name, file name, extension and size, and flag if the book is
 marked to be deleted.
 
 archive name, file name, extension and size, and flag if the book is
 marked to be deleted.
 
+Option `-p` provides the path to the directory with the library
+archives. By default the path is extracted from `m_librarian.conf`,
+section `[library]`, key `path`::
+
+    [library]
+    path = /var/lib/archives
+
+The option is useful for multiple databases (global option `-d`).
+
+Option `--get` allows to download a book from the library to a local
+file. The option allows to download exactly one book. The simplest way
+to use it is via option `--id`. The file is downloaded into the current
+directory with the name from the library.
+
 
 Extension search
 ^^^^^^^^^^^^^^^^
 
 Extension search
 ^^^^^^^^^^^^^^^^