From e1326f7ecacb027aeb573bbf804f6e8df5a1e2da Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Sat, 30 Jan 2021 17:54:05 -0500 Subject: [PATCH] Update manpage --- contrib/manconvert | 4 +++- man/lightcards.1 | 45 +++++++++++++++++++++++++++++++++++++++++++++ man/lightcards.1.md | 8 ++++++-- 3 files changed, 54 insertions(+), 3 deletions(-) create mode 100644 man/lightcards.1 diff --git a/contrib/manconvert b/contrib/manconvert index 4fad1cb..6553637 100755 --- a/contrib/manconvert +++ b/contrib/manconvert @@ -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 index 0000000..9b8586f --- /dev/null +++ b/man/lightcards.1 @@ -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 . +MIT License +.SH AUTHORS +Armaan Bhojwani. diff --git a/man/lightcards.1.md b/man/lightcards.1.md index 42259ec..96e8ccc 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -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** -- 2.39.2