docs/command_line.rst

   1
   2 Command-line scripts
   3 ====================
   4
   5
   6 .. contents::
   7    :local:
   8
   9
  10 ml-initdb.py
  11 ------------
  12
  13 Usage::
  14
  15     ml-initdb.py [-d]
  16
  17 Options::
  18
  19     -d, --database database  Open this database by pathname/db uri
  20
  21 Initialize database and import genres list. Isn’t really needed as
  22 the next script does all that too.
  23
  24
  25 ml-import.py
  26 ------------
  27
  28 Usage::
  29
  30     ml-import.py [-d] [file.inpx ...]
  31
  32 Options::
  33
  34     -d, --database database  Open this database by pathname/db uri
  35
  36 Initialize database, import genres list and import a list of INPX files
  37 listed in the command line. On subsequent runs doesn’t destroy DB or
  38 reimport genres; it also skips already import books but import new ones.
  39
  40
  41 ml-search.py
  42 ------------
  43
  44 Usage::
  45
  46     ml-search.py [-d] [-i] [-I] [-t] [-s] [-f] [-v] [-c] ...
  47
  48 Search through the database and display results. Currently can only
  49 search authors by name.
  50
  51 Global options::
  52
  53     -d, --database database  Open this database by pathname/db uri
  54     -i, --ignore-case        ignore case (default is to guess)
  55     -I, --case-sensitive     don’t ignore case
  56     -t, --start              search type: substring at the start
  57                              (this is the default)
  58     -s, --substring          search type: substring anywhere
  59     -f, --full               search type: match the full string
  60     -c, --count              Output count of found objects
  61     -v, --verbose            Output more details about found objects;
  62                              repeat for even more details
  63
  64 Options ``-i/-I`` cannot be used together as they are the opposite. In
  65 case none of them are used the program guesses case-sensitivity by
  66 looking at the arguments. If all arguments are lowercase the program
  67 performs case-insensitive search. If there are UPPERCASE or MixedCase
  68 arguments the program performs case-sensitive search.
  69
  70 Options ``-t/-s/-f`` define the search type. Search types are:
  71
  72 * start - search for substring at the start of the search field; for
  73   example searching for "duck" returns results for "duck" and "duckling"
  74   but not for "McDuck"; this is the default search type.
  75 * substring - search for any substring; "duck" => "duck", "duckling",
  76   "McDuck" (except for case-sensitive search, of course).
  77 * full - search for exact match, compare the entire strings;
  78   i.e. searching for "duck" returns results for "duck" but not for
  79   "duckling";
  80
  81
  82 Author search
  83 ^^^^^^^^^^^^^
  84
  85 Usage::
  86
  87     ml-search.py author [-s surname] [-n name] [-m misc-name] [--id id] [fullname]
  88
  89 Search and print a list of authors by surname/name/misc name/full name.
  90
  91 Options::
  92
  93     -s, --surname surname       Search by surname
  94     -n, --name name             Search by name
  95     -m, --misc-name misc. name  Search by misc. name
  96     --id id                     Search by database id
  97
  98 Example::
  99
 100     ml-search.py -i author -s duck
 101
 102 Search and print a list of authors whose surname starts with "duck",
 103 case insensitive.
 104
 105 If a few options are given the search is limited with operator AND.
 106 Example::
 107
 108     ml-search.py -i author -s duck -n mack
 109
 110 Search and print a list of authors whose surname starts with "duck" and
 111 name starts with "mack", case insensitive.
 112
 113 With one option `-v` it also prints database id.
 114
 115
 116 Book search
 117 ^^^^^^^^^^^
 118
 119 Usage::
 120
 121     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]
 122
 123 Search and print a list of books by title, series, archive or file name.
 124
 125 Options::
 126
 127     -t, --title title      Search by title
 128     -s, --series series    Search by series
 129     -a, --archive archive  Search by archive (zip file)
 130     -f, --file file        Search by file name (without extension)
 131     --id id                Search by database id
 132     --surname surname      Search by author’s surname
 133     --name name            Search by author’s name
 134     --misc-name misc. name Search by author’s misc. name
 135     --fullname name        Search by author’s full name
 136     --aid aid              Search by author’s id
 137     -e, --ext ext          Search by file extension
 138     --eid eid              Search by extension’s id
 139     --gname name           Search by genre’s name
 140     --gtitle title         Search by genre’s title
 141     --gid gid              Search by genre’s id
 142     -l, --lang lang        Search by language
 143     --lid lid              Search by language’s id
 144
 145 By default the program prints only titles of the found book. With one
 146 option `-v` it also prints database id, the list of authors and genres,
 147 and also series the book belongs to (if any) and the serial number of
 148 the book in the series. With two options `-v` (`-v -v` or simply `-vv`)
 149 it also prints the file date and language. With three `-v` it prints
 150 archive name, file name, extension and size, and flag if the book is
 151 marked to be deleted.
 152
 153
 154 Extension search
 155 ^^^^^^^^^^^^^^^^
 156
 157 Usage::
 158
 159     ml-search.py ext [name] [--id id]
 160
 161 Options::
 162
 163     --id id                Search by database id
 164
 165 Search and print a list of extensions by name.
 166
 167 With one option `-v` it also prints database id.
 168
 169
 170 Genres search
 171 ^^^^^^^^^^^^^
 172
 173 Usage::
 174
 175     ml-search.py genres [-n name] [-t title] [--id id]
 176
 177 Search and print a list of genres by name and title.
 178
 179 Options::
 180
 181     -n, --name name    Search by name
 182     -t, --title title  Search by title
 183     --id id            Search by database id
 184
 185 With one option `-v` it also prints database id.
 186
 187
 188 Language search
 189 ^^^^^^^^^^^^^^^
 190
 191 Usage::
 192
 193     ml-search.py lang [name] [--id id]
 194
 195 Search and print a list of languages by name.
 196
 197 Options::
 198
 199     --id id                Search by database id
 200
 201 With one option `-v` it also prints database id.
 202
 203 .. vim: set tw=72 :