man/lightcards.1.md

   1 ---
   2 title: lightcards
   3 section: 1
   4 header: General Commands Manual
   5 footer: VERSION_HERE
   6 date: February 2021
   7 ---
   8
   9 # NAME
  10 lightcards - terminal flashcards from Markdown
  11
  12 # SYNOPSIS
  13 lightcards \[options\] \[input files\]
  14
  15 # DESCRIPTION
  16 **lightcards** is a Python program that reads data from two column Markdown (and by extension, HTML) tables from the **input files**, and displays flashcards from their contents.
  17
  18 # OPTIONS
  19 ## Generic Program Information
  20 **-h**, **\--help**
  21 : Show a help message and exit
  22
  23 **-v**, **\--version**
  24 : Print version and exit
  25
  26 ## Startup options
  27 **-a**, **\--alphabetize**
  28 : Alphabetize card order
  29
  30 **-p**, **\--purge**
  31 : Purge cache for chosen set
  32
  33 **-r**, **\--reverse**
  34 : Reverse card order
  35
  36 **-s**, **\--shuffle**
  37 : Shuffle card order
  38
  39 **-V** \[1-3\], **\--view** \[1-3\]
  40 : Specify startup view
  41
  42 **-c** \[config file\], **\--config** \[config file\]
  43 : Specify a custom config file
  44
  45 **-l**, **\--lenient**
  46 : Don't raise exception if tables are malformed
  47
  48 **-t** \[int\], **\--table** \[int\]
  49 : If multiple tables are provided in the input files, specify which
  50
  51 # KEYS
  52 **l**, **right**
  53 : Next card
  54
  55 **h**, **left**
  56 : Previous card
  57
  58 **j**, **k**, **up**, **down**
  59 : Flip card
  60
  61 **i**, **/**
  62 : Star card
  63
  64 **0**, **^**, **home**
  65 : Go to start of deck
  66
  67 **$**, **end**
  68 : Go to end of deck
  69
  70 **H**, **?**
  71 : Open help screen
  72
  73 **m**
  74 : Open control menu
  75
  76 **1**, **2**, **3**
  77 : Switch views between front first, back first, and both
  78
  79 **q**
  80 : Quit
  81
  82 # INPUT FILE
  83 Lightcards takes the first table from a valid Markdown or HTML file. Each row is a card, and the two columns are the front and back.
  84
  85 # EXIT STATUS
  86 **0**
  87 : Success
  88
  89 **1**
  90 : Parse error
  91
  92 **2**
  93 : Invalid option
  94
  95 **3**
  96 : Curses error
  97
  98 **4**
  99 : Config error
 100
 101 # SEE ALSO
 102   **lightcards-config(5)**
 103
 104 # BUGS
 105 https://lists.sr.ht/~armaan/public-inbox
 106
 107 # COPYRIGHT
 108 Copyright 2021 Armaan Bhojwani <me@armaanb.net>, MIT License.