By default print only titles of the found book

[m_librarian.git] / docs / command_line.rst

diff --git a/docs/command_line.rst b/docs/command_line.rst
index 6347dff93f5241c56356427e0027b7ef6d076194..0e63d97acd8b1d72fd34510848b54ca9fcd15acf 100644 (file)
--- a/docs/command_line.rst
+++ b/docs/command_line.rst
@@ -66,9 +66,9 @@ Author search
 
 Usage::
 
-    ml-search.py [-i] [-I] [-t ...] author [-s surname] [-n name] [-m misc-name]
+    ml-search.py [-i] [-I] [-t ...] author [-s surname] [-n name] [-m misc-name] [fullname]
 
-Search and print a list of authors by surname/name/misc name.
+Search and print a list of authors by surname/name/misc name/full name.
 
 Options::
 
@@ -91,4 +91,57 @@ 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] [-d]
+
+Search and print a list of books by title, series, archive or file name.
+
+Options::
+
+    -t, --title title      Search by title
+    -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.
+
+Extension search
+^^^^^^^^^^^^^^^^
+
+Usage::
+
+    ml-search.py [-i] [-I] [-t ...] 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]
+
+Search and print a list of genres by name and title.
+
+Options::
+
+    -n, --name name    Search by name
+    -t, --title title  Search by title
+
+Language search
+^^^^^^^^^^^^^^^
+
+Usage::
+
+    ml-search.py [-i] [-I] [-t ...] lang [name]
+
+Search and print a list of languages by name.
+
 .. vim: set tw=72 :