Pass format of the downloaded file name in the command line

[m_librarian.git] / docs / command_line.rst

diff --git a/docs/command_line.rst b/docs/command_line.rst
index 5125d0e6dc9f6a588b6f654bb8b8b075b394ea57..2196791d417609bb909f923a284b62cf7aac4b72 100644 (file)
--- a/docs/command_line.rst
+++ b/docs/command_line.rst
@@ -118,7 +118,7 @@ Book searching and downloading
 
 Usage::
 
-    ml-search.py books [-t title] [-s series] [-a archive] [-f file] [-p path] [--get] [--get-many N] [--id id] [--surname name] [--name name] [--misc-name name] [--fullname name] [--aid aid] [-e ext] [--eid eid] [--gname name] [--gtitle title] [--gid gid] [-l lang] [--lid lid]
+    ml-search.py books [-t title] [-s series] [-a archive] [-f file] [-p path] [--format f] [--get] [--get-many N] [--id id] [--surname name] [--name name] [--misc-name name] [--fullname name] [--aid aid] [-e ext] [--eid eid] [--gname name] [--gtitle title] [--gid gid] [-l lang] [--lid lid]
 
 Search and print a list of books by title, series, archive or file name.
 
@@ -130,6 +130,7 @@ Options::
     -f, --file file        Search by file name (without extension)
     -p, --path path        Path to the directory with the library
                            archives
+    --format format        Format of the downloaded file name
     --get                  Download exactly one book
     --get-many N           Download at most this many books
     --id id                Search by database id
@@ -191,6 +192,8 @@ Format must not end in directory separator (`/` or `\\`). If specifier
 unconditionally with a dot. That is, format `%f` is equivalent to
 `%f.%e`.
 
+Option `--format format` allows to overwrite this configuration value.
+
 Option `--get-many N` allows to download many books (at most N, where N
 is an integer). Options `--get-many N` and `--get` are, of course,
 mutually incompatible.