X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=man%2Flightcards.1.md;h=40d8783b9280171e0114422c8f04ff2b579221d3;hb=HEAD;hp=78865eb874333166dfaf26ad5098ecdec331ef82;hpb=3ffbf7f20f3bdb8a162e2ecab608ac0a013a4b3c;p=lightcards.git diff --git a/man/lightcards.1.md b/man/lightcards.1.md index 78865eb..40d8783 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -10,10 +10,10 @@ date: February 2021 lightcards - terminal flashcards from Markdown # SYNOPSIS -lightcards \[options\] \[input file\] +lightcards \[options\] \[input files\] # DESCRIPTION -**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. +**lightcards** is a Python program that reads data from two column Markdown (and by extension, HTML) tables from the **input files**, and displays flashcards from their contents. # OPTIONS ## Generic Program Information @@ -39,6 +39,15 @@ lightcards \[options\] \[input file\] **-V** \[1-3\], **\--view** \[1-3\] : Specify startup view +**-c** \[config file\], **\--config** \[config file\] +: Specify a custom config file + +**-l**, **\--lenient** +: Don't raise exception if tables are malformed + +**-t** \[int\], **\--table** \[int\] +: If multiple tables are provided in the input files, specify which + # KEYS **l**, **right** : Next card @@ -61,14 +70,14 @@ lightcards \[options\] \[input file\] **H**, **?** : Open help screen -**e** -: Open input file in $EDITOR - **m** : Open control menu -**1**, **2** -: Switch views +**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. @@ -86,6 +95,12 @@ Lightcards takes the first table from a valid Markdown or HTML file. Each row is **3** : Curses error +**4** +: Config error + +# SEE ALSO + **lightcards-config(5)** + # BUGS https://lists.sr.ht/~armaan/public-inbox