X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=man%2Flightcards.1.md;h=eb83e03df2f56e8fe5490c9668206c636887f739;hb=dc6c791fb09b9e5aab0eec970fdca707cd70dc47;hp=0cc98b280e80be8987a82355a83e0370f16a1217;hpb=b663abd549167725daeb51249419500bbf8c41f0;p=lightcards.git diff --git a/man/lightcards.1.md b/man/lightcards.1.md index 0cc98b2..eb83e03 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -1,46 +1,45 @@ -% lightcards(1) 0.5.0 -% Armaan Bhojwani -% February 2021 +--- +title: lightcards +section: 1 +header: General Commands Manual +footer: VERSION_HERE +date: February 2021 +--- # NAME 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 (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 +**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 -**-a**, **--alphabetize** -: Alphabetize card order +**-v**, **\--version** +: Print version and exit -**-f**, **--flip** -: Show second column first +## Startup options +**-a**, **\--alphabetize** +: Alphabetize card order -**-p**, **--purge** +**-p**, **\--purge** : Purge cache for chosen set -**-P**, **--purge-all** -: Purge all caches - -**-r**, **--reverse** +**-r**, **\--reverse** : Reverse card order -**-s**, **--shuffle** +**-s**, **\--shuffle** : Shuffle card order -**-v**, **--version** -: Print version and exit +**-V** \[1-3\], **\--view** \[1-3\] +: Specify startup view -# KEYBINDINGS +# KEYS **l**, **right** : Next card @@ -68,18 +67,24 @@ lightcards [[options]] [input file] **m** : Open control menu -# EXIT VALUES +**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 +# BUGS https://lists.sr.ht/~armaan/public-inbox # COPYRIGHT -Copyright 2021 Armaan Bhojwani . MIT License +Copyright 2021 Armaan Bhojwani , MIT License.