Output count of found objects

[m_librarian.git] / docs / command_line.rst

diff --git a/docs/command_line.rst b/docs/command_line.rst
index 3db70140dc47ea36bfd2ef9c6d78156c7b38e3a4..53fe92664797c1129b8ce15cf97bc77f0a8c2535 100644 (file)
--- a/docs/command_line.rst
+++ b/docs/command_line.rst
@@ -31,7 +31,7 @@ ml-search.py
 
 Usage::
 
-    ml-search.py [-i] [-I] [-t] [-s] [-f] [-d] ...
+    ml-search.py [-i] [-I] [-t] [-s] [-f] [-d] [-c] ...
 
 Search through the database and display results. Currently can only
 search authors by name.
@@ -46,6 +46,7 @@ Global options::
     -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
@@ -92,9 +93,11 @@ 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
 ^^^^^^^^^^^
@@ -121,12 +124,12 @@ Options::
     -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.
+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
@@ -138,6 +141,8 @@ Usage::
 
 Search and print a list of extensions by name.
 
+With one option `-d` it also prints database id.
+
 
 Genres search
 ^^^^^^^^^^^^^
@@ -153,6 +158,8 @@ Options::
     -n, --name name    Search by name
     -t, --title title  Search by title
 
+With one option `-d` it also prints database id.
+
 
 Language search
 ^^^^^^^^^^^^^^^
@@ -163,4 +170,6 @@ Usage::
 
 Search and print a list of languages by name.
 
+With one option `-d` it also prints database id.
+
 .. vim: set tw=72 :