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 file\]
  14
  15 # DESCRIPTION
  16 **lightcards** is a Python program that reads data from a two column Markdown (and by extension, HTML) table in the **input file**, 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 # KEYS
  43 **l**, **right**
  44 : Next card
  45
  46 **h**, **left**
  47 : Previous card
  48
  49 **j**, **k**, **up**, **down**
  50 : Flip card
  51
  52 **i**, **/**
  53 : Star card
  54
  55 **0**, **^**, **home**
  56 : Go to start of deck
  57
  58 **$**, **end**
  59 : Go to end of deck
  60
  61 **H**, **?**
  62 : Open help screen
  63
  64 **e**
  65 : Open input file in $EDITOR
  66
  67 **m**
  68 : Open control menu
  69
  70 **1**, **2**
  71 : Switch views
  72
  73 # INPUT FILE
  74 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.
  75
  76 # EXIT STATUS
  77 **0**
  78 : Success
  79
  80 **1**
  81 : Parse error
  82
  83 **2**
  84 : Invalid option
  85
  86 # BUGS
  87 https://lists.sr.ht/~armaan/public-inbox
  88
  89 # COPYRIGHT
  90 Copyright 2021 Armaan Bhojwani <me@armaanb.net>, MIT License.