X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=docs%2Fcommand_line.rst;h=2905b2680fd06bcd92da45b58c8135608b3e5314;hb=refs%2Ftags%2F0.0.9;hp=0fab06b7cac295396fc2594540b4e8be3d516144;hpb=fc42dcaa2908ea3d5f7e1db5d4a777bbac9a05b4;p=m_librarian.git diff --git a/docs/command_line.rst b/docs/command_line.rst index 0fab06b..2905b26 100644 --- a/docs/command_line.rst +++ b/docs/command_line.rst @@ -31,7 +31,7 @@ ml-search.py Usage:: - ml-search.py [-i] [-I] [-t] [-s] [-f] [-d] ... + ml-search.py [-i] [-I] [-t] [-s] [-f] [-d] [-c] ... Search through the database and display results. Currently can only search authors by name. @@ -46,6 +46,7 @@ Global options:: -f, --full search type: match the full string -d, --details Output more details about found objects; repeat for even more details + -c, --count Output count of found objects 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 @@ -70,7 +71,7 @@ Author search Usage:: - ml-search.py [-i/-I] [-t/-s/-f] author [-s surname] [-n name] [-m misc-name] [fullname] + ml-search.py [-i/-I] [-t/-s/-f] author [-s surname] [-n name] [-m misc-name] [--id id] [fullname] Search and print a list of authors by surname/name/misc name/full name. @@ -79,6 +80,7 @@ Options:: -s, --surname surname Search by surname -n, --name name Search by name -m, --misc-name misc. name Search by misc. name + --id id Search by database id Example:: @@ -103,7 +105,7 @@ Book search Usage:: - 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] + ml-search.py [-i/-I] [-t/-s/-f] 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] Search and print a list of books by title, series, archive or file name. @@ -113,14 +115,19 @@ Options:: -s, --series series Search by series -a, --archive archive Search by archive (zip file) -f, --file file Search by file name (without extension) + --id id Search by database id --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 + --aid aid Search by author’s id -e, --ext ext Search by file extension + --eid eid Search by extension’s id --gname name Search by genre’s name --gtitle title Search by genre’s title + --gid gid Search by genre’s id -l, --lang lang Search by language + --lid lid Search by language’s id By default the program prints only titles of the found book. With one option `-d` it also prints database id, the list of authors and genres, @@ -136,7 +143,11 @@ Extension search Usage:: - ml-search.py [-i/-I] [-t/-s/-f] ext [name] + ml-search.py [-i/-I] [-t/-s/-f] ext [name] [--id id] + +Options:: + + --id id Search by database id Search and print a list of extensions by name. @@ -148,7 +159,7 @@ Genres search Usage:: - ml-search.py [-i/-I] [-t/-s/-f] genres [-n name] [-t title] + ml-search.py [-i/-I] [-t/-s/-f] genres [-n name] [-t title] [--id id] Search and print a list of genres by name and title. @@ -156,6 +167,7 @@ Options:: -n, --name name Search by name -t, --title title Search by title + --id id Search by database id With one option `-d` it also prints database id. @@ -165,10 +177,14 @@ Language search Usage:: - ml-search.py [-i/-I] [-t/-s/-f] lang [name] + ml-search.py [-i/-I] [-t/-s/-f] lang [name] [--id id] Search and print a list of languages by name. +Options:: + + --id id Search by database id + With one option `-d` it also prints database id. .. vim: set tw=72 :