]> git.armaanb.net Git - phrases.git/blobdiff - man/phrases-extract.1.md
Add phrases-extract manpage
[phrases.git] / man / phrases-extract.1.md
diff --git a/man/phrases-extract.1.md b/man/phrases-extract.1.md
new file mode 100644 (file)
index 0000000..b22a08b
--- /dev/null
@@ -0,0 +1,38 @@
+% phrases-extract(1) 1.0.1
+% Armaan Bhojwani
+% January 2021
+
+# NAME
+phrases-extract - Extract Latin famous phrases from Wikipedia
+
+# SYNOPSIS
+phrases-extract [[options]]
+
+# DESCRIPTION
+**phrases-extract** is a Python script that converts the Wikipedia table of Latin famous phrases into a SQLite3 database for use with the **phrases** program
+
+# OPTIONS
+**-h**, **--help**
+: Show a help message and exit
+
+**-o** [file], **--output** [file]
+: Specify the output file location. Default = ./phrases.db
+
+**-v**, **--version**
+: Print version
+
+# EXIT VALUES
+**0**
+: Success
+
+**2**
+: Invalid option
+
+# SEE ALSO
+  **phrases(1)**
+
+# BUGS, PATCHES
+https://lists.sr.ht/~armaan/public-inbox
+
+# COPYRIGHT
+Copyright 2021 Armaan Bhojwani <me@armaanb.net>. MIT License