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