docs-ru/command_line.rst

   1
   2 Скрипты командной строки
   3 ========================
   4
   5
   6 .. contents::
   7    :local:
   8
   9 .. highlight:: none
  10
  11 ml-initdb.py
  12 ------------
  13
  14 Использование::
  15
  16     ml-initdb.py [-C] [-D]
  17
  18 Опции::
  19
  20     -C, --config config      Путь к файлу конфигурации
  21     -D, --database database  Использовать указанную БД
  22
  23 Инициализирует базу данных и импортирует список жанров. Этот скрипт не
  24 очень-то нужен, так как следующий скрипт делает всё указанное.
  25
  26
  27 ml-import.py
  28 ------------
  29
  30 Использование::
  31
  32     ml-import.py [-C] [-D] [file.inpx ...]
  33
  34 Опции::
  35
  36     -C, --config config      Путь к файлу конфигурации
  37     -D, --database database  Использовать указанную БД
  38
  39 Инициализирует базу данных, импортирует список жанров и список файлов
  40 INPX, перечисленных в командной строке. При повторных запусках не
  41 переинициализирует БД и не переимпортирует жанры; так же не
  42 переимпортирует уже проимпортированные книги, но импортирует в БД новые.
  43
  44
  45 ml-search.py
  46 ------------
  47
  48 Использование::
  49
  50     ml-search.py [-C] [-D] [-i] [-I] [-t] [-s] [-f] [-v] [-c] ...
  51
  52 Программа выполняет поиск по базе данных и показывает список
  53 результатов. В настоящее время может искать только в списке авторов.
  54
  55 Глобальные опции::
  56
  57     -C, --config config      Путь к файлу конфигурации
  58     -D, --database database  Использовать указанную БД
  59     -i, --ignore-case        независимо от регистра (по умолчанию: угадать)
  60     -I, --case-sensitive     с учётом регистра
  61     -t, --start              тип поиска: подстрока в начале строки
  62                              (это тип поиска по умолчанию)
  63     -s, --substring          тип поиска: подстрока в любом месте
  64     -f, --full               тип поиска: полное совпадение всей строки
  65     -c, --count              Выводить число найденных объектов, а не сами
  66                              объекты
  67     -v, --verbose            Выводить больше информации о найденных
  68                              объектах; повторите эту опцию несколько раз,
  69                              чтобы получить ещё больше деталей
  70
  71 Опции ``-i/-I`` не могут использованы одновременно, поскольку означают
  72 противоположные команды. В случае, если ни одна из них не использована,
  73 программа угадывает зависимость от регистра: если все параметры даны в
  74 нижнем регистре, программы выполнит поиск без учёта регистра. Если среди
  75 параметров есть параметры в ВЕРХНЕМ или Смешанном регистре - поиск будет
  76 с учётом регистра.
  77
  78 Опции ``-t/-s/-f`` определяют тип поиска. Возможные значения:
  79
  80 * start - поиск подстроки в начале поля; поиск "друг" найдёт "друг" и
  81   "другой", но не "подруга"; это тип по умолчанию;
  82 * substring - поиск подстроки в любом месте; поиск "друг" найдёт "друг",
  83   "другой" и "подруга".
  84 * full - поиск на точное совпадение всей строки; поиск "друг" найдёт
  85   только "друг", но не "другой";
  86
  87
  88 Поиск авторов
  89 ^^^^^^^^^^^^^
  90
  91 Использование::
  92
  93     ml-search.py author [-s surname] [-n name] [-m misc-name] [--id id] [fullname]
  94
  95 Искать и печатать список авторов по фамилии, имени, доп. имени (обычно
  96 отчеству) или полному имени.
  97
  98 Опции::
  99
 100     -s, --surname фамилия       Искать по фамилии
 101     -n, --name имя              Искать по имени
 102     -m, --misc-name доп. имени  Искать по доп. имени
 103     --id id                     Искать по id автора
 104
 105 Пример::
 106
 107     ml-search.py -i author -s друг
 108
 109 Искать и печатать список авторов, чья фамилия начинается на "друг", без
 110 учёта регистра.
 111
 112 Если использовать несколько опций, поиск будет сужен оператором "И".
 113 Пример::
 114
 115     ml-search.py -i author -s друг -n в
 116
 117 Искать и печатать список авторов, чья фамилия начинается на "друг" и имя
 118 начинается на "в", без учёта регистра.
 119
 120 При использовании опции `-v` также выводится id из БД.
 121
 122
 123 Поиск и загрузка книг
 124 ^^^^^^^^^^^^^^^^^^^^^
 125
 126 Использование::
 127
 128     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]
 129
 130 Искать и печатать список книг по заголовку, серии, архиву, имени файла.
 131
 132 Опции::
 133
 134     -t, --title заголовок  Искать по заголовку
 135     -s, --series серия     Искать по серии
 136     -a, --archive архив    Искать по имени архива (zip-файла)
 137     -f, --file файл        Искать по имени файла (без расширения)
 138     --id id                Искать по id книги
 139     --surname surname      Искать по фамилии автора
 140     --name name            Искать по имени автора
 141     --misc-name misc. name Искать по доп. имени автора
 142     --fullname name        Искать по полному имени автора
 143     --aid aid              Искать по id автора
 144     -e, --ext ext          Искать по расширению имени файла
 145     --eid eid              Искать по id расширения
 146     --gname name           Искать по названию жанра
 147     --gtitle title         Искать по заголовку жанра
 148     --gid gid              Искать по id жанра
 149     -l, --lang lang        Искать по языку
 150     --lid lid              Искать по id языка
 151     -P, --path path        Путь к директории с архивами библиотеки
 152     -F, --format format    Формат имени сохраняемого файла
 153     --get                  Загрузить ровно один файл
 154     --get-many N           Загрузить не больше указанного числа файлов
 155
 156 По умолчанию программы выводит список заголовков найденных книг. При
 157 использовании опции `-v` также выводится id из БД, список авторов и
 158 жанров, а также серия, к которой принадлежит книга (если принадлежит) и
 159 порядковый номер книги в этой серии. С двумя опциями `-v` (`-v -v` или
 160 просто `-vv`) программа выводит дату файла и язык. С тремя `-v`
 161 выводятся имя архива, имя файла, расширение и размер файла, и признак,
 162 была ли книга помечена как удалённая.
 163
 164 Опция `-P` задаёт путь к директории с архивами библиотеки. По умолчанию
 165 этот путь берётся из файла конфигурации, секция `[library]`, ключ
 166 `path`, например::
 167
 168     [library]
 169     path = /var/lib/archives
 170
 171 Опция полезна в ситуации работы с несколькими базами данных (глобальная
 172 опция `-D`).
 173
 174 Опция `--get` позволяет загрузить книгу из библиотеки в файл. Опция
 175 позволяет загрузить ровно одну книгу, поэтому самый простой способ
 176 использовать эту команду — совместно с опцией `--id`. Файл сохраняется в
 177 текущую директорию с тем именем, под которым он храниться в библиотеке.
 178
 179 Ключ `format` в секции `[download]` файла конфигурации
 180
 181 |    [download]
 182 |    format = %a/%s/%n %t
 183
 184 позволяет управлять именами директорий и именем файла, куда m_Librarian
 185 будет сохранять файлы. Формат по умолчанию `%f`, т.е. просто имя файла.
 186 Другие доступные спецификаторы::
 187
 188     %a - автор (один из, если их несколько)
 189     %e - расширение имени файла
 190     %f - имя файла
 191     %G - жанр (один из, если их несколько), имя из БД
 192     %g - жанр (один из, если их несколько), название
 193     %l - язык
 194     %n - номер в серии (или 0)
 195     %s - серия
 196     %t - название
 197
 198 Формат не должен заканчиваться на разделитель директорий (`/` или `\\`).
 199 Если спецификатор `%e` (расширение) не найден в формате, он добавляется
 200 в конец с точкой в качестве разделителя. Т.о. формат `%f` эквивалентен
 201 формату `%f.%e`.
 202
 203 Опция `-F|--format format` позволяет указать формат в командной строке.
 204
 205 Опция `--get-many N` позволяет загрузить указанное число книг (не больше
 206 чем N, где N — целое число.) Опции `--get-many N` и `--get` взаимно
 207 исключают друг друга и не должны использоваться одновременно.
 208
 209
 210 Поиск расширений
 211 ^^^^^^^^^^^^^^^^
 212
 213 Использование::
 214
 215     ml-search.py ext [name] [--id id]
 216
 217 Опции::
 218
 219     --id id                Искать по id расширения
 220
 221 Искать и печатать список расширений имён файлов по имени.
 222
 223 При использовании опции `-v` также выводится id из БД.
 224
 225
 226 Поиск жанров
 227 ^^^^^^^^^^^^
 228
 229 Использование::
 230
 231     ml-search.py genres [-n name] [-t title] [--id id]
 232
 233 Искать и печатать список жанров по имени и заголовку.
 234
 235 Опции::
 236
 237     -n, --name имя         Искать по названию
 238     -t, --title заголовок  Искать по заголовку
 239     --id id                Искать по id жанра
 240
 241 При использовании опции `-v` также выводится id из БД.
 242
 243
 244 Поиск языков
 245 ^^^^^^^^^^^^
 246
 247 Использование::
 248
 249     ml-search.py lang [name] [--id id]
 250
 251 Опции::
 252
 253     --id id                Искать по id языка
 254
 255 Искать и печатать список языков по имени.
 256
 257 При использовании опции `-v` также выводится id из БД.
 258
 259 .. vim: set tw=72 :