--- /dev/null
+.\" Automatically generated by Pandoc 2.11.3
+.\"
+.TH "phrases" "1" "January 2021" "1.0.0" ""
+.hy
+.SH NAME
+.PP
+phrases - Latin famous phrases in the terminal
+.SH SYNOPSIS
+.PP
+phrases [options]
+.SH DESCRIPTION
+.PP
+\f[B]phrases\f[R] is a Python script that reads Latin famous phrases
+from a SQLite database and returns them randomly according to a set of
+user-defined parameters given through the CLI options.
+.SH OPTIONS
+.TP
+\f[B]-h\f[R], \f[B]\[en]help\f[R]
+Show a help message and exit
+.TP
+\f[B]-i\f[R], \f[B]\[en]id\f[R]
+Print the id of the phrase.
+.TP
+\f[B]-l\f[R], \f[B]\[en]latin\f[R]
+Print the Latin phrase (default)
+.TP
+\f[B]-e\f[R], \f[B]\[en]english\f[R]
+Print the English translation.
+.TP
+\f[B]-n\f[R], \f[B]\[en]notes\f[R]
+Print any notes on phrase.
+.TP
+\f[B]-v\f[R], \f[B]\[en]version\f[R]
+Print version
+.TP
+\f[B]-m\f[R] [length], \f[B]\[en]min\f[R] [length]
+Set the minimum length of the Latin phrase.
+.TP
+\f[B]-M\f[R] [length], \f[B]\[en]max\f[R] [length]
+Set the maximum length of Latin phrase.
+.TP
+\f[B]-p\f[R], \f[B]\[en]num\f[R]
+Print number of possible phrases.
+.TP
+\f[B]-f\f[R] [path], \f[B]\[en]file\f[R] [path]
+Set the path of the phrase database.
+.SH EXAMPLES
+.TP
+\f[B]phrases\f[R]
+Display a random Latin phrase
+.TP
+\f[B]phrases -len\f[R]
+Display a random Latin phrase, its English translation, and any notes on
+it
+.TP
+\f[B]phrases -p -m 10 -M 15\f[R]
+Display the number of phrases in the database with a length between 10
+and 15 inclusive.
+.SH EXIT VALUES
+.TP
+\f[B]0\f[R]
+Success
+.TP
+\f[B]1\f[R]
+Cannot find phrase database
+.TP
+\f[B]2\f[R]
+Invalid option
+.SH BUGS, PATCHES
+.PP
+https://lists.sr.ht/\[ti]armaan/public-inbox
+.SH COPYRIGHT
+.PP
+Copyright 2021 Armaan Bhojwani <me@armaanb.net>.
+MIT License
+.SH AUTHORS
+Armaan Bhojwani <me@armaanb.net>.
projects / phrases.git / blobdiff