]> git.armaanb.net Git - lightcards.git/commitdiff
Add input file section to manpage
authorArmaan Bhojwani <me@armaanb.net>
Tue, 9 Feb 2021 16:32:34 +0000 (11:32 -0500)
committerArmaan Bhojwani <me@armaanb.net>
Tue, 9 Feb 2021 16:32:34 +0000 (11:32 -0500)
man/lightcards.1
man/lightcards.1.md

index 2758d2bc9c5e98140b30fc2fc3423672066d965d..e03d09a88e9ac0819ebfcb0a3869827b89f53114 100644 (file)
@@ -7,7 +7,7 @@
 lightcards - terminal flashcards from Markdown
 .SH SYNOPSIS
 .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
 .SH DESCRIPTION
 .PP
 \f[B]lightcards\f[R] is a Python program that reads data from a two
@@ -67,6 +67,10 @@ Open input file in $EDITOR
 .TP
 \f[B]m\f[R]
 Open control menu
 .TP
 \f[B]m\f[R]
 Open control menu
+.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 VALUES
 .TP
 \f[B]0\f[R]
 .SH EXIT VALUES
 .TP
 \f[B]0\f[R]
index f57fd1e28c351af3b74a6d158311b725d09b6435..f485c949ac8ea338f9b9278a87525d67c5332579 100644 (file)
@@ -65,6 +65,9 @@ lightcards [[options]] [input file]
 **m**
 : Open control menu
 
 **m**
 : Open control menu
 
+# 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
 **0**
 : Success
 # EXIT VALUES
 **0**
 : Success