man/lightcards.1

   1 .\" Automatically generated by Pandoc 2.11.3
   2 .\"
   3 .TH "lightcards" "1" "February 2021" "lightcards 0.6.0" "General Commands Manual"
   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 in the \f[B]input
  15 file\f[R], and displays flashcards from their contents.
  16 .SH OPTIONS
  17 .SS Generic Program Information
  18 .TP
  19 \f[B]-h\f[R], \f[B]\[en]help\f[R]
  20 Show a help message and exit
  21 .TP
  22 \f[B]-v\f[R], \f[B]\[en]version\f[R]
  23 Print version and exit
  24 .SS Stack sorting
  25 .TP
  26 \f[B]-a\f[R], \f[B]\[en]alphabetize\f[R]
  27 Alphabetize card order
  28 .TP
  29 \f[B]-p\f[R], \f[B]\[en]purge\f[R]
  30 Purge cache for chosen set
  31 .TP
  32 \f[B]-r\f[R], \f[B]\[en]reverse\f[R]
  33 Reverse card order
  34 .TP
  35 \f[B]-s\f[R], \f[B]\[en]shuffle\f[R]
  36 Shuffle card order
  37 .SH KEYS
  38 .TP
  39 \f[B]l\f[R], \f[B]right\f[R]
  40 Next card
  41 .TP
  42 \f[B]h\f[R], \f[B]left\f[R]
  43 Previous card
  44 .TP
  45 \f[B]j\f[R], \f[B]k\f[R], \f[B]up\f[R], \f[B]down\f[R]
  46 Flip card
  47 .TP
  48 \f[B]i\f[R], \f[B]/\f[R]
  49 Star card
  50 .TP
  51 \f[B]0\f[R], \f[B]\[ha]\f[R], \f[B]home\f[R]
  52 Go to start of deck
  53 .TP
  54 \f[B]$\f[R], \f[B]end\f[R]
  55 Go to end of deck
  56 .TP
  57 \f[B]H\f[R], \f[B]?\f[R]
  58 Open help screen
  59 .TP
  60 \f[B]e\f[R]
  61 Open input file in $EDITOR
  62 .TP
  63 \f[B]m\f[R]
  64 Open control menu
  65 .TP
  66 \f[B]1\f[R], \f[B]2\f[R]
  67 Switch views
  68 .SH INPUT FILE
  69 .PP
  70 Lightcards takes the first table from a valid Markdown or HTML file.
  71 Each row is a card, and the two columns are the front and back.
  72 .SH EXIT STATUS
  73 .TP
  74 \f[B]0\f[R]
  75 Success
  76 .TP
  77 \f[B]1\f[R]
  78 Parse error
  79 .TP
  80 \f[B]2\f[R]
  81 Invalid option
  82 .SH BUGS
  83 .PP
  84 https://lists.sr.ht/\[ti]armaan/public-inbox
  85 .SH COPYRIGHT
  86 .PP
  87 Copyright 2021 Armaan Bhojwani <me@armaanb.net>, MIT License.