chmod docs for sdist

[m_librarian.git] / docs / command_line.rst

diff --git a/docs/command_line.rst b/docs/command_line.rst
index 0e63d97acd8b1d72fd34510848b54ca9fcd15acf..53fe92664797c1129b8ce15cf97bc77f0a8c2535 100644 (file)
--- a/docs/command_line.rst
+++ b/docs/command_line.rst
@@ -10,7 +10,7 @@ Command-line scripts
 ml-initdb.py
 ------------
 
 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.
 
 
 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
     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.
 
 
 reimport genres; it also skips already import books but import new ones.
 
 


@@ -31,7 +31,7 @@ ml-search.py
 
 Usage::
 
 
 Usage::
 

-    ml-search.py [-i] [-I] [-t {exact,start,substring}] ...
+    ml-search.py [-i] [-I] [-t] [-s] [-f] [-d] [-c] ...

 
 Search through the database and display results. Currently can only
 search authors by name.
 
 Search through the database and display results. Currently can only
 search authors by name.


@@ -39,10 +39,14 @@ search authors by name.
 Global options::
 
     -i, --ignore-case     ignore case (default is to guess)
 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
+    -c, --count           Output count of found objects

 
 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
 
 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 +54,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.
 
 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).
 * 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
 
 
 Author search


@@ -66,7 +71,7 @@ Author search
 
 Usage::
 
 
 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.
 
 
 Search and print a list of authors by surname/name/misc name/full name.
 


@@ -88,15 +93,18 @@ Example::
 
     ml-search.py -i author -s duck -n mack
 
 
     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.
 
 name starts with "mack", case insensitive.
 

+With one option `-d` it also prints database id.
+
+

 Book search
 ^^^^^^^^^^^
 
 Usage::
 
 Book search
 ^^^^^^^^^^^
 
 Usage::
 

-    ml-search.py [-i] [-I] [-t ...] 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.
 
 
 Search and print a list of books by title, series, archive or file name.
 


@@ -106,27 +114,42 @@ Options::
     -s, --series series    Search by series
     -a, --archive archive  Search by archive (zip file)
     -f, --file file        Search by file name (without extension)
     -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
 
 By default the program prints only titles of the found book. With one

-option `-d` it also prints the list of authors.
+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
 ^^^^^^^^^^^^^^^^
 
 Usage::
 
 
 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.
 
 
 Search and print a list of extensions by name.
 

+With one option `-d` it also prints database id.
+
+

 Genres search
 ^^^^^^^^^^^^^
 
 Usage::
 
 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.
 
 
 Search and print a list of genres by name and title.
 


@@ -135,13 +158,18 @@ Options::
     -n, --name name    Search by name
     -t, --title title  Search by title
 
     -n, --name name    Search by name
     -t, --title title  Search by title
 

+With one option `-d` it also prints database id.
+
+

 Language search
 ^^^^^^^^^^^^^^^
 
 Usage::
 
 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.
 
 
 Search and print a list of languages by name.
 

+With one option `-d` it also prints database id.
+

 .. vim: set tw=72 :
 .. vim: set tw=72 :