From: Armaan Bhojwani <me@armaanb.net>
Date: Sun, 31 Jan 2021 13:37:49 +0000 (-0500)
Subject: Add keybindings section to manpage
X-Git-Tag: v0.2.0~4
X-Git-Url: https://git.armaanb.net/?p=lightcards.git;a=commitdiff_plain;h=3413d66d6b1127529440be34c85fc7ac5b83d30a

Add keybindings section to manpage
---

diff --git a/man/lightcards.1 b/man/lightcards.1
index 98e8a43..c746c59 100644
--- a/man/lightcards.1
+++ b/man/lightcards.1
@@ -4,15 +4,15 @@
 .hy
 .SH NAME
 .PP
-Lightcards - simple terminal flashcards.
+lightcards - terminal flashcards from Markdown
 .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.
+column Markdown (and by extension, HTML) table, and displays flashcards
+from their contents.
 .SH POSITIONAL ARGUMENTS
 .TP
 \f[B]input file\f[R]
@@ -22,6 +22,9 @@ Relative or absolute path to the input Markdown or HTML file
 \f[B]-h\f[R], \f[B]\[en]help\f[R]
 Show a help message and exit
 .TP
+\f[B]-f\f[R], \f[B]\[en]flip\f[R]
+Show second column first
+.TP
 \f[B]-r\f[R], \f[B]\[en]reverse\f[R]
 Reverse card order.
 Has no effect when shuffling as well
@@ -31,6 +34,25 @@ Shuffle card order
 .TP
 \f[B]-v\f[R], \f[B]\[en]version\f[R]
 Print version and exit
+.SH KEYBINDINGS
+.TP
+\f[B]l\f[R], \f[B]right\f[R]
+Next card
+.TP
+\f[B]h\f[R], \f[B]left\f[R]
+Previous card
+.TP
+\f[B]j\f[R], \f[B]k\f[R], \f[B]up\f[R], \f[B]down\f[R]
+Flip card
+.TP
+\f[B]i\f[R], \f[B]/\f[R]
+Star card
+.TP
+\f[B]0\f[R], \f[B]\[ha]\f[R], \f[B]home\f[R]
+Go to start of deck
+.TP
+\f[B]$\f[R], \f[B]end\f[R]
+Go to end of deck
 .SH EXIT VALUES
 .TP
 \f[B]0\f[R]
diff --git a/man/lightcards.1.md b/man/lightcards.1.md
index 0536fbf..de4e3b7 100644
--- a/man/lightcards.1.md
+++ b/man/lightcards.1.md
@@ -31,6 +31,25 @@ lightcards [[options]] [input file]
 **-v**, **--version**
 : Print version and exit
 
+# KEYBINDINGS
+**l**, **right**
+: Next card
+
+**h**, **left**
+: Previous card
+
+**j**, **k**, **up**, **down**
+: Flip card
+
+**i**, **/**
+: Star card
+
+**0**, **^**, **home**
+: Go to start of deck
+
+**$**, **end**
+: Go to end of deck
+
 # EXIT VALUES
 **0**
 : Success