X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=man%2Flightcards.1.md;h=40d8783b9280171e0114422c8f04ff2b579221d3;hb=HEAD;hp=de4e3b77038d4146eb6d871bf357d98aa0353652;hpb=3413d66d6b1127529440be34c85fc7ac5b83d30a;p=lightcards.git diff --git a/man/lightcards.1.md b/man/lightcards.1.md index de4e3b7..40d8783 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -1,37 +1,54 @@ -% lightcards(1) 0.2.0 -% Armaan Bhojwani -% January 2021 +--- +title: lightcards +section: 1 +header: General Commands Manual +footer: VERSION_HERE +date: February 2021 +--- # NAME lightcards - terminal flashcards from Markdown # SYNOPSIS -lightcards [[options]] [input file] +lightcards \[options\] \[input files\] # DESCRIPTION -**lightcards** is a Python program that reads data from a two column Markdown (and by extension, HTML) table, and displays flashcards from their contents. - -# POSITIONAL ARGUMENTS -**input file** -: Relative or absolute path to the input Markdown or HTML file +**lightcards** is a Python program that reads data from two column Markdown (and by extension, HTML) tables from the **input files**, and displays flashcards from their contents. # OPTIONS -**-h**, **--help** +## Generic Program Information +**-h**, **\--help** : Show a help message and exit -**-f**, **--flip** -: Show second column first +**-v**, **\--version** +: Print version and exit + +## Startup options +**-a**, **\--alphabetize** +: Alphabetize card order + +**-p**, **\--purge** +: Purge cache for chosen set -**-r**, **--reverse** -: Reverse card order. Has no effect when shuffling as well +**-r**, **\--reverse** +: Reverse card order -**-s**, **--shuffle** +**-s**, **\--shuffle** : Shuffle card order -**-v**, **--version** -: Print version and exit +**-V** \[1-3\], **\--view** \[1-3\] +: Specify startup view + +**-c** \[config file\], **\--config** \[config file\] +: Specify a custom config file + +**-l**, **\--lenient** +: Don't raise exception if tables are malformed + +**-t** \[int\], **\--table** \[int\] +: If multiple tables are provided in the input files, specify which -# KEYBINDINGS +# KEYS **l**, **right** : Next card @@ -50,18 +67,42 @@ lightcards [[options]] [input file] **$**, **end** : Go to end of deck -# EXIT VALUES +**H**, **?** +: Open help screen + +**m** +: Open control menu + +**1**, **2**, **3** +: Switch views between front first, back first, and both + +**q** +: Quit + +# INPUT FILE +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. + +# EXIT STATUS **0** : Success **1** -: Cannot find input file +: Parse error **2** : Invalid option -# BUGS, PATCHES +**3** +: Curses error + +**4** +: Config error + +# SEE ALSO + **lightcards-config(5)** + +# BUGS https://lists.sr.ht/~armaan/public-inbox # COPYRIGHT -Copyright 2021 Armaan Bhojwani . MIT License +Copyright 2021 Armaan Bhojwani , MIT License.