X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=man%2Flightcards.1.md;h=f57fd1e28c351af3b74a6d158311b725d09b6435;hb=f8dbb2a02277188e677bb89ffdacb13a270df35e;hp=42259ec619f3992311ff63158af43008a28b9df2;hpb=09185557a67a1216b9c61d7a7055f347632df07d;p=lightcards.git diff --git a/man/lightcards.1.md b/man/lightcards.1.md index 42259ec..f57fd1e 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -1,22 +1,69 @@ -% lightcards(1) 0.0.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]] +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 +**-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 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 + +**m** +: Open control menu # EXIT VALUES **0**