]> git.armaanb.net Git - lightcards.git/blobdiff - man/lightcards.1.md
Update manpages
[lightcards.git] / man / lightcards.1.md
index e79e47843a36d4acab5c695b33704ad9a128d5a5..d3813f603d8d6fa87d27aa6e183eb38f49fc43be 100644 (file)
@@ -1,24 +1,29 @@
-% lightcards(1) 0.6.0
-% Armaan Bhojwani
-% February 2021
+---
+title: lightcards
+section: 1
+header: General Commands Manual
+footer: lightcards 0.6.0
+date: February 2021
+---
 
 # NAME
 lightcards - terminal flashcards from Markdown
 
 # SYNOPSIS
-lightcards [[options]] [input file]
+lightcards \[options\] \[input file\]
 
 # 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 a two column Markdown (and by extension, HTML) table in the **input file**, and displays flashcards from their contents.
 
 # OPTIONS
+## Generic Program Information
 **-h**, **--help**
 : Show a help message and exit
 
+**-v**, **--version**
+: Print version and exit
+
+## Stack sorting
 **-a**, **--alphabetize**
 : Alphabetize card order
 
@@ -34,10 +39,7 @@ lightcards [[options]] [input file]
 **-s**, **--shuffle**
 : Shuffle card order
 
-**-v**, **--version**
-: Print version and exit
-
-# KEYBINDINGS
+# KEYS
 **l**, **right**
 : Next card
 
@@ -68,7 +70,7 @@ lightcards [[options]] [input file]
 # 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 VALUES
+# EXIT STATUS
 **0**
 : Success
 
@@ -78,8 +80,8 @@ Lightcards takes the first table from a valid Markdown or HTML file. Each row is
 **2**
 : Invalid option
 
-# BUGS, PATCHES
+# BUGS
 https://lists.sr.ht/~armaan/public-inbox
 
 # COPYRIGHT
-Copyright 2021 Armaan Bhojwani <me@armaanb.net>. MIT License
+Copyright 2021 Armaan Bhojwani <me@armaanb.net>, MIT License.