man/lightcards.1.md

   1 % lightcards(1) 0.4.0
   2 % Armaan Bhojwani
   3 % January 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 **-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 # KEYBINDINGS
  35 **l**, **right**
  36 : Next card
  37
  38 **h**, **left**
  39 : Previous card
  40
  41 **j**, **k**, **up**, **down**
  42 : Flip card
  43
  44 **i**, **/**
  45 : Star card
  46
  47 **0**, **^**, **home**
  48 : Go to start of deck
  49
  50 **$**, **end**
  51 : Go to end of deck
  52
  53 **H**, **?**
  54 : Open help screen
  55
  56 **e**
  57 : Open input file in $EDITOR
  58
  59 **m**
  60 : Open control menu
  61
  62 # EXIT VALUES
  63 **0**
  64 : Success
  65
  66 **1**
  67 : Cannot find input file
  68
  69 **2**
  70 : Invalid option
  71
  72 # BUGS, PATCHES
  73 https://lists.sr.ht/~armaan/public-inbox
  74
  75 # COPYRIGHT
  76 Copyright 2021 Armaan Bhojwani <me@armaanb.net>. MIT License