]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1
Make control menu always accessible with "m"
[lightcards.git] / man / lightcards.1
index 9b8586f70a9c39f4873d42efb9b6b0973e484e21..1bd1ab9392f672c20ac766dfcbfd26d98c699917 100644 (file)
@@ -1,18 +1,18 @@
 .\" Automatically generated by Pandoc 2.11.3
 .\"
-.TH "lightcards" "1" "January 2021" "0.0.0" ""
+.TH "lightcards" "1" "January 2021" "0.4.0" ""
 .hy
 .SH NAME
 .PP
-Lightcards - simple terminal flashcards.
+lightcards - terminal flashcards from Markdown
 .SH SYNOPSIS
 .PP
 lightcards [options] [input file]
 .SH DESCRIPTION
 .PP
 \f[B]lightcards\f[R] is a Python program that reads data from a two
-column Markdown or HTML table, and displays flashcards based on their
-contents.
+column Markdown (and by extension, HTML) table, and displays flashcards
+from their contents.
 .SH POSITIONAL ARGUMENTS
 .TP
 \f[B]input file\f[R]
@@ -22,8 +22,46 @@ Relative or absolute path to the input Markdown or HTML file
 \f[B]-h\f[R], \f[B]\[en]help\f[R]
 Show a help message and exit
 .TP
+\f[B]-f\f[R], \f[B]\[en]flip\f[R]
+Show second column first
+.TP
+\f[B]-r\f[R], \f[B]\[en]reverse\f[R]
+Reverse card order.
+Has no effect when shuffling as well
+.TP
+\f[B]-s\f[R], \f[B]\[en]shuffle\f[R]
+Shuffle card order
+.TP
 \f[B]-v\f[R], \f[B]\[en]version\f[R]
-Print version
+Print version and exit
+.SH KEYBINDINGS
+.TP
+\f[B]l\f[R], \f[B]right\f[R]
+Next card
+.TP
+\f[B]h\f[R], \f[B]left\f[R]
+Previous card
+.TP
+\f[B]j\f[R], \f[B]k\f[R], \f[B]up\f[R], \f[B]down\f[R]
+Flip card
+.TP
+\f[B]i\f[R], \f[B]/\f[R]
+Star card
+.TP
+\f[B]0\f[R], \f[B]\[ha]\f[R], \f[B]home\f[R]
+Go to start of deck
+.TP
+\f[B]$\f[R], \f[B]end\f[R]
+Go to end of deck
+.TP
+\f[B]H\f[R], \f[B]?\f[R]
+Open help screen
+.TP
+\f[B]e\f[R]
+Open input file in $EDITOR
+.TP
+\f[B]m\f[R]
+Open control menu
 .SH EXIT VALUES
 .TP
 \f[B]0\f[R]