X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=docs%2Fcommand_line.rst;h=3db70140dc47ea36bfd2ef9c6d78156c7b38e3a4;hb=c23c4900f586fe7783ce370697209d6d4b1a6905;hp=1298111faefd32720c00e6573a6a2cfeb372791e;hpb=1c8112d265e0df9badf0c4d9edf11a439f41b4a1;p=m_librarian.git

diff --git a/docs/command_line.rst b/docs/command_line.rst
index 1298111..3db7014 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 {exact,start,substring}] ...
+    ml-search.py [-i] [-I] [-t] [-s] [-f] [-d] ...
 
 Search through the database and display results. Currently can only
 search authors by name.
@@ -39,10 +39,13 @@ search authors by name.
 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.
+    -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
@@ -50,15 +53,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 +70,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.
 
@@ -91,12 +95,13 @@ Example::
 Search and print a list of authors whose surname starts with "duck", and
 name starts with "mack", case insensitive.
 
+
 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] [--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.
 
@@ -106,22 +111,40 @@ Options::
     -s, --series series    Search by series
     -a, --archive archive  Search by archive (zip file)
     -f, --file file        Search by file name (without extension)
+    --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 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
 ^^^^^^^^^^^^^^^^
 
 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.
 
+
 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.
 
@@ -130,12 +153,13 @@ Options::
     -n, --name name    Search by name
     -t, --title title  Search by title
 
+
 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.