X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=docs%2Fcommand_line.rst;h=0fab06b7cac295396fc2594540b4e8be3d516144;hb=fc42dcaa2908ea3d5f7e1db5d4a777bbac9a05b4;hp=1e3adc64f5e342315edc7e8382ac538b9e8cd0d5;hpb=008868e3fba7af00b83631666aa5958a23560e57;p=m_librarian.git diff --git a/docs/command_line.rst b/docs/command_line.rst index 1e3adc6..0fab06b 100644 --- a/docs/command_line.rst +++ b/docs/command_line.rst @@ -10,7 +10,7 @@ Command-line scripts ml-initdb.py ------------ -Initialize database and import genres list. Doesn't really needed as +Initialize database and import genres list. Isn’t really needed as the next script does all that too. @@ -22,7 +22,7 @@ Usage:: ml-import.py [file.inpx ...] Initialize database, import genres list and import a list of INPX files -listed in the command line. On subsequent runs doesn't destroy DB or +listed in the command line. On subsequent runs doesn’t destroy DB or reimport genres; it also skips already import books but import new ones. @@ -31,7 +31,7 @@ ml-search.py Usage:: - ml-search.py [-i] [-I] [-t] [-s] [-f] ... + ml-search.py [-i] [-I] [-t] [-s] [-f] [-d] ... Search through the database and display results. Currently can only search authors by name. @@ -39,11 +39,13 @@ search authors by name. Global options:: -i, --ignore-case ignore case (default is to guess) - -I, --case-sensitive don't ignore case + -I, --case-sensitive don’t ignore case -t, --start search type: substring at the start (this is the default) -s, --substring search type: substring anywhere -f, --full search type: match the full string + -d, --details Output more details about found objects; + repeat for even more details Options ``-i/-I`` cannot be used together as they are the opposite. In case none of them are used the program guesses case-sensitivity by @@ -90,15 +92,18 @@ Example:: ml-search.py -i author -s duck -n mack -Search and print a list of authors whose surname starts with "duck", and +Search and print a list of authors whose surname starts with "duck" and name starts with "mack", case insensitive. +With one option `-d` it also prints database id. + + Book search ^^^^^^^^^^^ Usage:: - ml-search.py [-i/-I] [-t/-s/-f] books [-t title] [-s series] [-a archive] [-f file] [-d] + ml-search.py [-i/-I] [-t/-s/-f] books [-t title] [-s series] [-a archive] [-f file] [--surname name] [--name name] [--misc-name name] [--fullname name] [-e ext] [--gname name] [--gtitle title] [-l lang] Search and print a list of books by title, series, archive or file name. @@ -108,14 +113,23 @@ Options:: -s, --series series Search by series -a, --archive archive Search by archive (zip file) -f, --file file Search by file name (without extension) - -d, --details Output more details about books; - repeat for even more details + --surname surname Search by author’s surname + --name name Search by author’s name + --misc-name misc. name Search by author’s misc. name + --fullname name Search by author’s full name + -e, --ext ext Search by file extension + --gname name Search by genre’s name + --gtitle title Search by genre’s title + -l, --lang lang Search by language By default the program prints only titles of the found book. With one -option `-d` it also prints the list of authors and genres, and also -series the book belongs to (if any) and the serial number of the book in -the series. With two options `-d` (`-d -d` or simply `-dd`) it also -prints the file date, language and file extension. +option `-d` it also prints database id, the list of authors and genres, +and also series the book belongs to (if any) and the serial number of +the book in the series. With two options `-d` (`-d -d` or simply `-dd`) +it also prints the file date and language. With three `-d` it prints +archive name, file name, extension and size, and flag if the book is +marked to be deleted. + Extension search ^^^^^^^^^^^^^^^^ @@ -126,6 +140,9 @@ Usage:: Search and print a list of extensions by name. +With one option `-d` it also prints database id. + + Genres search ^^^^^^^^^^^^^ @@ -140,6 +157,9 @@ Options:: -n, --name name Search by name -t, --title title Search by title +With one option `-d` it also prints database id. + + Language search ^^^^^^^^^^^^^^^ @@ -149,4 +169,6 @@ Usage:: Search and print a list of languages by name. +With one option `-d` it also prints database id. + .. vim: set tw=72 :