Handle exceptions and exit codes better

[lightcards.git] / man / lightcards.1.md

diff --git a/man/lightcards.1.md b/man/lightcards.1.md
index b4db85f7aa8f7dc123a463e62ee6ddf3c1c3d82a..78865eb874333166dfaf26ad5098ecdec331ef82 100644 (file)
--- a/man/lightcards.1.md
+++ b/man/lightcards.1.md
@@ -1,43 +1,45 @@
-% 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**
-: Reverse card order. Has no effect when shuffling as well
+**-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
 
-# KEYBINDINGS
+# KEYS
 **l**, **right**
 : Next card
 
@@ -65,18 +67,27 @@ lightcards [[options]] [input file]
 **m**
 : Open control menu
 
-# EXIT VALUES
+**1**, **2**
+: Switch views
+
+# 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
+
+# BUGS
 https://lists.sr.ht/~armaan/public-inbox
 
 # COPYRIGHT
-Copyright 2021 Armaan Bhojwani <me@armaanb.net>. MIT License
+Copyright 2021 Armaan Bhojwani <me@armaanb.net>, MIT License.