man/lightcards.1.md

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