]> git.phdru.name Git - m_librarian.git/blobdiff - docs/command_line.rst
Make option -d global
[m_librarian.git] / docs / command_line.rst
index 1e3adc64f5e342315edc7e8382ac538b9e8cd0d5..15144459edada7dd3a533843f9ed66e0d436865f 100644 (file)
@@ -31,7 +31,7 @@ ml-search.py
 
 Usage::
 
-    ml-search.py [-i] [-I] [-t] [-s] [-f] ...
+    ml-search.py [-i] [-I] [-t] [-s] [-f] [-d] ...
 
 Search through the database and display results. Currently can only
 search authors by name.
@@ -44,6 +44,8 @@ Global options::
                           (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
@@ -93,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/-s/-f] 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.
 
@@ -108,14 +111,23 @@ 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
+    --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, language and file extension.
+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
 ^^^^^^^^^^^^^^^^
@@ -126,6 +138,7 @@ Usage::
 
 Search and print a list of extensions by name.
 
+
 Genres search
 ^^^^^^^^^^^^^
 
@@ -140,6 +153,7 @@ Options::
     -n, --name name    Search by name
     -t, --title title  Search by title
 
+
 Language search
 ^^^^^^^^^^^^^^^