diff options
Diffstat (limited to 'doc/ratpoison.texi')
| -rw-r--r-- | doc/ratpoison.texi | 111 |
1 files changed, 51 insertions, 60 deletions
diff --git a/doc/ratpoison.texi b/doc/ratpoison.texi index 8876db1..fb26dac 100644 --- a/doc/ratpoison.texi +++ b/doc/ratpoison.texi @@ -321,8 +321,16 @@ 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 WMNAME hint, the res_name from the WMCLASS hint, or the res_class from the WMCLASS hint. @var{name} can be @samp{title} which is what most @@ -333,7 +341,6 @@ When called with no arguments, the current setting is returned. @end deffn @deffn Command {set wingravity} @var{g} -@c @deffnx Command defwingravity @var{g} Set the default gravity for normal windows. See the @command{gravity} command. @@ -341,13 +348,11 @@ When called with no arguments, the current setting is returned. @end deffn @deffn Command {set winliststyle} @var{setting} -@c @deffnx Command defwinliststyle @var{setting} The window list can be displayed in a row or a column. @var{setting} can be @samp{row} or @samp{column}. @end deffn @deffn Command {set winfmt} @var{fmt} -@c @deffnx Command defwinfmt @var{fmt} Set the default window format for the @command{windows} command. By default it is @samp{%n%s%t}. The following is a list of valid format characters: @@ -410,7 +415,6 @@ omitted ratpoison defaults to the current window. @end deffn @deffn Command {set transgravity} @var{g} -@c @deffnx Command deftransgravity @var{g} Set the default alignment for transient windows. See the @command{gravity} command. @@ -419,7 +423,6 @@ returned. @end deffn @deffn Command {set maxsizegravity} @var{g} -@c @deffnx Command defmaxsizegravity @var{g} Set the default alignment for windows with maxsize hints. See the @command{gravity} command. @@ -428,7 +431,6 @@ returned. @end deffn @deffn Command {set border} @var{n} -@c @deffnx Command defborder @var{n} Set the border width for all windows. When called with no arguments, the current setting is @@ -504,12 +506,12 @@ Some programs will attempt to steal the focus without the users permission. Not only is this a sign of a lame programmers attempt to fix a window manager problem in the wrong place, it's just plain rude. By default ratpoison will honour these rudeness requests, but it doesn't -have to. Use the @command{rudeness} command to deal with such programs. +have to. Use the rudeness variable to deal with such programs. -@deffn Command rudeness @var{n} -The rudeness command lets you decide what windows pop-up automatically -and when. This is often useful for those deep hack sessions when you -absolutely can't be disturbed. +@deffn Command {set rudeness} @var{n} +The rudeness variable lets you decide what windows pop-up +automatically and when. This is often useful for those deep hack +sessions when you absolutely can't be disturbed. There are two kinds of windows: normal windows (like an xterm) and transient windows (generally pop-up dialog boxes). When a client @@ -537,8 +539,9 @@ Tells ratpoison to grant display requests on new normal windows @end table For example, if you wanted only wanted to grant transient windows -raise requests and display requests you would type @samp{rudeness -5}. If a request is not granted ratpoison will tell you about the +raise requests and display requests you would type @samp{set rudeness +5}. +If a request is not granted ratpoison will tell you about the request with a message like @samp{Raise request from window 1 (emacs)}. @@ -737,7 +740,6 @@ The increment size used to resize the frame interactively is customized with the command @command{set resizeunit}. @deffn Command {set resizeunit} @var{pixels} -@c @deffnx Command defresizeunit @var{pixels} Set the number of pixels a frame will grow or shrink by when being dynamically resized. @@ -1265,6 +1267,8 @@ Run when the user switches to another frame. This is also run when the user switches to a different screen, since a frame switch also occurs. @item switchgroup Run when the user switches to a different group. +@item switchscreen +Run when the user switches to a different screen. @item deletewindow Run when a window is deleted. @item newwindow @@ -1301,13 +1305,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 @@ -1316,8 +1313,14 @@ 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. When called with no arguments, the current setting is @@ -1325,7 +1328,6 @@ returned. @end deffn @deffn Command {set font} @var{font} -@c @deffnx Command deffont @var{font} Set the font. @var{font} is a font string like @samp{9x15bold}. When called with no arguments, the current setting is returned. @@ -1338,7 +1340,6 @@ characters as @command{set winfmt}. @end deffn @deffn Command {set fgcolor} @var{color} -@c @deffnx Command deffgcolor @var{color} Set the foreground color for all text ratpoison displays. @var{color} is any valid X11 color. @@ -1346,7 +1347,6 @@ When called with no arguments, the current setting is returned. @end deffn @deffn Command {set bgcolor} @var{color} -@c @deffnx Command defbgcolor @var{color} Set the background color for all text ratpoison displays. @var{color} is any valid X11 color. @@ -1367,8 +1367,14 @@ 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. When called with no arguments, the current setting is @@ -1376,7 +1382,6 @@ returned. @end deffn @deffn Command {set bargravity} @var{g} -@c @deffnx Command defbargravity @var{g} Set the default alignment for the message bar. See the @command{gravity} command. When called with no arguments, the current setting is @@ -1385,7 +1390,6 @@ returned. @deffn Command {set barborder} @var{n} -@c @deffnx Command defbarborder @var{n} Set the border width for the bar window. When called with no arguments, the current setting is returned. @@ -1393,7 +1397,6 @@ When called with no arguments, the current setting is returned. @deffn Command {set barinpadding} @var{n} -@c @deffnx Command defbarinpadding @var{n} Set whether the bar window appears at the edge of the screen when there is padding -- that is, within the "padding" area -- or whether it appears at the edge of the window area. "1" represents the former, "0" the latter. See the @@ -1482,20 +1485,13 @@ Change the current directory for ratpoison. Run a ratpoison command. @end deffn -@deffn Command compat -Install the now obsolete @samp{def*} commands as aliases to the -corresponding @samp{set *} command. -@end deffn - @deffn Command {set padding} @var{left} @var{top} @var{right} @var{bottom} -@c @deffnx Command defpadding @var{left} @var{top} @var{right} @var{bottom} Set the padding around the edge of the screen. When called with no arguments, the current setting is returned. @end deffn @deffn Command {set waitcursor} @var{n} -@c @deffnx Command defwaitcursor @var{n} Set whether the rat cursor should change into a square when waiting for a key. A non-zero number means change the cursor. Zero means don't change the cursor. @@ -1559,7 +1555,7 @@ work. @end deffn @deffn Command getenv @var{env} -Display the value of the environment variable, @var{env}. +Display the value of the environment variable @var{env}. @end deffn @deffn Command getsel @@ -1646,8 +1642,7 @@ Restart ratpoison. @end deffn @deffn Command set @var{var} @var{value} -Set the value of a ratpoison variable. This command replaces the older -@samp{def*} variable get/set style. +Set the value of a ratpoison variable. Here is a list of variables that can be set: @@ -1674,6 +1669,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 @@ -1686,14 +1685,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 @@ -1721,13 +1712,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 @@ -1841,11 +1825,11 @@ from the command-line. with the @option{-c} option you can script ratpoison using any programming language that can spawn a process. Some commands behave differently when invoked this way. Currently the only commands that behaves differently are the -@code{windows} command and some def* commands. Instead of displaying -the window list in a message window, it is printed to stdout. The -output can then be captured and used in the ratpoison script. For -instance, this could be used to check whether a program is running and -if it is switch to its window otherwise launch it. +@code{windows} and @code{set} commands. For @code{windows}, instead of +displaying the window list in a message window, it is printed to +stdout. The output can then be captured and used in the ratpoison +script. For instance, this could be used to check whether a program is +running and if it is switch to its window otherwise launch it. It should also be noted that multiple @option{-c} options can be used. @@ -1887,6 +1871,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 |