]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1.md
Remove CursesError exception
[lightcards.git] / man / lightcards.1.md
index 96b62ee0a7a5f94b1d3c3768d1d2c5d8adec63d7..40d8783b9280171e0114422c8f04ff2b579221d3 100644 (file)
@@ -10,35 +10,44 @@ 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
-**-h**, **--help**
+**-h**, **\--help**
 : Show a help message and exit
 
-**-v**, **--version**
+**-v**, **\--version**
 : Print version and exit
 
-## Stack sorting
-**-a**, **--alphabetize**
+## Startup options
+**-a**, **\--alphabetize**
 : Alphabetize card order
 
-**-f**, **--flip**
-: Show second column first
-
-**-p**, **--purge**
+**-p**, **\--purge**
 : Purge cache for chosen set
 
-**-r**, **--reverse**
+**-r**, **\--reverse**
 : Reverse card order
 
-**-s**, **--shuffle**
+**-s**, **\--shuffle**
 : Shuffle card order
 
+**-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,12 +70,15 @@ lightcards \[options\] \[input file\]
 **H**, **?**
 : Open help screen
 
-**e**
-: Open input file in $EDITOR
-
 **m**
 : Open control menu
 
+**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.
 
@@ -80,6 +92,15 @@ Lightcards takes the first table from a valid Markdown or HTML file. Each row is
 **2**
 : Invalid option
 
+**3**
+: Curses error
+
+**4**
+: Config error
+
+# SEE ALSO
+  **lightcards-config(5)**
+
 # BUGS
 https://lists.sr.ht/~armaan/public-inbox