]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1
Update manpages
[lightcards.git] / man / lightcards.1
index 45f36029e2d8cbbab5ec0e321c5ea4df205c3afa..ccbf2cde1aa984d599cb0fd551c0ad55b4a64e93 100644 (file)
@@ -1,27 +1,28 @@
 .\" 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]
 Show a help message and exit
 .TP
+\f[B]-v\f[R], \f[B]\[en]version\f[R]
+Print version and exit
+.SS Stack sorting
+.TP
 \f[B]-a\f[R], \f[B]\[en]alphabetize\f[R]
 Alphabetize card order
 .TP
@@ -36,10 +37,7 @@ Reverse card order
 .TP
 \f[B]-s\f[R], \f[B]\[en]shuffle\f[R]
 Shuffle card order
-.TP
-\f[B]-v\f[R], \f[B]\[en]version\f[R]
-Print version and exit
-.SH KEYBINDINGS
+.SH KEYS
 .TP
 \f[B]l\f[R], \f[B]right\f[R]
 Next card
@@ -71,7 +69,7 @@ Open control menu
 .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,9 @@ Parse error
 .TP
 \f[B]2\f[R]
 Invalid option
-.SH BUGS, PATCHES
+.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.