X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=man%2Flightcards.1;h=526d82cbbb96fe961d18cf41094d644f90fe1fec;hb=cc885692662df0e7c92e23e42fc86ace4684eefd;hp=c8264e4c34fab5b4c07d2afb22286d2c919419d2;hpb=58314c0a25a5ecd1ca044359821b58d837bb5281;p=lightcards.git diff --git a/man/lightcards.1 b/man/lightcards.1 index c8264e4..526d82c 100644 --- a/man/lightcards.1 +++ b/man/lightcards.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.11.3 .\" -.TH "lightcards" "1" "January 2021" "0.3.0" "" +.TH "lightcards" "1" "February 2021" "lightcards 0.7.0" "General Commands Manual" .hy .SH NAME .PP @@ -11,30 +11,36 @@ 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]-f\f[R], \f[B]\[en]flip\f[R] -Show second column first +\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]-r\f[R], \f[B]\[en]reverse\f[R] -Reverse card order. -Has no effect when shuffling as well +\f[B]-p\f[R], \f[B]--purge\f[R] +Purge cache for chosen set .TP -\f[B]-s\f[R], \f[B]\[en]shuffle\f[R] +\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], \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 +.TP +\f[B]-c\f[R] [config file], \f[B]--config\f[R] [config file] +Specify a custom config file +.SH KEYS .TP \f[B]l\f[R], \f[B]right\f[R] Next card @@ -57,24 +63,40 @@ 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 -.SH EXIT VALUES +\f[B]m\f[R] +Open control menu +.TP +\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. +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 +.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 .SH COPYRIGHT .PP -Copyright 2021 Armaan Bhojwani . -MIT License -.SH AUTHORS -Armaan Bhojwani. +Copyright 2021 Armaan Bhojwani , MIT License.