man/phrases.1

   1 .\" Automatically generated by Pandoc 2.11.3
   2 .\"
   3 .TH "phrases" "1" "January 2021" "1.0.1" ""
   4 .hy
   5 .SH NAME
   6 .PP
   7 phrases - Latin famous phrases in the terminal
   8 .SH SYNOPSIS
   9 .PP
  10 phrases [options]
  11 .SH DESCRIPTION
  12 .PP
  13 \f[B]phrases\f[R] is a Python script that reads Latin famous phrases
  14 from a SQLite database and returns them randomly according to a set of
  15 user-defined parameters given through the CLI options.
  16 .SH OPTIONS
  17 .TP
  18 \f[B]-h\f[R], \f[B]\[en]help\f[R]
  19 Show a help message and exit
  20 .TP
  21 \f[B]-i\f[R], \f[B]\[en]id\f[R]
  22 Print the id of the phrase.
  23 .TP
  24 \f[B]-l\f[R], \f[B]\[en]latin\f[R]
  25 Print the Latin phrase (default)
  26 .TP
  27 \f[B]-e\f[R], \f[B]\[en]english\f[R]
  28 Print the English translation.
  29 .TP
  30 \f[B]-n\f[R], \f[B]\[en]notes\f[R]
  31 Print any notes on phrase.
  32 .TP
  33 \f[B]-v\f[R], \f[B]\[en]version\f[R]
  34 Print version
  35 .TP
  36 \f[B]-m\f[R] [length], \f[B]\[en]min\f[R] [length]
  37 Set the minimum length of the Latin phrase.
  38 .TP
  39 \f[B]-M\f[R] [length], \f[B]\[en]max\f[R] [length]
  40 Set the maximum length of Latin phrase.
  41 .TP
  42 \f[B]-p\f[R], \f[B]\[en]num\f[R]
  43 Print number of possible phrases.
  44 .TP
  45 \f[B]-f\f[R] [path], \f[B]\[en]file\f[R] [path]
  46 Set the path of the phrase database.
  47 .SH EXAMPLES
  48 .TP
  49 \f[B]phrases\f[R]
  50 Display a random Latin phrase
  51 .TP
  52 \f[B]phrases -len\f[R]
  53 Display a random Latin phrase, its English translation, and any notes on
  54 it
  55 .TP
  56 \f[B]phrases -p -m 10 -M 15\f[R]
  57 Display the number of phrases in the database with a length between 10
  58 and 15 inclusive.
  59 .SH EXIT VALUES
  60 .TP
  61 \f[B]0\f[R]
  62 Success
  63 .TP
  64 \f[B]1\f[R]
  65 Cannot find phrase database
  66 .TP
  67 \f[B]2\f[R]
  68 Invalid option
  69 .SH SEE ALSO
  70 .PP
  71 \f[B]phrases-extract(1)\f[R]
  72 .SH BUGS, PATCHES
  73 .PP
  74 https://lists.sr.ht/\[ti]armaan/public-inbox
  75 .SH COPYRIGHT
  76 .PP
  77 Copyright 2021 Armaan Bhojwani <me@armaanb.net>.
  78 MIT License
  79 .SH AUTHORS
  80 Armaan Bhojwani.