]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1
Move edit file keybinding into control menu
[lightcards.git] / man / lightcards.1
index 45f36029e2d8cbbab5ec0e321c5ea4df205c3afa..74596ba54fcc1d2edc8575db3eb72b760d966260 100644 (file)
@@ -1,45 +1,43 @@
 .\" 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
 lightcards - terminal flashcards from Markdown
 .SH SYNOPSIS
 .PP
-lightcards [options] input file
+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]-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
@@ -62,16 +60,16 @@ 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
 .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 VALUES
+.SH EXIT STATUS
 .TP
 \f[B]0\f[R]
 Success
@@ -81,12 +79,12 @@ 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.