X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=man%2Flightcards.1.md;h=e79e47843a36d4acab5c695b33704ad9a128d5a5;hb=1a5fa0cc2280ad40bc170fae389fe85f5aa74b52;hp=5fc0aed6810459e6387546752adc35f6a2aea691;hpb=a446e7eded68f8ea4bbcbf08daa795cf851af73c;p=lightcards.git diff --git a/man/lightcards.1.md b/man/lightcards.1.md index 5fc0aed..e79e478 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -1,15 +1,15 @@ -% lightcards(1) 0.2.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,11 +19,17 @@ 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. Has no effect when shuffling as well +: Reverse card order **-s**, **--shuffle** : Shuffle card order @@ -31,12 +37,43 @@ 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 + +**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 **1** -: Cannot find input file +: Parse error **2** : Invalid option