]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1.md
Bump version number
[lightcards.git] / man / lightcards.1.md
index 90ba1d480c99cc9896967bb88b6dbb5a2b2c9769..2871c12d638bf4328b14bd8dca06d04ff6407b27 100644 (file)
@@ -1,15 +1,15 @@
-% lightcards(1) 0.1.0
+% lightcards(1) 0.3.0
 % Armaan Bhojwani
 % January 2021
 
 # NAME
-Lightcards - simple terminal flashcards.
+lightcards - terminal flashcards from Markdown
 
 # SYNOPSIS
 lightcards [[options]] [input file]
 
 # DESCRIPTION
-**lightcards** is a Python program that reads data from a two column Markdown or HTML table, and displays flashcards based on their contents.
+**lightcards** is a Python program that reads data from a two column Markdown (and by extension, HTML) table, and displays flashcards from their contents.
 
 # POSITIONAL ARGUMENTS
 **input file**
@@ -19,12 +19,37 @@ lightcards [[options]] [input file]
 **-h**, **--help**
 : Show a help message and exit
 
+**-f**, **--flip**
+: Show second column first
+
+**-r**, **--reverse**
+: Reverse card order. Has no effect when shuffling as well
+
 **-s**, **--shuffle**
-: Shuffle cards before starting
+: Shuffle card order
 
 **-v**, **--version**
 : Print version and exit
 
+# KEYBINDINGS
+**l**, **right**
+: Next card
+
+**h**, **left**
+: Previous card
+
+**j**, **k**, **up**, **down**
+: Flip card
+
+**i**, **/**
+: Star card
+
+**0**, **^**, **home**
+: Go to start of deck
+
+**$**, **end**
+: Go to end of deck
+
 # EXIT VALUES
 **0**
 : Success