]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1.md
Remove CursesError exception
[lightcards.git] / man / lightcards.1.md
index 615b857ca58b65ac24b4b2c170908ef1e77e6dcb..40d8783b9280171e0114422c8f04ff2b579221d3 100644 (file)
@@ -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
@@ -64,8 +73,11 @@ lightcards \[options\] \[input file\]
 **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.
@@ -83,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