From: Armaan Bhojwani <me@armaanb.net>
Date: Tue, 9 Feb 2021 16:32:34 +0000 (-0500)
Subject: Add input file section to manpage
X-Git-Tag: v0.6.0~33
X-Git-Url: https://git.armaanb.net/?p=lightcards.git;a=commitdiff_plain;h=64fc620d9e6ede0602479a1131a3a27fb90db90e

Add input file section to manpage
---

diff --git a/man/lightcards.1 b/man/lightcards.1
index 2758d2b..e03d09a 100644
--- a/man/lightcards.1
+++ b/man/lightcards.1
@@ -7,7 +7,7 @@
 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
@@ -67,6 +67,10 @@ Open input file in $EDITOR
 .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]
diff --git a/man/lightcards.1.md b/man/lightcards.1.md
index f57fd1e..f485c94 100644
--- a/man/lightcards.1.md
+++ b/man/lightcards.1.md
@@ -65,6 +65,9 @@ lightcards [[options]] [input file]
 **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