]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1.md
Add lightcards-config() manpage
[lightcards.git] / man / lightcards.1.md
index d3813f603d8d6fa87d27aa6e183eb38f49fc43be..0c5441ca52222be8e84abc56eb275b481a194a76 100644 (file)
@@ -2,7 +2,7 @@
 title: lightcards
 section: 1
 header: General Commands Manual
-footer: lightcards 0.6.0
+footer: VERSION_HERE
 date: February 2021
 ---
 
@@ -17,28 +17,31 @@ lightcards \[options\] \[input file\]
 
 # 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**
+: Specify a custom config file
+
 # KEYS
 **l**, **right**
 : Next card
@@ -61,12 +64,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 +86,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