From d52b3d4c2af13d82452ca757ca0eef1237ee35f9 Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Sat, 13 Feb 2021 13:27:24 -0500 Subject: [PATCH] Add lightcards-config() manpage --- man/lightcards-config.5 | 21 +++++++++++++++++++++ man/lightcards-config.5.md | 16 ++++++++++++++++ man/lightcards.1 | 3 +++ man/lightcards.1.md | 3 +++ setup.py | 2 ++ 5 files changed, 45 insertions(+) create mode 100644 man/lightcards-config.5 create mode 100644 man/lightcards-config.5.md diff --git a/man/lightcards-config.5 b/man/lightcards-config.5 new file mode 100644 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 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 bf0ffa3..debd9ac 100644 --- 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 a5173a7..0c5441c 100644 --- 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 2373f3f..d028ea7 100644 --- 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", ], ), -- 2.39.2