Bump version to 0.4.0

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

diff --git a/man/lightcards.1.md b/man/lightcards.1.md
index 42259ec619f3992311ff63158af43008a28b9df2..90d0c1ae38d12ee94ce61422c547f3971c0499c9 100644 (file)
--- a/man/lightcards.1.md
+++ b/man/lightcards.1.md
@@ -1,22 +1,60 @@
-% lightcards(1) 0.0.0
+% lightcards(1) 0.4.0
 % Armaan Bhojwani
 % January 2021
 
 # NAME
-Lightcards - simple terminal flashcards.
+lightcards - terminal flashcards from Markdown
 
 # SYNOPSIS
-lightcards [[options]] [[input file]]
+lightcards [[options]] [input file]
 
 # DESCRIPTION
-**lightcards** is a Python script that reads data from a markdown table, and creates flashcards from them.
+**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**
+: Relative or absolute path to the input Markdown or HTML file
 
 # OPTIONS
 **-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 card order
+
 **-v**, **--version**
-: Print 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
 
 # EXIT VALUES
 **0**