From ddc7997d2f254862063c9d367fd79c5db3d016ef Mon Sep 17 00:00:00 2001 From: tiosgz Date: Mon, 30 Oct 2023 13:45:30 +0000 Subject: [PATCH] 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. --- doc/riverctl.1.scd | 15 +++++++++++++++ 1 file changed, 15 insertions(+) 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