]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1
Remove CursesError exception
[lightcards.git] / man / lightcards.1
index 7bf1cc1b0c4bdf6e68ef19dde8cf74f7fb876e53..d12d70ba6918fbae877b6ee85983439a7aeddf0c 100644 (file)
@@ -1,42 +1,51 @@
 .\" Automatically generated by Pandoc 2.11.3
 .\"
-.TH "lightcards" "1" "February 2021" "lightcards 0.6.0" "General Commands Manual"
+.TH "lightcards" "1" "February 2021" "lightcards 0.7.0" "General Commands Manual"
 .hy
 .SH NAME
 .PP
 lightcards - terminal flashcards from Markdown
 .SH SYNOPSIS
 .PP
-lightcards [options] [input file]
+lightcards [options] [input files]
 .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 in the \f[B]input
-file\f[R], and displays flashcards from their contents.
+\f[B]lightcards\f[R] is a Python program that reads data from two column
+Markdown (and by extension, HTML) tables from the \f[B]input files\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]-v\f[R], \f[B]\[en]version\f[R]
+\f[B]-v\f[R], \f[B]--version\f[R]
 Print version and exit
-.SS Stack sorting
+.SS Startup options
 .TP
-\f[B]-a\f[R], \f[B]\[en]alphabetize\f[R]
+\f[B]-a\f[R], \f[B]--alphabetize\f[R]
 Alphabetize card order
 .TP
-\f[B]-f\f[R], \f[B]\[en]flip\f[R]
-Show second column first
-.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]-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] [1-3], \f[B]--view\f[R] [1-3]
+Specify startup view
+.TP
+\f[B]-c\f[R] [config file], \f[B]--config\f[R] [config file]
+Specify a custom config file
+.TP
+\f[B]-l\f[R], \f[B]--lenient\f[R]
+Don\[cq]t raise exception if tables are malformed
+.TP
+\f[B]-t\f[R] [int], \f[B]--table\f[R] [int]
+If multiple tables are provided in the input files, specify which
 .SH KEYS
 .TP
 \f[B]l\f[R], \f[B]right\f[R]
@@ -60,14 +69,14 @@ Go to end of deck
 \f[B]H\f[R], \f[B]?\f[R]
 Open help screen
 .TP
-\f[B]e\f[R]
-Open input file in $EDITOR
-.TP
 \f[B]m\f[R]
 Open control menu
 .TP
-\f[B]1\f[R], \f[B]2\f[R]
-Switch views
+\f[B]1\f[R], \f[B]2\f[R], \f[B]3\f[R]
+Switch views between front first, back first, and both
+.TP
+\f[B]q\f[R]
+Quit
 .SH INPUT FILE
 .PP
 Lightcards takes the first table from a valid Markdown or HTML file.
@@ -82,6 +91,15 @@ Parse error
 .TP
 \f[B]2\f[R]
 Invalid option
+.TP
+\f[B]3\f[R]
+Curses error
+.TP
+\f[B]4\f[R]
+Config error
+.SH SEE ALSO
+.PP
+\f[B]lightcards-config(5)\f[R]
 .SH BUGS
 .PP
 https://lists.sr.ht/\[ti]armaan/public-inbox