From: Armaan Bhojwani Date: Wed, 10 Feb 2021 01:29:23 +0000 (-0500) Subject: Update manpages X-Git-Tag: v0.6.0~26 X-Git-Url: https://git.armaanb.net/?p=lightcards.git;a=commitdiff_plain;h=dc1ff29df99a8d2c201d1d03178ae327f844aa0a Update manpages --- diff --git a/man/lightcards.1 b/man/lightcards.1 index 45f3602..ccbf2cd 100644 --- a/man/lightcards.1 +++ b/man/lightcards.1 @@ -1,27 +1,28 @@ .\" Automatically generated by Pandoc 2.11.3 .\" -.TH "lightcards" "1" "February 2021" "0.6.0" "" +.TH "lightcards" "1" "February 2021" "lightcards 0.6.0" "General Commands Manual" .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 -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] Show a help message and exit .TP +\f[B]-v\f[R], \f[B]\[en]version\f[R] +Print version and exit +.SS Stack sorting +.TP \f[B]-a\f[R], \f[B]\[en]alphabetize\f[R] Alphabetize card order .TP @@ -36,10 +37,7 @@ Reverse card order .TP \f[B]-s\f[R], \f[B]\[en]shuffle\f[R] Shuffle card order -.TP -\f[B]-v\f[R], \f[B]\[en]version\f[R] -Print version and exit -.SH KEYBINDINGS +.SH KEYS .TP \f[B]l\f[R], \f[B]right\f[R] Next card @@ -71,7 +69,7 @@ Open control menu .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 +.SH EXIT STATUS .TP \f[B]0\f[R] Success @@ -81,12 +79,9 @@ Parse error .TP \f[B]2\f[R] Invalid option -.SH BUGS, PATCHES +.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. diff --git a/man/lightcards.1.md b/man/lightcards.1.md index e79e478..d3813f6 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -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 . MIT License +Copyright 2021 Armaan Bhojwani , MIT License.