X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=man%2Flightcards.1.md;h=90d0c1ae38d12ee94ce61422c547f3971c0499c9;hb=687fb8dc4e088723e7935d3030e5d38b9b294776;hp=96e8cccdc1aeecf1c06d03e8ff33e3549c566abb;hpb=e1326f7ecacb027aeb573bbf804f6e8df5a1e2da;p=lightcards.git diff --git a/man/lightcards.1.md b/man/lightcards.1.md index 96e8ccc..90d0c1a 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -1,15 +1,15 @@ -% 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] # 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,8 +19,42 @@ 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 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**