aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortiosgz <alamica@protonmail.com>2023-10-30 13:45:30 +0000
committertiosgz <alamica@protonmail.com>2023-10-30 13:53:01 +0000
commitddc7997d2f254862063c9d367fd79c5db3d016ef (patch)
tree8731ac06320e69dcfbfcf7cd231a20efc7b809ae
parent5da4769c2357072771e89f00bdd68098b2ef3660 (diff)
downloadriver-ddc7997d2f254862063c9d367fd79c5db3d016ef.tar.gz
river-ddc7997d2f254862063c9d367fd79c5db3d016ef.tar.xz
riverctl(1): add a section on terminology
It is not unusual to see people coming to river directly from X11, confused by some things being renamed (and by river having tags). Give them some basic help for reading the manpage and understanding our talk.
-rw-r--r--doc/riverctl.1.scd15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/riverctl.1.scd b/doc/riverctl.1.scd
index f3ec0a9..a418322 100644
--- a/doc/riverctl.1.scd
+++ b/doc/riverctl.1.scd
@@ -21,6 +21,21 @@ over the Wayland protocol.
*-version*
Print the version number and exit.
+# TERMINOLOGY
+
+This manual uses terms that some may find confusing, coming mostly from their
+usage among other Wayland projects.
+
+The *compositor*, display server, Wayland server etc. are ways to refer to river
+itself.
+
+A *view* (or *toplevel*) is what most call a window.
+
+An *output* is a synonym for a screen or monitor.
+
+*Tags* are river's way of dividing views of an output into groups (not
+necessarily disjunct), an analogy to workspaces.
+
# COMMANDS
## ACTIONS