]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1.md
Add keybindings section to manpage
[lightcards.git] / man / lightcards.1.md
index 5fc0aed6810459e6387546752adc35f6a2aea691..de4e3b77038d4146eb6d871bf357d98aa0353652 100644 (file)
@@ -3,13 +3,13 @@
 % 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**
@@ -31,6 +31,25 @@ lightcards [[options]] [input file]
 **-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