X-Git-Url: https://git.armaanb.net/?p=lightcards.git;a=blobdiff_plain;f=man%2Flightcards.1.md;h=78865eb874333166dfaf26ad5098ecdec331ef82;hp=96e8cccdc1aeecf1c06d03e8ff33e3549c566abb;hb=3ffbf7f20f3bdb8a162e2ecab608ac0a013a4b3c;hpb=e1326f7ecacb027aeb573bbf804f6e8df5a1e2da diff --git a/man/lightcards.1.md b/man/lightcards.1.md index 96e8ccc..78865eb 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -1,39 +1,93 @@ -% lightcards(1) 0.0.0 -% Armaan Bhojwani -% January 2021 +--- +title: lightcards +section: 1 +header: General Commands Manual +footer: VERSION_HERE +date: 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 program that reads data from a two column Markdown or HTML table, and displays flashcards based on their contents. - -# POSITIONAL ARGUMENTS -**input file** -: Relative or absolute path to the input Markdown or HTML file +**lightcards** is a Python program that reads data from a two column Markdown (and by extension, HTML) table in the **input file**, and displays flashcards from their contents. # OPTIONS -**-h**, **--help** +## Generic Program Information +**-h**, **\--help** : Show a help message and exit -**-v**, **--version** -: Print version +**-v**, **\--version** +: Print version and exit + +## Startup options +**-a**, **\--alphabetize** +: Alphabetize card order + +**-p**, **\--purge** +: Purge cache for chosen set + +**-r**, **\--reverse** +: Reverse card order + +**-s**, **\--shuffle** +: Shuffle card order + +**-V** \[1-3\], **\--view** \[1-3\] +: Specify startup view + +# KEYS +**l**, **right** +: Next card + +**h**, **left** +: Previous card + +**j**, **k**, **up**, **down** +: Flip card -# EXIT VALUES +**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 + +**1**, **2** +: Switch views + +# 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 STATUS **0** : Success **1** -: Cannot find input file +: Parse error **2** : Invalid option -# BUGS, PATCHES +**3** +: Curses error + +# BUGS https://lists.sr.ht/~armaan/public-inbox # COPYRIGHT -Copyright 2021 Armaan Bhojwani . MIT License +Copyright 2021 Armaan Bhojwani , MIT License.