From c8d30e34f836043394515b37115dc4b490bd7fc3 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sun, 5 Jun 2016 18:02:55 +0300 Subject: [PATCH] Document options -p and --get --- docs-ru/command_line.rst | 19 ++++++++++++++++++- docs/command_line.rst | 19 ++++++++++++++++++- 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/docs-ru/command_line.rst b/docs-ru/command_line.rst index 185505d..4179558 100644 --- a/docs-ru/command_line.rst +++ b/docs-ru/command_line.rst @@ -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 файл Искать по имени файла (без расширения) + -p, --path path Путь к директории с архивами библиотеки + --get Загрузить ровно один файл --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`. Файл сохраняется в +текущую директорию с тем именем, под которым он храниться в библиотеке. + Поиск расширений ^^^^^^^^^^^^^^^^ diff --git a/docs/command_line.rst b/docs/command_line.rst index da05ed2..f9911a8 100644 --- a/docs/command_line.rst +++ b/docs/command_line.rst @@ -118,7 +118,7 @@ Book search 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. @@ -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) + -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 @@ -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. +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 ^^^^^^^^^^^^^^^^ -- 2.39.5