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 Initialize database and import genres list. Doesn't really needed as
  14 the next script does all that too.
  15
  16
  17 ml-import.py
  18 ------------
  19
  20 Usage::
  21
  22     ml-import.py [file.inpx ...]
  23
  24 Initialize database, import genres list and import a list of INPX files
  25 listed in the command line. On subsequent runs doesn't destroy DB or
  26 reimport genres; it also skips already import books but import new ones.
  27
  28
  29 ml-search.py
  30 ------------
  31
  32 Usage::
  33
  34     ml-search.py [-i] [-I] [-t] [-s] [-f] ...
  35
  36 Search through the database and display results. Currently can only
  37 search authors by name.
  38
  39 Global options::
  40
  41     -i, --ignore-case     ignore case (default is to guess)
  42     -I, --case-sensitive  don't ignore case
  43     -t, --start           search type: substring at the start
  44                           (this is the default)
  45     -s, --substring       search type: substring anywhere
  46     -f, --full            search type: match the full string
  47
  48 Options ``-i/-I`` cannot be used together as they are the opposite. In
  49 case none of them are used the program guesses case-sensitivity by
  50 looking at the arguments. If all arguments are lowercase the program
  51 performs case-insensitive search. If there are UPPERCASE or MixedCase
  52 arguments the program performs case-sensitive search.
  53
  54 Options ``-t/-s/-f`` define the search type. Search types are:
  55
  56 * start - search for substring at the start of the search field; for
  57   example searching for "duck" returns results for "duck" and "duckling"
  58   but not for "McDuck"; this is the default search type.
  59 * substring - search for any substring; "duck" => "duck", "duckling",
  60   "McDuck" (except for case-sensitive search, of course).
  61 * full - search for exact match, compare the entire strings;
  62   i.e. searching for "duck" returns results for "duck" but not for
  63   "duckling";
  64
  65
  66 Author search
  67 ^^^^^^^^^^^^^
  68
  69 Usage::
  70
  71     ml-search.py [-i/-I] [-t/-s/-f] author [-s surname] [-n name] [-m misc-name] [fullname]
  72
  73 Search and print a list of authors by surname/name/misc name/full name.
  74
  75 Options::
  76
  77     -s, --surname surname       Search by surname
  78     -n, --name name             Search by name
  79     -m, --misc-name misc. name  Search by misc. name
  80
  81 Example::
  82
  83     ml-search.py -i author -s duck
  84
  85 Search and print a list of authors whose surname starts with "duck",
  86 case insensitive.
  87
  88 If a few options are given the search is limited with operator AND.
  89 Example::
  90
  91     ml-search.py -i author -s duck -n mack
  92
  93 Search and print a list of authors whose surname starts with "duck", and
  94 name starts with "mack", case insensitive.
  95
  96 Book search
  97 ^^^^^^^^^^^
  98
  99 Usage::
 100
 101     ml-search.py [-i/-I] [-t/-s/-f] books [-t title] [-s series] [-a archive] [-f file] [-d]
 102
 103 Search and print a list of books by title, series, archive or file name.
 104
 105 Options::
 106
 107     -t, --title title      Search by title
 108     -s, --series series    Search by series
 109     -a, --archive archive  Search by archive (zip file)
 110     -f, --file file        Search by file name (without extension)
 111     -d, --details          Output more details about books;
 112                            repeat for even more details
 113
 114 By default the program prints only titles of the found book. With one
 115 option `-d` it also prints the list of authors and genres.
 116
 117 Extension search
 118 ^^^^^^^^^^^^^^^^
 119
 120 Usage::
 121
 122     ml-search.py [-i/-I] [-t/-s/-f] ext [name]
 123
 124 Search and print a list of extensions by name.
 125
 126 Genres search
 127 ^^^^^^^^^^^^^
 128
 129 Usage::
 130
 131     ml-search.py [-i/-I] [-t/-s/-f] genres [-n name] [-t title]
 132
 133 Search and print a list of genres by name and title.
 134
 135 Options::
 136
 137     -n, --name name    Search by name
 138     -t, --title title  Search by title
 139
 140 Language search
 141 ^^^^^^^^^^^^^^^
 142
 143 Usage::
 144
 145     ml-search.py [-i/-I] [-t/-s/-f] lang [name]
 146
 147 Search and print a list of languages by name.
 148
 149 .. vim: set tw=72 :