From 2ec2597a7f25ef3d376079ec650de72729ec1d67 Mon Sep 17 00:00:00 2001
From: "alan (NyxTrail)" <alan@digistorm.in>
Date: Fri, 29 Mar 2024 06:51:51 +0000
Subject: [PATCH] Add a man page for hyprcursor-util

---
 debian/control                  |  4 ++-
 debian/hyprcursor-util.1.rst    | 51 +++++++++++++++++++++++++++++++++
 debian/hyprcursor-util.manpages |  1 +
 debian/rules                    | 10 +++++++
 4 files changed, 65 insertions(+), 1 deletion(-)
 create mode 100644 debian/hyprcursor-util.1.rst
 create mode 100644 debian/hyprcursor-util.manpages

diff --git a/debian/control b/debian/control
index 821f193..227f3e2 100644
--- a/debian/control
+++ b/debian/control
@@ -2,7 +2,9 @@ Source: hyprcursor
 Section: x11
 Priority: optional
 Maintainer: Alan M Varghese (NyxTrail) <alan@digistorm.in>
-Build-Depends: cmake, debhelper-compat (= 13)
+Build-Depends: cmake, 
+  debhelper-compat (= 13),
+  pandoc
 Standards-Version: 4.6.2
 Homepage: https://github.com/hyprwm/hyprcursor
 Rules-Requires-Root: no
diff --git a/debian/hyprcursor-util.1.rst b/debian/hyprcursor-util.1.rst
new file mode 100644
index 0000000..847efee
--- /dev/null
+++ b/debian/hyprcursor-util.1.rst
@@ -0,0 +1,51 @@
+:title: hyprcursor-util
+
+NAME
+====
+hyprcursor-util - A utility to compile, pack, unpack, etc. hyprcursor and xcursor themes
+
+SYNOPSIS
+========
+**hyprcursor-util** -c <path> [-o <dir>]
+
+**hyprcursor-util** -x <path> [-o <dir>] [--resize [mode]]
+
+OPTIONS
+=======
+**-c <path>, --create <path>**
+    Create a compiled hyprcursor theme from a working state
+
+**-x <path>, --extract <path>**
+    Extract an xcursor theme into a working state. This option uses the 
+    external program **xcur2png(1)** for converting xcursor theme files to
+    a format required by hyprcursor.
+
+**-o <path-to-dir>, --output <path-to-dir>**
+    Both **--create** and **--extract** supports the **-output** option to 
+    specify an output directory. For safety reasons, **do not use this on 
+    versions below 0.1.1** as it will nuke the specified directory without 
+    asking.
+
+    Since v0.1.2, this directory is the parent, the theme will be written to 
+    a subdirectory in it called **ACTION_NAME**.
+
+**--resize [mode]**
+    For use with **--extract** option. Specify a default resize algorithm for
+    shapes. Default is **none**.
+
+**-v, --version**
+    Print info about the version of hyprcursor-util.
+
+DESCRIPTION
+===========
+Cursor themes can be in 3 states:
+     * **compiled hyprcursor** - these can be used by apps / compositors
+     * **compiled xcursor** - these can be used by xcursor
+     * **working state** - an easy to navigate mode where every cursor is a png/svg,
+       and all the meta is in files
+
+AUTHORS
+=======
+This man page is written for the Debian GNU/Linux system by Alan M Varghese.
+The information in this page is collected from the official README file
+included with hyprcursor-util source files.
diff --git a/debian/hyprcursor-util.manpages b/debian/hyprcursor-util.manpages
new file mode 100644
index 0000000..79d5cef
--- /dev/null
+++ b/debian/hyprcursor-util.manpages
@@ -0,0 +1 @@
+usr/share/doc/hyprcursor-util/hyprcursor-util.1
diff --git a/debian/rules b/debian/rules
index 1e09343..e732ece 100755
--- a/debian/rules
+++ b/debian/rules
@@ -9,3 +9,13 @@ export DEB_LDFLAGS_MAINT_APPEND = -Wl,-O1
 
 override_dh_auto_test:
 	:
+
+override_dh_auto_install:
+	dh_auto_install
+	
+	mkdir -p debian/tmp/usr/share/doc/hyprcursor-util
+	pandoc debian/hyprcursor-util.1.rst --standalone \
+		--variable=header:"hyprcursor-util User Manual" \
+		--variable=section:1 \
+		--from rst \
+		--to man > debian/tmp/usr/share/doc/hyprcursor-util/hyprcursor-util.1