man/lightcards.1

   1 .\" Automatically generated by Pandoc 2.11.3
   2 .\"
   3 .TH "lightcards" "1" "January 2021" "0.1.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]-s\f[R], \f[B]\[en]shuffle\f[R]
  26 Shuffle cards before starting
  27 .TP
  28 \f[B]-v\f[R], \f[B]\[en]version\f[R]
  29 Print version and exit
  30 .SH EXIT VALUES
  31 .TP
  32 \f[B]0\f[R]
  33 Success
  34 .TP
  35 \f[B]1\f[R]
  36 Cannot find input file
  37 .TP
  38 \f[B]2\f[R]
  39 Invalid option
  40 .SH BUGS, PATCHES
  41 .PP
  42 https://lists.sr.ht/\[ti]armaan/public-inbox
  43 .SH COPYRIGHT
  44 .PP
  45 Copyright 2021 Armaan Bhojwani <me@armaanb.net>.
  46 MIT License
  47 .SH AUTHORS
  48 Armaan Bhojwani.