Docs: Document the second ml-web.py detects the first

[m_librarian.git] / docs / command_line.rst

diff --git a/docs/command_line.rst b/docs/command_line.rst
index 99b5c8425ba0d3234af47f21eaf37774f880c4c3..afdb42331cf2971274391d049b8d637cda68a65a 100644 (file)
--- a/docs/command_line.rst
+++ b/docs/command_line.rst
@@ -13,10 +13,11 @@ ml-initdb.py
 
 Usage::
 
-    ml-initdb.py [-D]
+    ml-initdb.py [-C] [-D]
 
 Options::
 
+    -C, --config config      Configuration file
     -D, --database database  Open this database by pathname/db uri
 
 Initialize database and import genres list. Isn’t really needed as
@@ -28,11 +29,13 @@ ml-import.py
 
 Usage::
 
-    ml-import.py [-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
@@ -44,13 +47,14 @@ ml-search.py
 
 Usage::
 
-    ml-search.py [-D] [-i] [-I] [-t] [-s] [-f] [-v] [-c] ...
+    ml-search.py [-C] [-D] [-i] [-I] [-t] [-s] [-f] [-v] [-c] ...
 
 Search through the database and display results. Currently can only
 search authors by name.
 
 Global options::
 
+    -C, --config config      Configuration file
     -D, --database database  Open this database by pathname/db uri
     -i, --ignore-case        ignore case (default is to guess)
     -I, --case-sensitive     don’t ignore case
@@ -144,6 +148,7 @@ Options::
     --lid lid              Search by language’s id
     -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
@@ -157,7 +162,7 @@ archive name, file name, extension and size, and flag if the book is
 marked to be deleted.
 
 Option `-P` provides the path to the directory with the library
-archives. By default the path is extracted from `m_librarian.conf`,
+archives. By default the path is extracted from configuration file,
 section `[library]`, key `path`::
 
     [library]
@@ -165,6 +170,14 @@ section `[library]`, key `path`::
 
 The option is useful for multiple databases (global option `-D`).
 
+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
@@ -249,4 +262,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 :