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 **-f**, **--flip**
  23 : Show second column first
  24
  25 **-r**, **--reverse**
  26 : Reverse card order. Has no effect when shuffling as well
  27
  28 **-s**, **--shuffle**
  29 : Shuffle card order
  30
  31 **-v**, **--version**
  32 : Print version and exit
  33
  34 # EXIT VALUES
  35 **0**
  36 : Success
  37
  38 **1**
  39 : Cannot find input file
  40
  41 **2**
  42 : Invalid option
  43
  44 # BUGS, PATCHES
  45 https://lists.sr.ht/~armaan/public-inbox
  46
  47 # COPYRIGHT
  48 Copyright 2021 Armaan Bhojwani <me@armaanb.net>. MIT License