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