man/lightcards.1

   1 .\" Automatically generated by Pandoc 2.11.3
   2 .\"
   3 .TH "lightcards" "1" "February 2021" "0.6.0" ""
   4 .hy
   5 .SH NAME
   6 .PP
   7 lightcards - terminal flashcards from Markdown
   8 .SH SYNOPSIS
   9 .PP
  10 lightcards [options] input file
  11 .SH DESCRIPTION
  12 .PP
  13 \f[B]lightcards\f[R] is a Python program that reads data from a two
  14 column Markdown (and by extension, HTML) table, and displays flashcards
  15 from their contents.
  16 .SH POSITIONAL ARGUMENTS
  17 .TP
  18 \f[B]input file\f[R]
  19 Relative or absolute path to the input Markdown or HTML file
  20 .SH OPTIONS
  21 .TP
  22 \f[B]-h\f[R], \f[B]\[en]help\f[R]
  23 Show a help message and exit
  24 .TP
  25 \f[B]-a\f[R], \f[B]\[en]alphabetize\f[R]
  26 Alphabetize card order
  27 .TP
  28 \f[B]-f\f[R], \f[B]\[en]flip\f[R]
  29 Show second column first
  30 .TP
  31 \f[B]-p\f[R], \f[B]\[en]purge\f[R]
  32 Purge cache for chosen set
  33 .TP
  34 \f[B]-r\f[R], \f[B]\[en]reverse\f[R]
  35 Reverse card order
  36 .TP
  37 \f[B]-s\f[R], \f[B]\[en]shuffle\f[R]
  38 Shuffle card order
  39 .TP
  40 \f[B]-v\f[R], \f[B]\[en]version\f[R]
  41 Print version and exit
  42 .SH KEYBINDINGS
  43 .TP
  44 \f[B]l\f[R], \f[B]right\f[R]
  45 Next card
  46 .TP
  47 \f[B]h\f[R], \f[B]left\f[R]
  48 Previous card
  49 .TP
  50 \f[B]j\f[R], \f[B]k\f[R], \f[B]up\f[R], \f[B]down\f[R]
  51 Flip card
  52 .TP
  53 \f[B]i\f[R], \f[B]/\f[R]
  54 Star card
  55 .TP
  56 \f[B]0\f[R], \f[B]\[ha]\f[R], \f[B]home\f[R]
  57 Go to start of deck
  58 .TP
  59 \f[B]$\f[R], \f[B]end\f[R]
  60 Go to end of deck
  61 .TP
  62 \f[B]H\f[R], \f[B]?\f[R]
  63 Open help screen
  64 .TP
  65 \f[B]e\f[R]
  66 Open input file in $EDITOR
  67 .TP
  68 \f[B]m\f[R]
  69 Open control menu
  70 .SH INPUT FILE
  71 .PP
  72 Lightcards takes the first table from a valid Markdown or HTML file.
  73 Each row is a card, and the two columns are the front and back.
  74 .SH EXIT VALUES
  75 .TP
  76 \f[B]0\f[R]
  77 Success
  78 .TP
  79 \f[B]1\f[R]
  80 Cannot find input file
  81 .TP
  82 \f[B]2\f[R]
  83 Invalid option
  84 .SH BUGS, PATCHES
  85 .PP
  86 https://lists.sr.ht/\[ti]armaan/public-inbox
  87 .SH COPYRIGHT
  88 .PP
  89 Copyright 2021 Armaan Bhojwani <me@armaanb.net>.
  90 MIT License
  91 .SH AUTHORS
  92 Armaan Bhojwani.