Docs: Update TODO

[m_librarian.git] / docs / command_line.rst

diff --git a/docs/command_line.rst b/docs/command_line.rst
index 62584436047df73c9ef9169fea58a283e2a55e9e..e7421435d057888d960c3f2fdbecad65c44462a7 100644 (file)
--- a/docs/command_line.rst
+++ b/docs/command_line.rst
@@ -29,12 +29,13 @@ ml-import.py
 
 Usage::
 
-    ml-import.py [-C] [-D] [file.inpx ...]
+    ml-import.py [-C] [-D] [-P] [file.inpx ...]
 
 Options::
 
     -C, --config config      Configuration file
     -D, --database database  Open this database by pathname/db uri
+    -P, --no-pbar            Inhibit progress bar
 
 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
@@ -145,8 +146,10 @@ Options::
     --gid gid              Search by genre’s id
     -l, --lang lang        Search by language
     --lid lid              Search by language’s id
+    --filters              Use filters from config
     -P, --path path        Path to the directory with the library
                            archives
+    --download-to [path]   Download directory
     -F, --format format    Format of the downloaded file name
     --get                  Download exactly one book
     --get-many N           Download at most this many books
@@ -168,6 +171,25 @@ section `[library]`, key `path`::
 
 The option is useful for multiple databases (global option `-D`).
 
+Option `--filters` turns on using filters from config. Currently there
+are two kind of filters: filters on languages and filter on flag
+`deleted`. They are defined in the config file the following way::
+
+    [filters]
+    lang = en ru
+    deleted = 0
+
+`lang` filters is a list of language codes separated by a space.
+`deleted` is a 0/1 flag; 0 hides deleted books from search.
+
+Option `--download-to` provides the path to the download directory.
+By default the script downloads books to the current directory.
+If the option is used without `path` argument the path is extracted from
+configuration file, section `[download]`, key `path`::
+
+    [download]
+    path = /tmp
+
 Option `--get` allows to download a book from the library to a local
 file. The option allows to download exactly one book. The simplest way
 to use it is via option `--id`. The file is downloaded into the current
@@ -252,4 +274,23 @@ Options::
 
 With one option `-v` it also prints database id.
 
+
+ml-web.py
+------------
+
+Usage::
+
+    ml-web.py [-p port]
+
+Options::
+
+    -p, --port port      HTTP port to listen to
+
+Run a web server. If a port is given listens on the given port else
+chooses a random port. Starts a browser (or open a new window of a
+running browser) pointing it to the server.
+
+If the program is already running the second instance detects the first
+one, starts a browser pointing to running instance and exits.
+
 .. vim: set tw=72 :