man/phrases.1.md

   1 % phrases(1) 1.0.1
   2 % Armaan Bhojwani
   3 % January 2021
   4
   5 # NAME
   6 phrases - Latin famous phrases in the terminal
   7
   8 # SYNOPSIS
   9 phrases [[options]]
  10
  11 # DESCRIPTION
  12 **phrases** 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.
  13
  14 # OPTIONS
  15 **-h**, **--help**
  16 : Show a help message and exit
  17
  18 **-i**, **--id**
  19 : Print the id of the phrase.
  20
  21 **-l**, **--latin**
  22 : Print the Latin phrase (default)
  23
  24 **-e**, **--english**
  25 : Print the English translation.
  26
  27 **-n**, **--notes**
  28 : Print any notes on phrase.
  29
  30 **-v**, **--version**
  31 : Print version
  32
  33 **-m** [length], **--min** [length]
  34 : Set the minimum length of the Latin phrase.
  35
  36 **-M** [length], **--max** [length]
  37 : Set the maximum length of Latin phrase.
  38
  39 **-p**, **--num**
  40 : Print number of possible phrases.
  41
  42 **-f** [path], **--file** [path]
  43 : Set the path of the phrase database.
  44
  45 # EXAMPLES
  46 **phrases**
  47 : Display a random Latin phrase
  48
  49 **phrases -len**
  50 : Display a random Latin phrase, its English translation, and any notes on it
  51
  52 **phrases -p -m 10 -M 15**
  53 : Display the number of phrases in the database with a length between 10 and 15 inclusive.
  54
  55 # EXIT VALUES
  56 **0**
  57 : Success
  58
  59 **1**
  60 : Cannot find phrase database
  61
  62 **2**
  63 : Invalid option
  64
  65 # SEE ALSO
  66   **phrases-extract(1)**
  67
  68 # BUGS, PATCHES
  69 https://lists.sr.ht/~armaan/public-inbox
  70
  71 # COPYRIGHT
  72 Copyright 2021 Armaan Bhojwani <me@armaanb.net>. MIT License