From 7ce2c9167385ec37c1469633a708a352fc6f4a3d Mon Sep 17 00:00:00 2001 From: Fernando Ayats Date: Sun, 21 Aug 2022 10:39:47 +0200 Subject: [PATCH] doc: build man pages to repo --- docs/Hyprland.1 | 60 ++++++++++++++++++ docs/hyprctl.1 | 159 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 219 insertions(+) create mode 100644 docs/Hyprland.1 create mode 100644 docs/hyprctl.1 diff --git a/docs/Hyprland.1 b/docs/Hyprland.1 new file mode 100644 index 00000000..6571269e --- /dev/null +++ b/docs/Hyprland.1 @@ -0,0 +1,60 @@ +.\" Automatically generated by Pandoc 2.17.1.1 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "Hyprland" "1" "21 Aug 2022" "" "Hyprland User Manual" +.hy +.SH NAME +.PP +Hyprland - Dynamic tiling Wayland compositor +.SH SYNOPSIS +.PP +\f[B]Hyprland\f[R] [\f[I]arg [...]\f[R]]. +.SH DESCRIPTION +.PP +\f[B]Hyprland\f[R] is a dynamic tiling Wayland compositor based on +wlroots that doesn\[aq]t sacrifice on its looks. +.PP +You can launch Hyprland by either going into a TTY and executing +\f[B]Hyprland\f[R], or with a login manager. +.SH NOTICE +.PP +Hyprland is still in pretty early development compared to some other +Wayland compositors. +.PP +Although Hyprland is pretty stable, it may have some bugs. +.SH CONFIGURATION +.PP +For configuration information please see +<\f[I]https://github.com/hyprwm/Hyprland/wiki\f[R]>. +.SH OPTIONS +.TP +\f[B]-h\f[R], \f[B]--help\f[R] +Show command usage. +.TP +\f[B]-c\f[R], \f[B]--config\f[R] +Specify config file to use. +.SH BUGS +.TP +Submit bug reports and request features online at: +<\f[I]https://github.com/hyprwm/Hyprland/issues\f[R]> +.SH SEE ALSO +.PP +Sources at: <\f[I]https://github.com/hyprwm/Hyprland\f[R]> +.SH COPYRIGHT +.PP +Copyright (c) 2022, vaxerski +.SH AUTHORS +Vaxerski <\f[I]https://github.com/vaxerski\f[R]>. diff --git a/docs/hyprctl.1 b/docs/hyprctl.1 new file mode 100644 index 00000000..1d520950 --- /dev/null +++ b/docs/hyprctl.1 @@ -0,0 +1,159 @@ +.\" Automatically generated by Pandoc 2.17.1.1 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "hyprctl" "1" "21 Aug 2022" "" "hyprctl User Manual" +.hy +.SH NAME +.PP +hyprctl - Utility for controlling parts of Hyprland from a CLI or a +script +.SH SYNOPSIS +.PP +\f[B]hyprctl\f[R] [\f[I](opt)flags\f[R]] [\f[B]command\f[R]] +[\f[I](opt)args\f[R]] +.SH DESCRIPTION +.PP +\f[B]hyprctl\f[R] is a utility for controlling some parts of the +compositor from a CLI or a script. +.SH CONTROL COMMANDS +.PP +\f[B]dispatch\f[R] +.RS +.PP +Call a dispatcher with an argument. +.PP +An argument must be present. +For dispatchers without parameters it can be anything. +.PP +Returns: \f[I]ok\f[R] on success, and an error message on failure. +.TP +Examples: +\f[B]hyprctl\f[R] \f[I]dispatch exec kitty\f[R] +.RS +.PP +\f[B]hyprctl\f[R] \f[I]dispatch pseudo x\f[R] +.RE +.RE +.PP +\f[B]keyword\f[R] +.RS +.PP +Set a config keyword dynamically. +.PP +Returns: \f[I]ok\f[R] on success, and an error message on failure. +.TP +Examples: +\f[B]hyprctl\f[R] \f[I]keyword bind SUPER,0,pseudo\f[R] +.RS +.PP +\f[B]hyprctl\f[R] \f[I]keyword general:border_size 10\f[R] +.RE +.RE +.PP +\f[B]reload\f[R] +.RS +.PP +Force a reload of the config file. +.RE +.PP +\f[B]kill\f[R] +.RS +.PP +Enter kill mode, where you can kill an app by clicking on it. +You can exit by pressing ESCAPE. +.RE +.SH INFO COMMANDS +.PP +\f[B]version\f[R] +.RS +.PP +Prints the Hyprland version, flags, commit and branch of build. +.RE +.PP +\f[B]monitors\f[R] +.RS +.PP +Lists all the outputs with their properties. +.RE +.PP +\f[B]workspaces\f[R] +.RS +.PP +Lists all workspaces with their properties. +.RE +.PP +\f[B]clients\f[R] +.RS +.PP +Lists all windows with their properties. +.RE +.PP +\f[B]devices\f[R] +.RS +.PP +Lists all connected input devices. +.RE +.PP +\f[B]activewindow\f[R] +.RS +.PP +Returns the active window name. +.RE +.PP +\f[B]layers\f[R] +.RS +.PP +Lists all the layers. +.RE +.PP +\f[B]splash\f[R] +.RS +.PP +Returns the current random splash. +.RE +.SH OPTIONS +.PP +\f[B]--batch\f[R] +.RS +.PP +Specify a batch of commands to execute. +.TP +Example: +\f[B]hyprctl\f[R] \f[I]--batch \[dq]keyword general:border_size 2 ; +keyword general:gaps_out 20\[dq]\f[R] +.RS +.PP +\f[I];\f[R] separates the commands. +.RE +.RE +.PP +\f[B]-j\f[R] +.RS +.PP +Outputs information in JSON. +.RE +.SH BUGS +.TP +Submit bug reports and request features online at: +<\f[I]https://github.com/hyprwm/Hyprland/issues\f[R]> +.SH SEE ALSO +.PP +Sources at: <\f[I]https://github.com/hyprwm/Hyprland\f[R]> +.SH COPYRIGHT +.PP +Copyright (c) 2022, vaxerski +.SH AUTHORS +Vaxerski <\f[I]https://github.com/vaxerski\f[R]>.