mirror of
https://github.com/hyprwm/Hyprland
synced 2024-11-24 01:06:00 +01:00
replace rst2man with pandoc
This commit is contained in:
Blake Lee
parent
88506d4284
commit
a312f8e0ac
3 changed files with 96 additions and 91 deletions
25
Makefile
25
Makefile
|
|
@ -9,6 +9,9 @@ PKGS = wlroots wayland-server xcb xkbcommon libinput
|
|||
CFLAGS += $(foreach p,$(PKGS),$(shell pkg-config --cflags $(p)))
|
||||
LDLIBS += $(foreach p,$(PKGS),$(shell pkg-config --libs $(p)))
|
||||
|
||||
VERSION=0.7.1beta
|
||||
DATE=$(shell date "+%d %b %Y")
|
||||
|
||||
xdg-shell-protocol.h:
|
||||
$(WAYLAND_SCANNER) server-header \
|
||||
$(WAYLAND_PROTOCOLS)/stable/xdg-shell/xdg-shell.xml $@
|
||||
|
|
@ -124,8 +127,7 @@ install:
|
|||
cp ./assets/wall_4K.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
|
||||
rst2man ./docs/Hyprland.1.rst | gzip -c > /usr/share/man/man1/Hyprland.1.gz
|
||||
make man
|
||||
|
||||
uninstall:
|
||||
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/ 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
|
||||
|
|
|
|||
|
|
@ -1,30 +1,24 @@
|
|||
========
|
||||
Hyprland
|
||||
========
|
||||
:title: Hyprland
|
||||
:author: Vaxerski <*https://github.com/vaxerski*>
|
||||
|
||||
---------------------------------
|
||||
Dynamic tiling Wayland compositor
|
||||
---------------------------------
|
||||
NAME
|
||||
====
|
||||
|
||||
:Date: 15 Jul 2022
|
||||
:Copyright: Copyright (c) 2022, vaxerski
|
||||
:Version: 0.7.1beta
|
||||
:Manual section: 1
|
||||
:Manual group: Hyprland
|
||||
Hyprland - Dynamic tiling Wayland compositor
|
||||
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
``Hyprland`` [arg [...]].
|
||||
**Hyprland** [*arg [...]*].
|
||||
|
||||
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.
|
||||
|
||||
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
|
||||
======
|
||||
|
|
@ -36,30 +30,29 @@ Although Hyprland is pretty stable, it may have some bugs.
|
|||
CONFIGURATION
|
||||
=============
|
||||
|
||||
For configuration information please see <`https://github.com/hyprwm/Hyprland/wiki`>.
|
||||
For configuration information please see <*https://github.com/hyprwm/Hyprland/wiki*>.
|
||||
|
||||
OPTIONS
|
||||
=======
|
||||
|
||||
-h, --help
|
||||
**-h**, **--help**
|
||||
Show command usage.
|
||||
|
||||
-c, --config
|
||||
**-c**, **--config**
|
||||
Specify config file to use.
|
||||
|
||||
BUGS
|
||||
====
|
||||
|
||||
Submit bug reports and request features online at:
|
||||
|
||||
<`https://github.com/hyprwm/Hyprland/issues`>
|
||||
<*https://github.com/hyprwm/Hyprland/issues*>
|
||||
|
||||
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
|
||||
|
|
|
|||
|
|
@ -1,130 +1,121 @@
|
|||
=======
|
||||
hyprctl
|
||||
=======
|
||||
:title: hyprctl(1)
|
||||
:author: Vaxerski <*https://github.com/vaxerski*>
|
||||
|
||||
----------------------------------------------------------------
|
||||
Utility for controlling parts of Hyprland from a CLI or a script
|
||||
----------------------------------------------------------------
|
||||
NAME
|
||||
====
|
||||
|
||||
:Date: 15 Jul 2022
|
||||
:Copyright: Copyright (c) 2022, vaxerski
|
||||
:Version: 0.7.1beta
|
||||
:Manual section: 1
|
||||
:Manual group: hyprctl
|
||||
hyprctl - Utility for controlling parts of Hyprland from a CLI or a script
|
||||
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
``hyprctl`` [(opt)flags] [command] [(opt)args]
|
||||
**hyprctl** [*(opt)flags*] [**command**] [*(opt)args*]
|
||||
|
||||
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.
|
||||
For dispatchers without parameters it can be anything.
|
||||
|
||||
An argument must be present.
|
||||
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:
|
||||
**hyprctl** *dispatch exec kitty*
|
||||
|
||||
Examples:
|
||||
**hyprctl** *dispatch pseudo x*
|
||||
|
||||
``hyprctl`` `dispatch exec kitty`
|
||||
**keyword**
|
||||
|
||||
``hyprctl`` `dispatch pseudo x`
|
||||
Set a config keyword dynamically.
|
||||
|
||||
``keyword``
|
||||
Returns: *ok* on success, and an error message on failure.
|
||||
|
||||
Set a config keyword dynamically.
|
||||
Examples:
|
||||
**hyprctl** *keyword bind SUPER,0,pseudo*
|
||||
|
||||
Returns: `ok` on success, and an error message on failure.
|
||||
**hyprctl** *keyword general:border_size 10*
|
||||
|
||||
Examples:
|
||||
**reload**
|
||||
|
||||
``hyprctl`` `keyword bind SUPER,0,pseudo`
|
||||
Force a reload of the config file.
|
||||
|
||||
``hyprctl`` `keyword general:border_size 10`
|
||||
**kill**
|
||||
|
||||
``reload``
|
||||
Enter kill mode, where you can kill an app by clicking on it.
|
||||
You can exit by pressing ESCAPE.
|
||||
|
||||
Force a reload of the config file.
|
||||
INFO COMMANDS
|
||||
=============
|
||||
|
||||
``kill``
|
||||
**version**
|
||||
|
||||
Enter kill mode, where you can kill an app by clicking on it.
|
||||
You can exit by pressing ESCAPE.
|
||||
Prints the Hyprland version, flags, commit and branch of build.
|
||||
|
||||
Info
|
||||
**monitors**
|
||||
|
||||
``version``
|
||||
Lists all the outputs with their properties.
|
||||
|
||||
Prints the Hyprland version, flags, commit and branch of build.
|
||||
**workspaces**
|
||||
|
||||
``monitors``
|
||||
Lists all workspaces with their properties.
|
||||
|
||||
Lists all the outputs with their properties.
|
||||
**clients**
|
||||
|
||||
``workspaces``
|
||||
Lists all windows with their properties.
|
||||
|
||||
Lists all workspaces with their properties.
|
||||
**devices**
|
||||
|
||||
``clients``
|
||||
Lists all connected input devices.
|
||||
|
||||
Lists all windows with their properties.
|
||||
**activewindow**
|
||||
|
||||
``devices``
|
||||
Returns the active window name.
|
||||
|
||||
Lists all connected input devices.
|
||||
**layers**
|
||||
|
||||
``activewindow``
|
||||
Lists all the layers.
|
||||
|
||||
Returns the active window name.
|
||||
**splash**
|
||||
|
||||
``layers``
|
||||
|
||||
Lists all the layers.
|
||||
|
||||
``splash``
|
||||
|
||||
Returns the current random splash.
|
||||
Returns the current random splash.
|
||||
|
||||
OPTIONS
|
||||
=======
|
||||
|
||||
--batch
|
||||
**--batch**
|
||||
|
||||
Specify a batch of commands to execute.
|
||||
|
||||
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.
|
||||
|
||||
BUGS
|
||||
====
|
||||
|
||||
Submit bug reports and feature requests online at:
|
||||
|
||||
<`https://github.com/hyprwm/hyprctl/issues`>
|
||||
Submit bug reports and request features online at:
|
||||
<*https://github.com/hyprwm/Hyprland/issues*>
|
||||
|
||||
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
|
||||
|
|
|
|||
Loading…
Reference in a new issue