ratpoison-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[RP] [PATCH 6/6] Update XRandr related documentation and man.


From: Mathieu OTHACEHE
Subject: [RP] [PATCH 6/6] Update XRandr related documentation and man.
Date: Fri, 25 Nov 2016 15:35:23 +0100

---
 doc/ratpoison.mdoc.1 |  9 +++++++--
 doc/ratpoison.texi   | 17 ++++++++++++-----
 2 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/doc/ratpoison.mdoc.1 b/doc/ratpoison.mdoc.1
index 2e3c356..85ef172 100644
--- a/doc/ratpoison.mdoc.1
+++ b/doc/ratpoison.mdoc.1
@@ -709,7 +709,9 @@ New normal windows end up in the foreground.
 Default is all allowed i.e.\& 15.
 .It Ic sdump
 Output the list of all screens.
-The screens are separated by commas. Each screen is shown as 6 values:
+The screens are separated by commas. The first value is the screen name.
+It is only visible if XRandr support is enabled. After the optional name,
+each screen is shown as 6 values:
 its number, its x-coordinate, its y-coordinate, its width, its height
 and if it is currently selected (1=true, 0=false).
 .It Ic select ( Cm \- | Ar name | Ar number ) Pq Ic C\-t \&'
@@ -752,11 +754,13 @@ Output all frames similar to
 .Ic fdump ,
 but not limited to one screen, but all screens at once and with the
 screen number after each frame.
+This command is disabled if XRandr support is not enabled.
 .It Ic sfrestore Ar frames
 Replace the current frames with the ones specified in
 .Ar frames
 in the format as generated by
 .Ic sfdump .
+This command is disabled if XRandr support is not enabled.
 .It Ic shrink
 Shrink the current frame to the size of the current window with in.
 .It Ic split Oo Ar split Oc Pq Ic C\-t s
@@ -772,6 +776,7 @@ command.
 Switch to the screen
 .Ar screennumber .
 (If you have multiple physical ones.)
+This command is disabled if XRandr support is not enabled.
 .It Ic startup_message Cm ( on | off )
 Select whether
 .Nm
@@ -924,7 +929,7 @@ width of the window
 .It Li %W
 unit to resize the window horizontally (width_inc)
 .It Li %x
-xine screen number
+Xrandr screen number
 .It Li %%
 litteral
 .Ql %
diff --git a/doc/ratpoison.texi b/doc/ratpoison.texi
index da9da16..2380c42 100644
--- a/doc/ratpoison.texi
+++ b/doc/ratpoison.texi
@@ -890,8 +890,11 @@ yourself attaching a second monitor to your computer. 
ratpoison has
 functionality to help you get around your new and improved desktop
 space.
 
-The X Windowing System assigns each monitor a screen number. To switch
-to another screen use the commands @command{nextscreen} and
+Ratpoison uses the X Windowing System RandR extension to work with multiple
+monitors. Ratpoison only supports XRandr 1.2 or later.
+XRandr will assigns each monitor a unique screen number.
+
+To switch to another screen use the commands @command{nextscreen} and
 @command{prevscreen}. Or, @command{sselect} to jump to a specified
 screen. ratpoison will tell you which frame has focus by drawing the
 current frame indicator in it.
@@ -906,18 +909,22 @@ switch to it by name (use @command{select} or @kbd{C-t 
'}), by number,
 or you can use @command{nextscreen}, @command{prevscreen}, and
 @command{sselect}.
 
+Please note that besides @command{sdump}, all other commands are disabled
+if you don't have XRandr support.
+
 @deffn Command nextscreen
-This jumps you to the next X11 screen. @command{nextscreen} is
+This jumps you to the next XRandr screen. @command{nextscreen} is
 used for dual-head displays and multiple monitor setups.
 @end deffn
 
 @deffn Command prevscreen
-This jumps you to the previous X11 screen. @command{prevscreen} is
+This jumps you to the previous XRandr screen. @command{prevscreen} is
 used for dual-head displays and multiple monitor setups.
 @end deffn
 
 @deffn Command sselect @var{n}
-This jumps you to the @var{n}th X11 screen. Screen numbers start at 0.
+This jumps you to the @var{n} XRandr screen. Screen numbers are unsigned
+integers assigned by XRandr.
 @end deffn
 
 @deffn Command sdump
-- 
2.10.0




reply via email to

[Prev in Thread] Current Thread [Next in Thread]