]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1
Add input file section to manpage
[lightcards.git] / man / lightcards.1
index c746c5988ca0033796a3c3e38e05e7cb183a6a25..e03d09a88e9ac0819ebfcb0a3869827b89f53114 100644 (file)
@@ -1,13 +1,13 @@
 .\" Automatically generated by Pandoc 2.11.3
 .\"
-.TH "lightcards" "1" "January 2021" "0.2.0" ""
+.TH "lightcards" "1" "February 2021" "0.6.0" ""
 .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
@@ -22,12 +22,17 @@ Relative or absolute path to the input Markdown or HTML file
 \f[B]-h\f[R], \f[B]\[en]help\f[R]
 Show a help message and exit
 .TP
+\f[B]-a\f[R], \f[B]\[en]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]
+Purge cache for chosen set
+.TP
 \f[B]-r\f[R], \f[B]\[en]reverse\f[R]
-Reverse card order.
-Has no effect when shuffling as well
+Reverse card order
 .TP
 \f[B]-s\f[R], \f[B]\[en]shuffle\f[R]
 Shuffle card order
@@ -53,6 +58,19 @@ Go to start of deck
 .TP
 \f[B]$\f[R], \f[B]end\f[R]
 Go to end of deck
+.TP
+\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
+.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
 .TP
 \f[B]0\f[R]