man/lightcards.1

   1 .\" Automatically generated by Pandoc 2.11.3
   2 .\"
   3 .TH "lightcards" "1" "January 2021" "0.2.0" ""
   4 .hy
   5 .SH NAME
   6 .PP
   7 Lightcards - simple terminal flashcards.
   8 .SH SYNOPSIS
   9 .PP
  10 lightcards [options] [input file]
  11 .SH DESCRIPTION
  12 .PP
  13 \f[B]lightcards\f[R] is a Python program that reads data from a two
  14 column Markdown or HTML table, and displays flashcards based on their
  15 contents.
  16 .SH POSITIONAL ARGUMENTS
  17 .TP
  18 \f[B]input file\f[R]
  19 Relative or absolute path to the input Markdown or HTML file
  20 .SH OPTIONS
  21 .TP
  22 \f[B]-h\f[R], \f[B]\[en]help\f[R]
  23 Show a help message and exit
  24 .TP
  25 \f[B]-r\f[R], \f[B]\[en]reverse\f[R]
  26 Reverse card order.
  27 Has no effect when shuffling as well
  28 .TP
  29 \f[B]-s\f[R], \f[B]\[en]shuffle\f[R]
  30 Shuffle card order
  31 .TP
  32 \f[B]-v\f[R], \f[B]\[en]version\f[R]
  33 Print version and exit
  34 .SH EXIT VALUES
  35 .TP
  36 \f[B]0\f[R]
  37 Success
  38 .TP
  39 \f[B]1\f[R]
  40 Cannot find input file
  41 .TP
  42 \f[B]2\f[R]
  43 Invalid option
  44 .SH BUGS, PATCHES
  45 .PP
  46 https://lists.sr.ht/\[ti]armaan/public-inbox
  47 .SH COPYRIGHT
  48 .PP
  49 Copyright 2021 Armaan Bhojwani <me@armaanb.net>.
  50 MIT License
  51 .SH AUTHORS
  52 Armaan Bhojwani.