Add input file section to manpage

[lightcards.git] / man / lightcards.1.md

diff --git a/man/lightcards.1.md b/man/lightcards.1.md
index 90ba1d480c99cc9896967bb88b6dbb5a2b2c9769..f485c949ac8ea338f9b9278a87525d67c5332579 100644 (file)
--- a/man/lightcards.1.md
+++ b/man/lightcards.1.md
@@ -1,15 +1,15 @@
-% lightcards(1) 0.1.0
+% lightcards(1) 0.6.0
 % Armaan Bhojwani
-% January 2021
+% February 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,55 @@ lightcards [[options]] [input file]
 **-h**, **--help**
 : Show a help message and exit
 
+**-a**, **--alphabetize**
+: Alphabetize card order
+
+**-f**, **--flip**
+: Show second column first
+
+**-p**, **--purge**
+: Purge cache for chosen set
+
+**-r**, **--reverse**
+: Reverse card order
+
 **-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
+
+**H**, **?**
+: Open help screen
+
+**e**
+: Open input file in $EDITOR
+
+**m**
+: Open control menu
+
+# INPUT FILE
+Lightcards takes the first table from a valid Markdown or HTML file. Each row is a card, and the two columns are the front and back.
+
 # EXIT VALUES
 **0**
 : Success