Add lightcards-config() manpage

diff --git a/man/lightcards-config.5 b/man/lightcards-config.5
new file mode 100644 (file)
index 0000000..24943f7
--- /dev/null
+++ b/man/lightcards-config.5
@@ -0,0 +1,21 @@
+.\" Automatically generated by Pandoc 2.11.3
+.\"
+.TH "lightcards-config" "5" "February 2021" "lightcards 0.7.0" "File Formats Manual"
+.hy
+.SH NAME
+.PP
+lightcards-config - configuration file formats for
+\f[B]lightcards(1)\f[R]
+.SH CONFIGURATION
+.PP
+Configuration is done through the config.py file.
+This is an executed Python script and must have valid Python syntax.
+An example config file is provided at
+/usr/share/doc/lightcards/config.py, or
+\[ti]/.local/share/doc/lightcards/config.py if installed locally.
+Copy this to \[ti]/.config/lightcards/config.py or
+$XDG_CONFIG_HOME/lightcards/config.py and make modifications! All
+possible options are listed in the sample config file.
+.SH SEE ALSO
+.PP
+\f[B]lightcards(1)\f[R]

diff --git a/man/lightcards-config.5.md b/man/lightcards-config.5.md
new file mode 100644 (file)
index 0000000..5aa6b28
--- /dev/null
+++ b/man/lightcards-config.5.md
@@ -0,0 +1,16 @@
+---
+title: lightcards-config
+section: 5
+header: File Formats Manual
+footer: VERSION_HERE
+date: February 2021
+---
+
+# NAME
+lightcards-config - configuration file formats for **lightcards(1)**
+
+# CONFIGURATION
+Configuration is done through the config.py file. This is an executed Python script and must have valid Python syntax. An example config file is provided at /usr/share/doc/lightcards/config.py, or ~/.local/share/doc/lightcards/config.py if installed locally. Copy this to ~/.config/lightcards/config.py or $XDG_CONFIG_HOME/lightcards/config.py and make modifications! All possible options are listed in the sample config file.
+
+# SEE ALSO
+  **lightcards(1)**

diff --git a/man/lightcards.1 b/man/lightcards.1
index bf0ffa31c9bb23d3c5395db29d30538080db1719..debd9ac1c9ac80e99f6bb38d9546563d65ad0f9c 100644 (file)
--- a/man/lightcards.1
+++ b/man/lightcards.1
@@ -91,6 +91,9 @@ Curses error
 .TP
 \f[B]4\f[R]
 Config error
+.SH SEE ALSO
+.PP
+\f[B]lightcards-config(5)\f[R]
 .SH BUGS
 .PP
 https://lists.sr.ht/\[ti]armaan/public-inbox

diff --git a/man/lightcards.1.md b/man/lightcards.1.md
index a5173a71e285b96b2ad17f06083eb476519c0439..0c5441ca52222be8e84abc56eb275b481a194a76 100644 (file)
--- a/man/lightcards.1.md
+++ b/man/lightcards.1.md
@@ -92,6 +92,9 @@ Lightcards takes the first table from a valid Markdown or HTML file. Each row is
 **4**
 : Config error
 
+# SEE ALSO
+  **lightcards-config(5)**
+
 # BUGS
 https://lists.sr.ht/~armaan/public-inbox
 

diff --git a/setup.py b/setup.py
index 2373f3f82dcdcdbb2cc99b0f16cf33a22a1848b3..d028ea7ae9cd12c718ae04c245fd9f7444458228 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -19,12 +19,14 @@ setup(
     install_requires=["beautifulsoup4", "markdown"],
     data_files=[
         ("man/man1", ["man/lightcards.1"]),
+        ("man/man5", ["man/lightcards-config.5"]),
         (
             "share/doc/lightcards/",
             [
                 "./config.py",
                 "./README.md",
                 "man/lightcards.1.md",
+                "man/lightcards-config.5.md",
                 "./LICENSE",
             ],
         ),