X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=docs%2Fcommand_line.rst;h=e7421435d057888d960c3f2fdbecad65c44462a7;hb=HEAD;hp=2196791d417609bb909f923a284b62cf7aac4b72;hpb=8d0cd0faf04cf7a988b77d6fe2a4285444a2f3ea;p=m_librarian.git diff --git a/docs/command_line.rst b/docs/command_line.rst index 2196791..e742143 100644 --- a/docs/command_line.rst +++ b/docs/command_line.rst @@ -6,17 +6,19 @@ Command-line scripts .. contents:: :local: +.. highlight:: none ml-initdb.py ------------ Usage:: - ml-initdb.py [-d] + ml-initdb.py [-C] [-D] Options:: - -d, --database database Open this database by pathname/db uri + -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 the next script does all that too. @@ -27,11 +29,13 @@ ml-import.py Usage:: - ml-import.py [-d] [file.inpx ...] + ml-import.py [-C] [-D] [-P] [file.inpx ...] Options:: - -d, --database database Open this database by pathname/db uri + -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 @@ -43,14 +47,15 @@ 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:: - -d, --database database Open this database by pathname/db uri + -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 -t, --start search type: substring at the start @@ -118,7 +123,7 @@ Book searching and downloading Usage:: - 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] + ml-search.py books [-t title] [-s series] [-a archive] [-f file] [--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] [-P path] [-F format] [--get] [--get-many N] Search and print a list of books by title, series, archive or file name. @@ -128,11 +133,6 @@ Options:: -s, --series series Search by series -a, --archive archive Search by archive (zip file) -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 --surname surname Search by author’s surname --name name Search by author’s name @@ -146,6 +146,13 @@ 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 By default the program prints only titles of the found book. With one option `-v` it also prints database id, the list of authors and genres, @@ -155,14 +162,33 @@ it also prints the file date and language. With three `-v` it prints 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`, +Option `-P` provides the path to the directory with the library +archives. By default the path is extracted from configuration file, section `[library]`, key `path`:: [library] path = /var/lib/archives -The option is useful for multiple databases (global option `-d`). +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 @@ -192,7 +218,7 @@ 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 `-F|--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, @@ -248,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 :