Handle exceptions and exit codes better

[lightcards.git] / man / lightcards.1

diff --git a/man/lightcards.1 b/man/lightcards.1
index a763c38894341ebed721e65f53afbdd7acda6a30..37b3866eea7b206eb27867d399639ae7bf40d54e 100644 (file)
--- a/man/lightcards.1
+++ b/man/lightcards.1
@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 2.11.3
 .\"
-.TH "lightcards" "1" "February 2021" "0.6.0" ""
+.TH "lightcards" "1" "February 2021" "lightcards 0.6.0" "General Commands Manual"
 .hy
 .SH NAME
 .PP
@@ -11,38 +11,33 @@ lightcards [options] [input file]
 .SH DESCRIPTION
 .PP
 \f[B]lightcards\f[R] is a Python program that reads data from a two
-column Markdown (and by extension, HTML) table, and displays flashcards
-from their contents.
-.SH POSITIONAL ARGUMENTS
-.TP
-\f[B]input file\f[R]
-Relative or absolute path to the input Markdown or HTML file
+column Markdown (and by extension, HTML) table in the \f[B]input
+file\f[R], and displays flashcards from their contents.
 .SH OPTIONS
+.SS Generic Program Information
 .TP
-\f[B]-h\f[R], \f[B]\[en]help\f[R]
+\f[B]-h\f[R], \f[B]--help\f[R]
 Show a help message and exit
 .TP
-\f[B]-a\f[R], \f[B]\[en]alphabetize\f[R]
-Alphabetize card order
+\f[B]-v\f[R], \f[B]--version\f[R]
+Print version and exit
+.SS Startup options
 .TP
-\f[B]-f\f[R], \f[B]\[en]flip\f[R]
-Show second column first
+\f[B]-a\f[R], \f[B]--alphabetize\f[R]
+Alphabetize card order
 .TP
-\f[B]-p\f[R], \f[B]\[en]purge\f[R]
+\f[B]-p\f[R], \f[B]--purge\f[R]
 Purge cache for chosen set
 .TP
-\f[B]-P\f[R], \f[B]\[en]purge-all\f[R]
-Purge all caches
-.TP
-\f[B]-r\f[R], \f[B]\[en]reverse\f[R]
+\f[B]-r\f[R], \f[B]--reverse\f[R]
 Reverse card order
 .TP
-\f[B]-s\f[R], \f[B]\[en]shuffle\f[R]
+\f[B]-s\f[R], \f[B]--shuffle\f[R]
 Shuffle card order
 .TP
-\f[B]-v\f[R], \f[B]\[en]version\f[R]
-Print version and exit
-.SH KEYBINDINGS
+\f[B]-V\f[R] [1-3], \f[B]--view\f[R] [1-3]
+Specify startup view
+.SH KEYS
 .TP
 \f[B]l\f[R], \f[B]right\f[R]
 Next card
@@ -70,22 +65,29 @@ Open input file in $EDITOR
 .TP
 \f[B]m\f[R]
 Open control menu
-.SH EXIT VALUES
+.TP
+\f[B]1\f[R], \f[B]2\f[R]
+Switch views
+.SH INPUT FILE
+.PP
+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.
+.SH EXIT STATUS
 .TP
 \f[B]0\f[R]
 Success
 .TP
 \f[B]1\f[R]
-Cannot find input file
+Parse error
 .TP
 \f[B]2\f[R]
 Invalid option
-.SH BUGS, PATCHES
+.TP
+\f[B]3\f[R]
+Curses error
+.SH BUGS
 .PP
 https://lists.sr.ht/\[ti]armaan/public-inbox
 .SH COPYRIGHT
 .PP
-Copyright 2021 Armaan Bhojwani <me@armaanb.net>.
-MIT License
-.SH AUTHORS
-Armaan Bhojwani.
+Copyright 2021 Armaan Bhojwani <me@armaanb.net>, MIT License.