Add a man page for hyprcursor-util

This commit is contained in:
alan (NyxTrail) 2024-03-29 06:51:51 +00:00
parent 36203f85b3
commit 2ec2597a7f
No known key found for this signature in database
GPG Key ID: 32C5D29762C48D4A
4 changed files with 65 additions and 1 deletions

4
debian/control vendored
View File

@ -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

51
debian/hyprcursor-util.1.rst vendored Normal file
View File

@ -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.

1
debian/hyprcursor-util.manpages vendored Normal file
View File

@ -0,0 +1 @@
usr/share/doc/hyprcursor-util/hyprcursor-util.1

10
debian/rules vendored
View File

@ -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