hyprwm
/
Hyprland
mirror of https://github.com/hyprwm/Hyprland
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

replace `rst2man` with `pandoc`

This commit is contained in:
Blake Lee 2022-07-18 18:56:46 -04:00
parent 88506d4284
commit a312f8e0ac
No known key found for this signature in database
GPG Key ID: 87157C329108F09E
3 changed files with 96 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Makefile
View File

@ -9,6 +9,9 @@ PKGS = wlroots wayland-server xcb xkbcommon libinput
CFLAGS += $(foreach p,$(PKGS),$(shell pkg-config --cflags $(p))) CFLAGS += $(foreach p,$(PKGS),$(shell pkg-config --cflags $(p)))
LDLIBS += $(foreach p,$(PKGS),$(shell pkg-config --libs $(p))) LDLIBS += $(foreach p,$(PKGS),$(shell pkg-config --libs $(p)))
VERSION=0.7.1beta
DATE=$(shell date "+%d %b %Y")
xdg-shell-protocol.h: xdg-shell-protocol.h:
$(WAYLAND_SCANNER) server-header \ $(WAYLAND_SCANNER) server-header \
$(WAYLAND_PROTOCOLS)/stable/xdg-shell/xdg-shell.xml $@ $(WAYLAND_PROTOCOLS)/stable/xdg-shell/xdg-shell.xml $@
@ -124,8 +127,7 @@ install:
cp ./assets/wall_4K.png ${PREFIX}/share/hyprland cp ./assets/wall_4K.png ${PREFIX}/share/hyprland
cp ./assets/wall_8K.png ${PREFIX}/share/hyprland cp ./assets/wall_8K.png ${PREFIX}/share/hyprland
rst2man ./docs/hyprctl.1.rst | gzip -c > /usr/share/man/man1/hyprctl.1.gz make man
rst2man ./docs/Hyprland.1.rst | gzip -c > /usr/share/man/man1/Hyprland.1.gz
uninstall: uninstall:
rm -f ${PREFIX}/share/wayland-sessions/hyprland.desktop rm -f ${PREFIX}/share/wayland-sessions/hyprland.desktop
@ -150,3 +152,22 @@ config:
cd subprojects/wlroots && ninja -C build/ cd subprojects/wlroots && ninja -C build/
cd subprojects/wlroots && ninja -C build/ install cd subprojects/wlroots && ninja -C build/ install
man:
pandoc ./docs/Hyprland.1.rst \
--standalone \
--variable=header:"Hyprland User Manual" \
--variable=footer:${VERSION} \
--variable=date:"${DATE}" \
--variable=section:1 \
--from rst \
--to man | gzip -c > /usr/share/man/man1/Hyprland.1.gz
pandoc ./docs/hyprctl.1.rst \
--standalone \
--variable=header:"hyprctl User Manual" \
--variable=footer:${VERSION} \
--variable=date:"${DATE}" \
--variable=section:1 \
--from rst \
--to man | gzip -c > /usr/share/man/man1/hyprctl.1.gz

39
docs/Hyprland.1.rst
View File

@ -1,30 +1,24 @@
======== :title: Hyprland
Hyprland :author: Vaxerski <*https://github.com/vaxerski*>
========
--------------------------------- NAME
Dynamic tiling Wayland compositor ====
---------------------------------
:Date: 15 Jul 2022 Hyprland - Dynamic tiling Wayland compositor
:Copyright: Copyright (c) 2022, vaxerski
:Version: 0.7.1beta
:Manual section: 1
:Manual group: Hyprland
SYNOPSIS SYNOPSIS
======== ========
``Hyprland`` [arg [...]]. **Hyprland** [*arg [...]*].
DESCRIPTION DESCRIPTION
=========== ===========
``Hyprland`` is a dynamic tiling Wayland compositor based on **Hyprland** is a dynamic tiling Wayland compositor based on
wlroots that doesn't sacrifice on its looks. wlroots that doesn't sacrifice on its looks.
You can launch Hyprland by either going into a TTY and You can launch Hyprland by either going into a TTY and
executing ``Hyprland``, or with a login manager. executing **Hyprland**, or with a login manager.
NOTICE NOTICE
====== ======
@ -36,30 +30,29 @@ Although Hyprland is pretty stable, it may have some bugs.
CONFIGURATION CONFIGURATION
============= =============
For configuration information please see <`https://github.com/hyprwm/Hyprland/wiki`>. For configuration information please see <*https://github.com/hyprwm/Hyprland/wiki*>.
OPTIONS OPTIONS
======= =======
-h, --help **-h**, **--help**
Show command usage. Show command usage.
-c, --config **-c**, **--config**
Specify config file to use. Specify config file to use.
BUGS BUGS
==== ====
Submit bug reports and request features online at: Submit bug reports and request features online at:
<*https://github.com/hyprwm/Hyprland/issues*>
<`https://github.com/hyprwm/Hyprland/issues`>
SEE ALSO SEE ALSO
======== ========
Sources at: <`https://github.com/hyprwm/Hyprland`> Sources at: <*https://github.com/hyprwm/Hyprland*>
AUTHORS COPYRIGHT
======= =========
Vaxerski <`https://github.com/vaxerski`> Copyright (c) 2022, vaxerski

89
docs/hyprctl.1.rst
View File

@ -1,130 +1,121 @@
======= :title: hyprctl(1)
hyprctl :author: Vaxerski <*https://github.com/vaxerski*>
=======
---------------------------------------------------------------- NAME
Utility for controlling parts of Hyprland from a CLI or a script ====
----------------------------------------------------------------
:Date: 15 Jul 2022 hyprctl - Utility for controlling parts of Hyprland from a CLI or a script
:Copyright: Copyright (c) 2022, vaxerski
:Version: 0.7.1beta
:Manual section: 1
:Manual group: hyprctl
SYNOPSIS SYNOPSIS
======== ========
``hyprctl`` [(opt)flags] [command] [(opt)args] **hyprctl** [*(opt)flags*] [**command**] [*(opt)args*]
DESCRIPTION DESCRIPTION
=========== ===========
``hyprctl`` is a utility for controlling some parts of the compositor from a CLI or a script. **hyprctl** is a utility for controlling some parts of the compositor from a CLI or a script.
COMMANDS CONTROL COMMANDS
======== ================
Control **dispatch**
``dispatch``
Call a dispatcher with an argument. Call a dispatcher with an argument.
An argument must be present. An argument must be present.
For dispatchers without parameters it can be anything. For dispatchers without parameters it can be anything.
Returns: `ok` on success, and an error message on failure. Returns: *ok* on success, and an error message on failure.
Examples: Examples:
**hyprctl** *dispatch exec kitty*
``hyprctl`` `dispatch exec kitty` **hyprctl** *dispatch pseudo x*
``hyprctl`` `dispatch pseudo x` **keyword**
``keyword``
Set a config keyword dynamically. Set a config keyword dynamically.
Returns: `ok` on success, and an error message on failure. Returns: *ok* on success, and an error message on failure.
Examples: Examples:
**hyprctl** *keyword bind SUPER,0,pseudo*
``hyprctl`` `keyword bind SUPER,0,pseudo` **hyprctl** *keyword general:border_size 10*
``hyprctl`` `keyword general:border_size 10` **reload**
``reload``
Force a reload of the config file. Force a reload of the config file.
``kill`` **kill**
Enter kill mode, where you can kill an app by clicking on it. Enter kill mode, where you can kill an app by clicking on it.
You can exit by pressing ESCAPE. You can exit by pressing ESCAPE.
Info INFO COMMANDS
=============
``version`` **version**
Prints the Hyprland version, flags, commit and branch of build. Prints the Hyprland version, flags, commit and branch of build.
``monitors`` **monitors**
Lists all the outputs with their properties. Lists all the outputs with their properties.
``workspaces`` **workspaces**
Lists all workspaces with their properties. Lists all workspaces with their properties.
``clients`` **clients**
Lists all windows with their properties. Lists all windows with their properties.
``devices`` **devices**
Lists all connected input devices. Lists all connected input devices.
``activewindow`` **activewindow**
Returns the active window name. Returns the active window name.
``layers`` **layers**
Lists all the layers. Lists all the layers.
``splash`` **splash**
Returns the current random splash. Returns the current random splash.
OPTIONS OPTIONS
======= =======
--batch **--batch**
Specify a batch of commands to execute. Specify a batch of commands to execute.
Example: Example:
**hyprctl** *--batch "keyword general:border_size 2 ; keyword general:gaps_out 20"*
``hyprctl`` `--batch "keyword general:border_size 2 ; keyword general:gaps_out 20"` *;* separates the commands.
`;` separates the commands. **-j**
-j
Outputs information in JSON. Outputs information in JSON.
BUGS BUGS
==== ====
Submit bug reports and feature requests online at: Submit bug reports and request features online at:
<*https://github.com/hyprwm/Hyprland/issues*>
<`https://github.com/hyprwm/hyprctl/issues`>
SEE ALSO SEE ALSO
======== ========
Sources at: <`https://github.com/hyprwm/hyprctl`> Sources at: <*https://github.com/hyprwm/Hyprland*>
AUTHORS COPYRIGHT
======= =========
Vaxerski <`https://github.com/vaxerski`> Copyright (c) 2022, vaxerski