texinfo documentation for variables msgwait, framemsgwait, startupmessage and warp

1 files changed, 34 insertions, 22 deletions

diff --git a/doc/ratpoison.texi b/doc/ratpoison.texi
index da9da16..e05f294 100644
--- a/doc/ratpoison.texi
+++ b/doc/ratpoison.texi
@@ -321,6 +321,15 @@ Set the default window format for the @command{info} command. See
 @command{set winfmt} for accepted format characters.
 @end deffn
 
+@deffn Command {set warp} @var{n}
+Set rat warping. By default this variable is set (@code{1}) and
+ratpoison saves the position of the rat when leaving a window and when
+the user returns to the window the rat's position is restored. If you
+find this counter-intuitive, set this variable to @code{0}.
+
+When called with no arguments, the current setting is returned.
+@end deffn
+
 @deffn Command {set winname} @var{name}
 @c @deffnx Command defwinname @var{name}
 There are three resources ratpoison can get a window's name from: the
@@ -1299,13 +1308,6 @@ opposed to the invisible evidence including the lack of title bars and
 your favorite desktop background) there are also copious visual
 customizations available for those rainy days.
 
-@deffn Command msgwait @var{n}
-Set the bar's timeout in seconds.
-
-When called with no arguments, the current setting is
-returned.
-@end deffn
-
 @deffn Command lastmsg
 Display the last message.
 @end deffn
@@ -1314,6 +1316,13 @@ Display the last message.
 Display @var{text} as a message.
 @end deffn
 
+@deffn Command {set msgwait} @var{n}
+Set the bar's timeout in seconds.
+
+When called with no arguments, the current setting is
+returned.
+@end deffn
+
 @deffn Command {set inputwidth} @var{n}
 @c @deffnx Command definputwidth @var{n}
 Set the width of the input window.
@@ -1365,6 +1374,13 @@ is any valid X11 color.
 When called with no arguments, the current setting is returned.
 @end deffn
 
+@deffn Command {set framemsgwait} @var{n}
+Set the duration the @samp{Current frame} indicator is shown.  If seconds
+is zero, wait until the next interactive command.
+
+When called with no arguments, the current setting is returned.
+@end deffn
+
 @deffn Command {set barpadding} @var{x} @var{y}
 @c @deffnx Command defbarpadding @var{x} @var{y}
 Set the horizontal and vertical padding inside the bar.
@@ -1672,6 +1688,10 @@ Here is a list of variables that can be set:
 @item historysize
 @item historycompaction
 @item historyexpansion
+@item msgwait
+@item framemsgwait
+@item startupmessage
+@item warp
 @end itemize
 
 @end deffn
@@ -1684,14 +1704,6 @@ Set the environment variable @var{env} to @var{value}
 Read a text file containing ratpoison commands.
 @end deffn
 
-@deffn Command startup_message @var{state}
-Turn on or off the startup_message. This is most useful in your
-.ratpoisonrc file. @var{state} can be @code{on} or @code{off}.
-
-When called with no arguments, the current setting is
-returned.
-@end deffn
-
 @deffn Command swap @var{destination-frame} @var{source-frame}
 When called interactively prompt for a frame and swap its window with
 the window in the current frame. An optional second argument allows
@@ -1719,13 +1731,6 @@ message saying command was executed.
 Print ratpoison version.  By default, this is bound to @kbd{C-t v}.
 @end deffn
 
-@deffn Command warp @var{state}
-Toggle rat warping. By default ratpoison saves the position of the
-rat when leaving a window and when the user returns to the window the
-rat's position is restored. This can be counter-intuitive, so you can
-toggle it with this command. @var{state} can be @code{on} or @code{off}.
-@end deffn
-
 @node Input
 @chapter Input
 At various times ratpoison will prompt you for input. Ratpoison sports
@@ -1885,6 +1890,13 @@ You can also use the @option{-f} option to specify another startup
 file, allowing you to switch between different configurations
 (@pxref{Command Line Arguments}).
 
+@deffn Command {set startupmessage} @var{n}
+Turn on or off the startup_message. This is most useful in your
+.ratpoisonrc file. @var{n} can be @code{1} (default) or @code{0}.
+
+When called with no arguments, the current setting is returned.
+@end deffn
+
 @node GNU Free Documentation License
 @chapter GNU Free Documentation License
 @include fdl.texi