X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=docs%2Fcommand_line.rst;h=fdc5f97373126555cfdb9773fe3a03ab20b9e5a8;hb=09f49faa484b5091be175823e406cbebb4162e3a;hp=1298111faefd32720c00e6573a6a2cfeb372791e;hpb=1c8112d265e0df9badf0c4d9edf11a439f41b4a1;p=m_librarian.git diff --git a/docs/command_line.rst b/docs/command_line.rst index 1298111..fdc5f97 100644 --- a/docs/command_line.rst +++ b/docs/command_line.rst @@ -31,7 +31,7 @@ ml-search.py Usage:: - ml-search.py [-i] [-I] [-t {exact,start,substring}] ... + ml-search.py [-i] [-I] [-t] [-s] [-f] ... Search through the database and display results. Currently can only search authors by name. @@ -40,9 +40,10 @@ Global options:: -i, --ignore-case ignore case (default is to guess) -I, --case-sensitive don't ignore case - -t, --search-type {exact,start,substring} - search type: exact match, substring at the start (this is the default), - substring anywhere. + -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 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 @@ -50,15 +51,16 @@ looking at the arguments. If all arguments are lowercase the program performs case-insensitive search. If there are UPPERCASE or MixedCase arguments the program performs case-sensitive search. -Option ``-t/--search-type`` defines the search type. Search types are: +Options ``-t/-s/-f`` define the search type. Search types are: -* exact - search for exact match; i.e. searching for "duck" returns - results for "duck" but not for "duckling"; * start - search for substring at the start of the search field; for example searching for "duck" returns results for "duck" and "duckling" but not for "McDuck"; this is the default search type. * substring - search for any substring; "duck" => "duck", "duckling", "McDuck" (except for case-sensitive search, of course). +* full - search for exact match, compare the entire strings; + i.e. searching for "duck" returns results for "duck" but not for + "duckling"; Author search @@ -66,7 +68,7 @@ Author search Usage:: - ml-search.py [-i] [-I] [-t ...] author [-s surname] [-n name] [-m misc-name] [fullname] + ml-search.py [-i/-I] [-t/-s/-f] author [-s surname] [-n name] [-m misc-name] [fullname] Search and print a list of authors by surname/name/misc name/full name. @@ -96,7 +98,7 @@ Book search Usage:: - ml-search.py [-i] [-I] [-t ...] books [-t title] [-s series] [-a archive] [-f file] + ml-search.py [-i/-I] [-t/-s/-f] books [-t title] [-s series] [-a archive] [-f file] [-d] Search and print a list of books by title, series, archive or file name. @@ -106,13 +108,20 @@ 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 + +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. Extension search ^^^^^^^^^^^^^^^^ Usage:: - ml-search.py [-i] [-I] [-t ...] ext [name] + ml-search.py [-i/-I] [-t/-s/-f] ext [name] Search and print a list of extensions by name. @@ -121,7 +130,7 @@ Genres search Usage:: - ml-search.py [-i] [-I] [-t ...] genres [-n name] [-t title] + ml-search.py [-i/-I] [-t/-s/-f] genres [-n name] [-t title] Search and print a list of genres by name and title. @@ -135,7 +144,7 @@ Language search Usage:: - ml-search.py [-i] [-I] [-t ...] lang [name] + ml-search.py [-i/-I] [-t/-s/-f] lang [name] Search and print a list of languages by name.