X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=man%2Flightcards.1.md;h=24e3cd0129b179d63ac6da26f805333eb8b60cee;hb=cc885692662df0e7c92e23e42fc86ace4684eefd;hp=275733d5307ce0cc07d431aaaee2071e24ad3212;hpb=105a7c55741d2777306af63ad38dfc7f79a3b370;p=lightcards.git diff --git a/man/lightcards.1.md b/man/lightcards.1.md index 275733d..24e3cd0 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -1,43 +1,48 @@ -% lightcards(1) 0.4.0 -% Armaan Bhojwani -% January 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 -**-f**, **--flip** -: Show second column first +**-v**, **\--version** +: Print version and exit + +## 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 + +**-c** \[config file\], **\--config** \[config file\] +: Specify a custom config file -# KEYBINDINGS +# KEYS **l**, **right** : Next card @@ -59,24 +64,39 @@ lightcards [[options]] [input file] **H**, **?** : Open help screen -**e** -: Open input file in $EDITOR - **m** : Open control menu -# EXIT VALUES +**1**, **2**, **3** +: Switch views between front first, back first, and both + +**q** +: Quit + +# 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 + +**4** +: Config error + +# SEE ALSO + **lightcards-config(5)** + +# BUGS https://lists.sr.ht/~armaan/public-inbox # COPYRIGHT -Copyright 2021 Armaan Bhojwani . MIT License +Copyright 2021 Armaan Bhojwani , MIT License.