16 ml-initdb.py [-C] [-D]
20 -C, --config config Configuration file
21 -D, --database database Open this database by pathname/db uri
23 Initialize database and import genres list. Isn’t really needed as
24 the next script does all that too.
32 ml-import.py [-C] [-D] [-P] [file.inpx ...]
36 -C, --config config Configuration file
37 -D, --database database Open this database by pathname/db uri
38 -P, --no-pbar Inhibit progress bar
40 Initialize database, import genres list and import a list of INPX files
41 listed in the command line. On subsequent runs doesn’t destroy DB or
42 reimport genres; it also skips already import books but import new ones.
50 ml-search.py [-C] [-D] [-i] [-I] [-t] [-s] [-f] [-v] [-c] ...
52 Search through the database and display results. Currently can only
53 search authors by name.
57 -C, --config config Configuration file
58 -D, --database database Open this database by pathname/db uri
59 -i, --ignore-case ignore case (default is to guess)
60 -I, --case-sensitive don’t ignore case
61 -t, --start search type: substring at the start
63 -s, --substring search type: substring anywhere
64 -f, --full search type: match the full string
65 -c, --count Output count of found objects
66 -v, --verbose Output more details about found objects;
67 repeat for even more details
69 Options ``-i/-I`` cannot be used together as they are the opposite. In
70 case none of them are used the program guesses case-sensitivity by
71 looking at the arguments. If all arguments are lowercase the program
72 performs case-insensitive search. If there are UPPERCASE or MixedCase
73 arguments the program performs case-sensitive search.
75 Options ``-t/-s/-f`` define the search type. Search types are:
77 * start - search for substring at the start of the search field; for
78 example searching for "duck" returns results for "duck" and "duckling"
79 but not for "McDuck"; this is the default search type.
80 * substring - search for any substring; "duck" => "duck", "duckling",
81 "McDuck" (except for case-sensitive search, of course).
82 * full - search for exact match, compare the entire strings;
83 i.e. searching for "duck" returns results for "duck" but not for
92 ml-search.py author [-s surname] [-n name] [-m misc-name] [--id id] [fullname]
94 Search and print a list of authors by surname/name/misc name/full name.
98 -s, --surname surname Search by surname
99 -n, --name name Search by name
100 -m, --misc-name misc. name Search by misc. name
101 --id id Search by database id
105 ml-search.py -i author -s duck
107 Search and print a list of authors whose surname starts with "duck",
110 If a few options are given the search is limited with operator AND.
113 ml-search.py -i author -s duck -n mack
115 Search and print a list of authors whose surname starts with "duck" and
116 name starts with "mack", case insensitive.
118 With one option `-v` it also prints database id.
121 Book searching and downloading
122 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
126 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]
128 Search and print a list of books by title, series, archive or file name.
132 -t, --title title Search by title
133 -s, --series series Search by series
134 -a, --archive archive Search by archive (zip file)
135 -f, --file file Search by file name (without extension)
136 --id id Search by database id
137 --surname surname Search by author’s surname
138 --name name Search by author’s name
139 --misc-name misc. name Search by author’s misc. name
140 --fullname name Search by author’s full name
141 --aid aid Search by author’s id
142 -e, --ext ext Search by file extension
143 --eid eid Search by extension’s id
144 --gname name Search by genre’s name
145 --gtitle title Search by genre’s title
146 --gid gid Search by genre’s id
147 -l, --lang lang Search by language
148 --lid lid Search by language’s id
149 -P, --path path Path to the directory with the library
151 -F, --format format Format of the downloaded file name
152 --get Download exactly one book
153 --get-many N Download at most this many books
155 By default the program prints only titles of the found book. With one
156 option `-v` it also prints database id, the list of authors and genres,
157 and also series the book belongs to (if any) and the serial number of
158 the book in the series. With two options `-v` (`-v -v` or simply `-vv`)
159 it also prints the file date and language. With three `-v` it prints
160 archive name, file name, extension and size, and flag if the book is
161 marked to be deleted.
163 Option `-P` provides the path to the directory with the library
164 archives. By default the path is extracted from configuration file,
165 section `[library]`, key `path`::
168 path = /var/lib/archives
170 The option is useful for multiple databases (global option `-D`).
172 Option `--get` allows to download a book from the library to a local
173 file. The option allows to download exactly one book. The simplest way
174 to use it is via option `--id`. The file is downloaded into the current
175 directory with the name from the library.
180 | format = %a/%s/%n %t
182 allows to set format for the download file pathname. Default format is
183 `%f`, i.e. just filename. Other format specifiers are::
185 %a - author (one of if many)
187 %f - file name in archive
188 %G - genre (one of if many), name
189 %g - genre (one of if many), title
191 %n - series number (or 0)
195 Format must not end in directory separator (`/` or `\\`). If specifier
196 `%e` (extension) is not found in the format it is appended
197 unconditionally with a dot. That is, format `%f` is equivalent to
200 Option `-F|--format format` allows to overwrite this configuration value.
202 Option `--get-many N` allows to download many books (at most N, where N
203 is an integer). Options `--get-many N` and `--get` are, of course,
204 mutually incompatible.
212 ml-search.py ext [name] [--id id]
216 --id id Search by database id
218 Search and print a list of extensions by name.
220 With one option `-v` it also prints database id.
228 ml-search.py genres [-n name] [-t title] [--id id]
230 Search and print a list of genres by name and title.
234 -n, --name name Search by name
235 -t, --title title Search by title
236 --id id Search by database id
238 With one option `-v` it also prints database id.
246 ml-search.py lang [name] [--id id]
248 Search and print a list of languages by name.
252 --id id Search by database id
254 With one option `-v` it also prints database id.