]> git.phdru.name Git - m_librarian.git/blob - docs-ru/command_line.rst
Document searching by database id
[m_librarian.git] / 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
16
17 ml-import.py
18 ------------
19
20 Использование::
21
22     ml-import.py [file.inpx ...]
23
24 Инициализирует базу данных, импортирует список жанров и список файлов
25 INPX, перечисленных в командной строке. При повторных запусках не
26 переинициализирует БД и не переимпортирует жанры; так же не
27 переимпортирует уже проимпортированные книги, но импортирует в БД новые.
28
29
30 ml-search.py
31 ------------
32
33 Использование::
34
35     ml-search.py [-i] [-I] [-t] [-s] [-f] [-d] [-c] ...
36
37 Программа выполняет поиск по базе данных и показывает список
38 результатов. В настоящее время может искать только в списке авторов.
39
40 Глобальные опции::
41
42     -i, --ignore-case     независимо от регистра (по умолчанию: угадать)
43     -I, --case-sensitive  с учётом регистра
44     -t, --start           тип поиска: подстрока в начале строки
45                           (это тип поиска по умолчанию)
46     -s, --substring       тип поиска: подстрока в любом месте
47     -f, --full            тип поиска: полное совпадение всей строки
48     -d, --details         Выводить больше информации о найденных
49                           объектах; повторите эту опцию несколько раз,
50                           чтобы получить ещё больше деталей
51     -c, --count           Выводить число найденных объектов, а не сами
52                           объекты
53
54 Опции ``-i/-I`` не могут использованы одновременно, поскольку означают
55 противоположные команды. В случае, если ни одна из них не использована,
56 программа угадывает зависимость от регистра: если все параметры даны в
57 нижнем регистре, программы выполнит поиск без учёта регистра. Если среди
58 параметров есть параметры в ВЕРХНЕМ или Смешанном регистре - поиск будет
59 с учётом регистра.
60
61 Опции ``-t/-s/-f`` определяют тип поиска. Возможные значения:
62
63 * start - поиск подстроки в начале поля; поиск "друг" найдёт "друг" и
64   "другой", но не "подруга"; это тип по умолчанию;
65 * substring - поиск подстроки в любом месте; поиск "друг" найдёт "друг",
66   "другой" и "подруга".
67 * full - поиск на точное совпадение всей строки; поиск "друг" найдёт
68   только "друг", но не "другой";
69
70
71 Поиск авторов
72 ^^^^^^^^^^^^^
73
74 Использование::
75
76     ml-search.py [-i/-I] [-t/-s/-f] author [-s surname] [-n name] [-m misc-name] [fullname]
77
78 Искать и печатать список авторов по фамилии, имени, доп. имени (обычно
79 отчеству) или полному имени.
80
81 Опции::
82
83     -s, --surname фамилия       Искать по фамилии
84     -n, --name имя              Искать по имени
85     -m, --misc-name доп. имени  Искать по доп. имени
86
87 Пример::
88
89     ml-search.py -i author -s друг
90
91 Искать и печатать список авторов, чья фамилия начинается на "друг", без
92 учёта регистра.
93
94 Если использовать несколько опций, поиск будет сужен оператором "И".
95 Пример::
96
97     ml-search.py -i author -s друг -n в
98
99 Искать и печатать список авторов, чья фамилия начинается на "друг" и имя
100 начинается на "в", без учёта регистра.
101
102 При использовании опции `-d` также выводится id из БД.
103
104
105 Поиск книг
106 ^^^^^^^^^^
107
108 Использование::
109
110     ml-search.py [-i/-I] [-t/-s/-f] 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]
111
112 Искать и печатать список книг по заголовку, серии, архиву, имени файла.
113
114 Опции::
115
116     -t, --title заголовок  Искать по заголовку
117     -s, --series серия     Искать по серии
118     -a, --archive архив    Искать по имени архива (zip-файла)
119     -f, --file файл        Искать по имени файла (без расширения)
120     --id id                Искать по id книги
121     --surname surname      Искать по фамилии автора
122     --name name            Искать по имени автора
123     --misc-name misc. name Искать по доп. имени автора
124     --fullname name        Искать по полному имени автора
125     --aid aid              Искать по id автора
126     -e, --ext ext          Искать по расширению имени файла
127     --eid eid              Искать по id расширения
128     --gname name           Искать по названию жанра
129     --gtitle title         Искать по заголовку жанра
130     --gid gid              Искать по id жанра
131     -l, --lang lang        Искать по языку
132     --lid lid              Искать по id языка
133
134 По умолчанию программы выводит список заголовков найденных книг. При
135 использовании опции `-d` также выводится id из БД, список авторов и
136 жанров, а также серия, к которой принадлежит книга (если принадлежит) и
137 порядковый номер книги в этой серии. С двумя опциями `-d` (`-d -d` или
138 просто `-dd`) программа выводит дату файла и язык. С тремя `-d`
139 выводятся имя архива, имя файла, расширение и размер файла, и признак,
140 была ли книга помечена как удалённая.
141
142
143 Поиск расширений
144 ^^^^^^^^^^^^^^^^
145
146 Использование::
147
148     ml-search.py [-i/-I] [-t/-s/-f] ext [name]
149
150 Искать и печатать список расширений имён файлов по имени.
151
152 При использовании опции `-d` также выводится id из БД.
153
154
155 Поиск жанров
156 ^^^^^^^^^^^^
157
158 Использование::
159
160     ml-search.py [-i/-I] [-t/-s/-f] genres [-n name] [-t title]
161
162 Искать и печатать список жанров по имени и заголовку.
163
164 Опции::
165
166     -n, --name имя         Искать по названию
167     -t, --title заголовок  Искать по заголовку
168
169 При использовании опции `-d` также выводится id из БД.
170
171
172 Поиск языков
173 ^^^^^^^^^^^^
174
175 Использование::
176
177     ml-search.py [-i/-I] [-t/-s/-f] lang [name]
178
179 Искать и печатать список языков по имени.
180
181 При использовании опции `-d` также выводится id из БД.
182
183 .. vim: set tw=72 :