]> git.armaanb.net Git - lightcards.git/commitdiff
Update manpage
authorArmaan Bhojwani <me@armaanb.net>
Sat, 30 Jan 2021 22:54:05 +0000 (17:54 -0500)
committerArmaan Bhojwani <me@armaanb.net>
Sat, 30 Jan 2021 22:54:05 +0000 (17:54 -0500)
contrib/manconvert
man/lightcards.1 [new file with mode: 0644]
man/lightcards.1.md

index 4fad1cbb0bcda73228e550c2bc84695e273a8a50..65536378964ea87b21cb7b93de4eb41d2adbb165 100755 (executable)
@@ -1,2 +1,4 @@
 #!/usr/bin/env sh
-pandoc $1 -s -t man -o $(echo $1 | cut -d '.' -f -2)
+for i in man/*; do
+  pandoc ${i} -s -t man -o $(echo ${i} | cut -d '.' -f -2)
+done
diff --git a/man/lightcards.1 b/man/lightcards.1
new file mode 100644 (file)
index 0000000..9b8586f
--- /dev/null
@@ -0,0 +1,45 @@
+.\" Automatically generated by Pandoc 2.11.3
+.\"
+.TH "lightcards" "1" "January 2021" "0.0.0" ""
+.hy
+.SH NAME
+.PP
+Lightcards - simple terminal flashcards.
+.SH SYNOPSIS
+.PP
+lightcards [options] [input file]
+.SH DESCRIPTION
+.PP
+\f[B]lightcards\f[R] is a Python program that reads data from a two
+column Markdown or HTML table, and displays flashcards based on their
+contents.
+.SH POSITIONAL ARGUMENTS
+.TP
+\f[B]input file\f[R]
+Relative or absolute path to the input Markdown or HTML file
+.SH OPTIONS
+.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
+.SH EXIT VALUES
+.TP
+\f[B]0\f[R]
+Success
+.TP
+\f[B]1\f[R]
+Cannot find input file
+.TP
+\f[B]2\f[R]
+Invalid option
+.SH BUGS, PATCHES
+.PP
+https://lists.sr.ht/\[ti]armaan/public-inbox
+.SH COPYRIGHT
+.PP
+Copyright 2021 Armaan Bhojwani <me@armaanb.net>.
+MIT License
+.SH AUTHORS
+Armaan Bhojwani.
index 42259ec619f3992311ff63158af43008a28b9df2..96e8cccdc1aeecf1c06d03e8ff33e3549c566abb 100644 (file)
@@ -6,10 +6,14 @@
 Lightcards - simple terminal flashcards.
 
 # SYNOPSIS
-lightcards [[options]] [[input file]]
+lightcards [[options]] [input file]
 
 # DESCRIPTION
-**lightcards** is a Python script that reads data from a markdown table, and creates flashcards from them.
+**lightcards** is a Python program that reads data from a two column Markdown or HTML table, and displays flashcards based on their contents.
+
+# POSITIONAL ARGUMENTS
+**input file**
+: Relative or absolute path to the input Markdown or HTML file
 
 # OPTIONS
 **-h**, **--help**