X-Git-Url: https://git.armaanb.net/?p=lightcards.git;a=blobdiff_plain;f=man%2Flightcards.1;h=37b3866eea7b206eb27867d399639ae7bf40d54e;hp=9b8586f70a9c39f4873d42efb9b6b0973e484e21;hb=3ffbf7f20f3bdb8a162e2ecab608ac0a013a4b3c;hpb=e1326f7ecacb027aeb573bbf804f6e8df5a1e2da diff --git a/man/lightcards.1 b/man/lightcards.1 index 9b8586f..37b3866 100644 --- a/man/lightcards.1 +++ b/man/lightcards.1 @@ -1,45 +1,93 @@ .\" Automatically generated by Pandoc 2.11.3 .\" -.TH "lightcards" "1" "January 2021" "0.0.0" "" +.TH "lightcards" "1" "February 2021" "lightcards 0.6.0" "General Commands Manual" .hy .SH NAME .PP -Lightcards - simple terminal flashcards. +lightcards - terminal flashcards from Markdown .SH SYNOPSIS .PP lightcards [options] [input file] .SH DESCRIPTION .PP \f[B]lightcards\f[R] is a Python program that reads data from a two -column Markdown or HTML table, and displays flashcards based on 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]-v\f[R], \f[B]\[en]version\f[R] -Print version -.SH EXIT VALUES +\f[B]-v\f[R], \f[B]--version\f[R] +Print version and exit +.SS Startup options +.TP +\f[B]-a\f[R], \f[B]--alphabetize\f[R] +Alphabetize card order +.TP +\f[B]-p\f[R], \f[B]--purge\f[R] +Purge cache for chosen set +.TP +\f[B]-r\f[R], \f[B]--reverse\f[R] +Reverse card order +.TP +\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 +.SH KEYS +.TP +\f[B]l\f[R], \f[B]right\f[R] +Next card +.TP +\f[B]h\f[R], \f[B]left\f[R] +Previous card +.TP +\f[B]j\f[R], \f[B]k\f[R], \f[B]up\f[R], \f[B]down\f[R] +Flip card +.TP +\f[B]i\f[R], \f[B]/\f[R] +Star card +.TP +\f[B]0\f[R], \f[B]\[ha]\f[R], \f[B]home\f[R] +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 +.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 . -MIT License -.SH AUTHORS -Armaan Bhojwani. +Copyright 2021 Armaan Bhojwani , MIT License.