docs-ru/command_line.rst

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