doc: unify scdoc style

This unifies the style of the man page source files. Most noticable are
the now consistent line endings at 80 chars (assuming a tabwidth of 8).
This commit is contained in:
Leon Henrik Plickat 2020-12-13 00:51:51 +01:00 committed by Isaac Freund
parent b2b1a1f5e1
commit f08d37ab28
4 changed files with 103 additions and 86 deletions

View File

@ -1,14 +1,17 @@
RIVER-LAYOUTS(7) "github.com/ifreund/river" RIVER-LAYOUTS(7) "github.com/ifreund/river"
# NAME # NAME
river-layouts - Details on layout generators for river river-layouts - Details on layout generators for river
# DESCRIPTION # DESCRIPTION
River can use external window management layouts. To get such a layout, river River can use external window management layouts. To get such a layout, river
will run an executable and parse its output. This document outlines how such will run an executable and parse its output. This document outlines how such a
a layout generator interacts with river. layout generator interacts with river.
# INPUT # INPUT
When running the executable, river will provide it with five parameters which When running the executable, river will provide it with five parameters which
are appended to the end of the command in the following order: are appended to the end of the command in the following order:
@ -22,10 +25,11 @@ A layout generator may choose to ignore any of these values except
for the first one. for the first one.
# OUTPUT # OUTPUT
River expects four integer values for each window: The x position, the y River expects four integer values for each window: The x position, the y
position, the width and the height. These must be separated by spaces. A position, the width and the height. These must be separated by spaces. A window
window configuration having fewer or more than four values is an error and will configuration having fewer or more than four values is an error and will cause
cause river to fall back the full layout. river to fall back the full layout.
A layout generator needs to output position and size for every visible window. A layout generator needs to output position and size for every visible window.
The window configurations are separated by a newline. Too few or too many The window configurations are separated by a newline. Too few or too many
@ -40,24 +44,26 @@ with identical parameters. Layouts are allowed to also depend on external
factors or be completely random. factors or be completely random.
# WINDOW DIMENSIONS and POSITION # WINDOW DIMENSIONS and POSITION
Layout generators are not supposed to include padding or leave space for window Layout generators are not supposed to include padding or leave space for window
borders. The window dimensions will be shrunk by river to make space for these. borders. The window dimensions will be shrunk by river to make space for these.
River enforces a minimal window width and height of 50. River enforces a minimal window width and height of 50.
Layout generators operate on a special coordinate grid from 0 to the maximum Layout generators operate on a special coordinate grid from 0 to the maximum
useable width or height of an output with the coordinate 0-0 being positioned at useable width or height of an output with the coordinate 0-0 being positioned
the top-left corner of the useable area of an output. While layout generators at the top-left corner of the useable area of an output. While layout
are free to place windows everywhere (including coordinates below zero or above generators are free to place windows everywhere (including coordinates below
the maximum width or height of an output), beware that the relative positioning zero or above the maximum width or height of an output), beware that the
of this grid on the screen can not be expected to remain constant. River applies relative positioning of this grid on the screen can not be expected to remain
an offset to window positions, depending on outer padding and the presence of constant. River applies an offset to window positions, depending on outer
desktop widgets like bars. Layout generators can therefore not position windows padding and the presence of desktop widgets like bars. Layout generators can
at exact screen coordinates. therefore not position windows at exact screen coordinates.
Layout generators are not required to make use of the entire available space. Layout generators are not required to make use of the entire available space.
Windows may overlap. Windows may overlap.
# EXAMPLE # EXAMPLE
Below is an example output of a layout generator for four visible windows. In Below is an example output of a layout generator for four visible windows. In
this example layout all four windows have a size of 500 by 500 and are arranged this example layout all four windows have a size of 500 by 500 and are arranged
in a grid. in a grid.
@ -76,4 +82,5 @@ source contributors. For more information about river's development, see
<https://github.com/ifreund/river>. <https://github.com/ifreund/river>.
# SEE ALSO # SEE ALSO
*river*(1), *riverctl*(1), *rivertile*(1) *river*(1), *riverctl*(1), *rivertile*(1)

View File

@ -1,7 +1,8 @@
RIVER(1) "github.com/ifreund/river" "General Commands Manual" RIVER(1) "github.com/ifreund/river" "General Commands Manual"
# NAME # NAME
river - dynamic tiling Wayland compositor river - Dynamic tiling Wayland compositor
# SYNOPSIS # SYNOPSIS
@ -9,19 +10,19 @@ river - dynamic tiling Wayland compositor
# DESCRIPTION # DESCRIPTION
*river* is a dynamic tiling Wayland compositor inspired by dwm and *river* is a dynamic tiling Wayland compositor inspired by dwm and bspwm based
bspwm based on wlroots and written in Zig. on wlroots and written in Zig.
# OPTIONS # OPTIONS
*-c* _shell_command_ *-c* _shell_command_
Run a shell command or give the path to a script that will be run Run a shell command or give the path to a script that will be run after
after river's wayland server is initialized but before entering the river's wayland server is initialized but before entering the main
main loop. You may use this to configure river and define keymaps loop. You may use this to configure river and define keymaps using
using *riverctl*(1), start programs such as a status bar, or perhaps *riverctl*(1), start programs such as a status bar, or perhaps run a
run a service manager. If the process started by this flag is still service manager. If the process started by this flag is still running
running when river exits, river will send SIGTERM and and wait for it when river exits, river will send SIGTERM and and wait for it to
to terminate. terminate.
*-l* _log_level_ *-l* _log_level_
Set the log level of river to a value from 0 to 7 with 0 being the Set the log level of river to a value from 0 to 7 with 0 being the
@ -30,8 +31,8 @@ bspwm based on wlroots and written in Zig.
# CONFIGURATION # CONFIGURATION
You can define the list of programs which should float in _Config.zig_. You can define the list of programs which should float in _Config.zig_. Make
Make your changes and recompile. your changes and recompile.
Experimental XWayland support can be enabled on compile-time with the Experimental XWayland support can be enabled on compile-time with the
_-Dxwayland=true_ flag. _-Dxwayland=true_ flag.

View File

@ -1,7 +1,8 @@
RIVERCTL(1) "github.com/ifreund/river" "General Commands Manual" RIVERCTL(1) "github.com/ifreund/river" "General Commands Manual"
# NAME # NAME
riverctl - command-line interface for controlling river riverctl - Command-line interface for controlling river
# SYNOPSIS # SYNOPSIS
@ -9,8 +10,8 @@ riverctl - command-line interface for controlling river
# DESCRIPTION # DESCRIPTION
*riverctl* is a command-line interface inspired by bspc from bspwm *riverctl* is a command-line interface inspired by bspc from bspwm used to
used to control and configure river. control and configure river.
# COMMANDS # COMMANDS
@ -20,15 +21,16 @@ used to control and configure river.
Close the focused view. Close the focused view.
*csd-filter-add* _app-id_ *csd-filter-add* _app-id_
Add an app-id to the CSD filter list. Windows with this app-id are allowed Add an app-id to the CSD filter list. Windows with this app-id are
to use client side decoration instead of the default server side decoration. allowed to use client side decoration instead of the default server
side decoration.
*exit* *exit*
Exit the compositor, terminating the Wayland session. Exit the compositor, terminating the Wayland session.
*float-filter-add* _app-id_ *float-filter-add* _app-id_
Add an app-id to the float filter list. Windows with this app-id will start Add an app-id to the float filter list. Windows with this app-id will
floating. start floating.
*focus-output* *next*|*previous* *focus-output* *next*|*previous*
Focus next or previous output. Focus next or previous output.
@ -54,15 +56,16 @@ used to control and configure river.
the whole screen. the whole screen.
*move* *up*|*down*|*left*|*right* _delta_ *move* *up*|*down*|*left*|*right* _delta_
Move the focused view in the specified direction by _delta_. The view will Move the focused view in the specified direction by _delta_. The view
be set to floating. will be set to floating.
*resize* *horizontal*|*vertical* _delta_ *resize* *horizontal*|*vertical* _delta_
Resize the view in the given orientation by _delta_. The view will be set to Resize the view in the given orientation by _delta_. The view will be
floating. set to floating.
*snap* *up*|*down*|*left*|*right* *snap* *up*|*down*|*left*|*right*
Snap the view to the specified screen edge. The view will be set to floating. Snap the view to the specified screen edge. The view will be set to
floating.
*send-to-output* *next*|*previous* *send-to-output* *next*|*previous*
Send the focused view to the next or the previous output. Send the focused view to the next or the previous output.
@ -73,30 +76,29 @@ used to control and configure river.
interpreted by your shell before the command gets passed to _/bin/sh_. interpreted by your shell before the command gets passed to _/bin/sh_.
*swap* *next*|*previous* *swap* *next*|*previous*
Swap the focused window with the next/previous visible non-floating window. Swap the focused window with the next/previous visible non-floating
When the focused view is the first view there is no previous view. window. When the focused view is the first view there is no previous
In this case *previous* swaps with the last view. view. In this case *previous* swaps with the last view. *next* behaves
*next* behaves analogous. analogous.
*toggle-float* *toggle-float*
If the focused view is floating, make it tiled. If it is tiled, make If the focused view is floating, make it tiled. If it is tiled, make it
it floating. floating.
*toggle-fullscreen* *toggle-fullscreen*
Toggle the fullscreen state of the focused view. Toggle the fullscreen state of the focused view.
*zoom* *zoom*
Bump the focused view to the top of the layout stack to make it the Bump the focused view to the top of the layout stack to make it the new
new master. master.
## ACTIONS ON TAGS ## ACTIONS ON TAGS
Tags are like workspaces but more flexible: You can assign views to Tags are like workspaces but more flexible: You can assign views to multiple
multiple tags and look at multiple tags at once. A _tagmask_ is used tags and look at multiple tags at once. A _tagmask_ is used to represent which
to represent which tags are visible. The following commands take a tags are visible. The following commands take a _tagmask_ in base 10 as
_tagmask_ in base 10 as argument but _tagmasks_ are best understood in argument but _tagmasks_ are best understood in binary: 000000001 means that the
binary: 000000001 means that the first tag is visible; 111111111 means first tag is visible; 111111111 means that tag 1 through 9 are visible.
that tag 1 through 9 are visible.
*set-focused-tags* _tagmask_ *set-focused-tags* _tagmask_
Show the tags specified with _tagmask_. Show the tags specified with _tagmask_.
@ -113,7 +115,8 @@ that tag 1 through 9 are visible.
## CONFIGURATION COMMANDS ## CONFIGURATION COMMANDS
*attach-mode* *top*|*bottom* *attach-mode* *top*|*bottom*
Configure where new views should attach in the view stack for the currently focused output. Configure where new views should attach in the view stack for the
currently focused output.
*background-color* _#RRGGBB_|_#RRGGBBAA_ *background-color* _#RRGGBB_|_#RRGGBBAA_
Set the background color. Set the background color.
@ -134,21 +137,24 @@ that tag 1 through 9 are visible.
Switch to given mode if it exits. Switch to given mode if it exits.
*focus-follows-cursor* *disabled*|*normal*|*strict* *focus-follows-cursor* *disabled*|*normal*|*strict*
When _disabled_ moving the cursor will not influence the focus. This is the default setting. When _disabled_ moving the cursor will not influence the focus. This is
If set to _normal_ moving the cursor over a window will focus that window. the default setting. If set to _normal_ moving the cursor over a window
The focus still can be changed and moving the cursor within the (now unfocused) window will will focus that window. The focus still can be changed and moving the
not change the focus to that window but let the currently focused window in focus. cursor within the (now unfocused) window will not change the focus to
When set to _strict_ this is not the case. The focus will be updated on every cursor movement. that window but let the currently focused window in focus. When set to
_strict_ this is not the case. The focus will be updated on every
cursor movement.
When the to be focused view is on another output than the currently focused output the view's When the to be focused view is on another output than the currently
output is focused. focused output the view's output is focused.
*map* [-release] _mode_ _modifiers_ _key_ _command_ *map* [-release] _mode_ _modifiers_ _key_ _command_
_mode_ is either "normal" (the default mode), "locked" (the mode entered when _mode_ is either "normal" (the default mode), "locked" (the mode
an input inhibitor such as a lock screen is active) or a mode created with *declare-mode*. entered when an input inhibitor such as a lock screen is active) or a
If _-release_ is specified the mapping is executed on key release rather than key press. mode created with *declare-mode*. If _-release_ is specified the
_modifiers_ is a list of one or more of the following mapping is executed on key release rather than key press. _modifiers_
modifiers separated with a plus sign: is a list of one or more of the following modifiers separated with a
plus sign:
- Shift - Shift
- Lock (Caps lock) - Lock (Caps lock)
@ -159,16 +165,18 @@ that tag 1 through 9 are visible.
- Mod4 (Super, Logo, Windows) - Mod4 (Super, Logo, Windows)
- Mod5 - Mod5
_key_ is an XKB key name. See _/usr/include/xkbcommon/xkbcommon-keysyms.h_ _key_ is an XKB key name. See
for a list of special key names. _command_ can be any of the above commands. _/usr/include/xkbcommon/xkbcommon-keysyms.h_ for a list of special key
names. _command_ can be any of the above commands.
A mapping without modifiers can be created by using "None" as sole modifier. A mapping without modifiers can be created by using "None" as sole
modifier.
*map-pointer* _mode_ _modifiers_ _button_ _action_ *map-pointer* _mode_ _modifiers_ _button_ _action_
_mode_ and _modifiers_ are the same as for *map*. _mode_ and _modifiers_ are the same as for *map*.
_button_ is the name of a linux input event code. The most commonly used _button_ is the name of a linux input event code. The most commonly
values are: used values are:
- BTN_LEFT - left mouse button - BTN_LEFT - left mouse button
- BTN_RIGHT - right mouse button - BTN_RIGHT - right mouse button
@ -184,17 +192,18 @@ that tag 1 through 9 are visible.
*opacity* _focused-opacity_ _unfocused-opacity_ _starting-opacity_ _opacity-step_ _opacity-delta-t_ *opacity* _focused-opacity_ _unfocused-opacity_ _starting-opacity_ _opacity-step_ _opacity-delta-t_
Set the server side opacity of views. Set the server side opacity of views.
_focused-opacity_ sets the opacity of the focused window, _unfocused-opacity_ _focused-opacity_ sets the opacity of the focused window,
the opacity of every unfocused window while _starting-opacity_ sets the _unfocused-opacity_ the opacity of every unfocused window while
opacity a window will have at startup before immediately transitioning to _starting-opacity_ sets the opacity a window will have at startup
either the focused or unfocused opacity. These settings require a floating before immediately transitioning to either the focused or unfocused
point number from 0.0 (fully transparent) to 1.0 (fully opaque). opacity. These settings require a floating point number from 0.0 (fully
transparent) to 1.0 (fully opaque).
Opacity transitions can be animated. _opacity-step_ sets the amount the Opacity transitions can be animated. _opacity-step_ sets the amount the
opacity should be increased or decreased per step of the transition. It opacity should be increased or decreased per step of the transition. It
requires a floating point number from 0.05 to 1.0. If set to 1.0, animations requires a floating point number from 0.05 to 1.0. If set to 1.0,
are disabled. _opacity-delta-t_ sets the time between the transition steps animations are disabled. _opacity-delta-t_ sets the time between the
in milliseconds. transition steps in milliseconds.
*outer-padding* _pixels_ *outer-padding* _pixels_
Set the padding around the edge of the screen to _pixels_. Set the padding around the edge of the screen to _pixels_.
@ -204,21 +213,21 @@ that tag 1 through 9 are visible.
repeat delay to _delay_ milliseconds. repeat delay to _delay_ milliseconds.
*unmap* [-release] _mode_ _modifiers_ _key_ *unmap* [-release] _mode_ _modifiers_ _key_
Removes the mapping defined by the arguments *-release*, *modifiers* and *key* from *mode*. Removes the mapping defined by the arguments *-release*, *modifiers*
See *map* for an explanation of the arguments. and *key* from *mode*. See *map* for an explanation of the arguments.
*unmap-pointer* _mode_ _modifiers_ _button_ *unmap-pointer* _mode_ _modifiers_ _button_
Removes the mapping defined by the arguments *modifiers* and *button* from *mode*. Removes the mapping defined by the arguments *modifiers* and *button*
See *map-pointer* for an explanation of the arguments. from *mode*. See *map-pointer* for an explanation of the arguments.
*view-padding* _pixels_ *view-padding* _pixels_
Set the padding around the edge of each view to _pixels_. Set the padding around the edge of each view to _pixels_.
*xcursor-theme* _theme_name_ [_size_] *xcursor-theme* _theme_name_ [_size_]
Set the xcursor theme to _theme_name_ and optionally set the Set the xcursor theme to _theme_name_ and optionally set the _size_.
_size_. The theme of the default seat determines the default The theme of the default seat determines the default for XWayland and
for XWayland and made available through the _XCURSOR_THEME_ and made available through the _XCURSOR_THEME_ and _XCURSOR_SIZE_
_XCURSOR_SIZE_ environment variables. environment variables.
# EXAMPLES # EXAMPLES

View File

@ -2,7 +2,7 @@ RIVERTILE(1) "github.com/ifreund/river" "General Commands Manual"
# NAME # NAME
rivertile - tiled layout generator for river rivertile - Tiled layout generator for river
# SYNOPSIS # SYNOPSIS