man/lightcards.1.md

   1 % lightcards(1) 0.6.0
   2 % Armaan Bhojwani
   3 % February 2021
   4
   5 # NAME
   6 lightcards - terminal flashcards from Markdown
   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 (and by extension, HTML) table, and displays flashcards from 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 **-a**, **--alphabetize**
  23 : Alphabetize card order
  24
  25 **-f**, **--flip**
  26 : Show second column first
  27
  28 **-p**, **--purge**
  29 : Purge cache for chosen set
  30
  31 **-r**, **--reverse**
  32 : Reverse card order
  33
  34 **-s**, **--shuffle**
  35 : Shuffle card order
  36
  37 **-v**, **--version**
  38 : Print version and exit
  39
  40 # KEYBINDINGS
  41 **l**, **right**
  42 : Next card
  43
  44 **h**, **left**
  45 : Previous card
  46
  47 **j**, **k**, **up**, **down**
  48 : Flip card
  49
  50 **i**, **/**
  51 : Star card
  52
  53 **0**, **^**, **home**
  54 : Go to start of deck
  55
  56 **$**, **end**
  57 : Go to end of deck
  58
  59 **H**, **?**
  60 : Open help screen
  61
  62 **e**
  63 : Open input file in $EDITOR
  64
  65 **m**
  66 : Open control menu
  67
  68 # INPUT FILE
  69 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.
  70
  71 # EXIT VALUES
  72 **0**
  73 : Success
  74
  75 **1**
  76 : Cannot find input file
  77
  78 **2**
  79 : Invalid option
  80
  81 # BUGS, PATCHES
  82 https://lists.sr.ht/~armaan/public-inbox
  83
  84 # COPYRIGHT
  85 Copyright 2021 Armaan Bhojwani <me@armaanb.net>. MIT License