From 9cb1a3d51b8cba35ef443c64b5b1d99fa8d33ae6 Mon Sep 17 00:00:00 2001 From: sabetts Date: Thu, 16 Mar 2006 00:33:34 +0000 Subject: remove tabs and trailing whitespace. --- doc/ratpoison.1 | 72 +++++++++++++++++++++++++------------------------- doc/ratpoison.texi | 66 ++++++++++++++++++++++----------------------- doc/sample.ratpoisonrc | 2 +- 3 files changed, 70 insertions(+), 70 deletions(-) (limited to 'doc') diff --git a/doc/ratpoison.1 b/doc/ratpoison.1 index 8e036ee..6d0395d 100644 --- a/doc/ratpoison.1 +++ b/doc/ratpoison.1 @@ -3,12 +3,12 @@ \# it under the terms of the GNU General Public License as published by \# the Free Software Foundation; either version 2, or (at your option) \# any later version. -\# +\# \# This man page is distributed in the hope that it will be useful, \# but WITHOUT ANY WARRANTY; without even the implied warranty of \# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the \# GNU General Public License for more details. -\# +\# \# You should have received a copy of the GNU General Public License \# along with this software; see the file COPYING. If not, write to \# the Free Software Foundation, Inc., 59 Temple Place, Suite 330, @@ -44,7 +44,7 @@ . \} . shift . \} -. shift +. shift . as command@tmp \fP) . nr command@space 0 . \} @@ -71,7 +71,7 @@ ratpoison \- window manager without mouse dependency .P .SH SYNOPSIS -.B ratpoison \-\-help +.B ratpoison \-\-help | .B \-\-version .br @@ -88,11 +88,11 @@ ratpoison \- window manager without mouse dependency .IR dpy ] .RB [ \-s .IR num ] -.RB [ \-i ] +.RB [ \-i ] .B \-c .IR command .RB [ \-c -.I command +.I command \&... ] .SH DESCRIPTION Ratpoison is a Window Manager without fat library @@ -128,11 +128,11 @@ and execute each command when starting up. .TP .B \-i, \-\-interactive Execute commands given with -.B \-c -or -.B \-\-command +.B \-c +or +.B \-\-command in interactive mode. -That means it will behave exactly as if called with +That means it will behave exactly as if called with .B C\-t : like prompting for missing arguments and things like that. .TP @@ -144,7 +144,7 @@ this to work. Do not forget to quote the command if it contains spaces. .SH KEY BINDINGS -To avoid conflicts with other programs, all default ratpoison +To avoid conflicts with other programs, all default ratpoison key bindings start with an escape key, per default .B C\-t (read Control\-t). @@ -206,7 +206,7 @@ Possible events are: .br \fBrestart\fP Run before restarting ratpoison. .br -\fBswitchframe\fP Run after a frame actually switched, +\fBswitchframe\fP Run after a frame actually switched, but before the window in it is focused. .br \fBswitchgroup\fP Run after selecting a new group. @@ -244,7 +244,7 @@ missing arguments.) Add aliases for the new \fBset\fP commands starting with \fBdef\fP to support older scripts. .cmd cother -Like \fBother\fP but switch to the window of the current group that was last +Like \fBother\fP but switch to the window of the current group that was last accessed and has an other resource class but is not currently visible. .cmd curframe ( C\-t F ) Show a bar marking the current frame. @@ -264,7 +264,7 @@ better use the new \fBset resizeunit\fP and so on... .cmd dedicate [ \fB0 | \fB1\fP ] Consider the current frame dedicated/chaste (\fB1\fP) or promiscuous (\fB0\fP). .br -A dedicated frame will not accept new windows. +A dedicated frame will not accept new windows. When new windows are to be focused, they will be opened in a non-dedicated frame instead. .br @@ -278,7 +278,7 @@ with \fBnewkmap\fP. The keymaps \fBtop\fP and \fBroot\fP cannot be deleted. .cmd describekey keymap Grab the next key. Similar to \fBreadkey\fP, describekey -shows only the command in \fIkeymap\fP, +shows only the command in \fIkeymap\fP, that would be executed by \fBreadkey\fP. .cmd echo text Show \fItext\fP as ratpoison message. @@ -305,7 +305,7 @@ Switch to the frame to the left of the current one. Switch to the frame beneath the current one. .cmd focusright ( C\-t Right ) Switch to the frame to the right of the current one. -.cmd focusprev +.cmd focusprev Focus the previous frame. .cmd focusup ( C\-t Up ) Switch to the frame above the current one. @@ -316,14 +316,14 @@ format as generated by \fBfdump\fP. If an argument is supplied, switch to a frame given by number \fIframeno\fP. If no argument is given, show a frame selector in each frame and wait for -a key to be pressed. +a key to be pressed. If the key matches an existing frame selector, this frame gets focused. Frame selectors are by default the numbers starting with zero, but they can be changed by \fBset\fPing \fBframesels\fP. .cmd gdelete [ group ] If the optional argument \fIgroup\fP is supplied, delete group -\fIgroup\fP. Otherwise delete the current group. +\fIgroup\fP. Otherwise delete the current group. If the last group is deleted, a new group with name \fBdefault\fP is created. The group has to be empty, otherwise it cannot be deleted. @@ -353,10 +353,10 @@ Change how in its frame the current window is aligned. .cmd groups Output a list of all groups with their number. .cmd gselect group -Select the group names \fIgroup\fP. +Select the group names \fIgroup\fP. .cmd help [ keymap ] If the optional parameter \fIkeymap\fP is given, -list all keybindings in this keymap, +list all keybindings in this keymap, otherwise list all key bindings in keymap \fIroot\fP. .cmd hsplit [ l\fB/\fR\fIp | "pixels from left" | "\fB\-\fR\fIpixels from right" ] ( C\-t S ) Split the current frame into left frame and a right frame. @@ -369,7 +369,7 @@ Otherwise the right one is \fIpixels from right\fP wide or the left one the number or not. .cmd inext Like \fBnext\fP but switch to the next window with the same -resource class as the current one. +resource class as the current one. (That means the next window belonging to the same application as the current one.) .cmd info ( C\-t i ) @@ -378,11 +378,11 @@ window. (What name means is chosen by "\fBset\ winname\fP".) .cmd iprev Like \fBprev\fP but switch to the previous window with the same -resource class as the current one. +resource class as the current one. (That means the previous window belonging to the same application as the current one.) .cmd iother -Like \fBother\fP but switch to the window of the current group that was last +Like \fBother\fP but switch to the window of the current group that was last accessed and has the same resource class but is not currently visible. .cmd kill ( C\-t K ) Close the X\-connection of the X\-client responsible for the current window. @@ -402,7 +402,7 @@ If a \fIkey\fP is specified, this is sent instead. Note that some applications b default ignore the synthetic key that is sent using this command as it is considered a security hole. xterm is one such application. .cmd msgwait [ seconds ] -Set the duration the message window is shown. +Set the duration the message window is shown. If \fIseconds\fP is zero, wait infinitely. .# This will hopefully be changed to set msgwait some day... .cmd newkmap keymap @@ -422,7 +422,7 @@ the current window. Remove all frames on the current screen except the current frame and maximise this one to the size of the whole screen. .cmd other ( C\-t C\-t ) -Switch to the window of the current group that was last +Switch to the window of the current group that was last accessed but is not currently visible. .cmd prev ( C\-t p ) Switch to the previous window in the current group. @@ -451,7 +451,7 @@ Simulate a rat click with \fIbutton\fP (button 1=left button if none given). Simulate pressing|releasing rat button \fIbutton\fP (1=left button if none given). .cmd readkey keymap Grab the next key pressed, and execute the command associated to this key -in \fIkeymap\fP. +in \fIkeymap\fP. To show it is waiting for a key, ratpoison will change the rat cursor to a square if \fBwaitcursor\fP is set. @@ -461,7 +461,7 @@ configuration: By pressing \fBC-t\fP, which is the only key in the keymap then executes the command in keymap \fBroot\fP belonging to this command. .cmd redisplay ( C\-t l ) Extend the current window to the whole size of its current frame and -redisplay it. +redisplay it. (Useful to redisplay normal windows or bring transient windows to the full size of the frame as only normal windows are maximized by ratpoison) .cmd redo ( C\-t U ) @@ -469,7 +469,7 @@ Revert the last \fIundo\fP of frame changes. .cmd remhook event command Remove command \fIcommand\fP from the list of commands to be called when event \fIevent\fP is hit. (The command has to specified, as an event can -have multiple commands attached to it.) +have multiple commands attached to it.) Use "\fBlisthook\fP \fIhook\fP" to get a list of all attached commands. .cmd remove ( C\-t R ) Remove the current frame and extend some frames around to fill the remaining @@ -535,7 +535,7 @@ If no argument is given, output all ratpoison variables and their values. If one argument is given, output the value of ratpoison variable \fIvariable\fP. .br Otherwise set ratpoison variable \fIvariable\fP to \fIvalue\fP. What values -are valid depends on the variable. +are valid depends on the variable. See the section \fBVARIABLES\fP later in this document for details. .cmd setenv variable value Set the environment variable \fIvariable\fP to \fIvalue\fP. @@ -556,8 +556,8 @@ Select whether ratpoison will show a startup message or not. .cmd time ( C\-t a ) Output current data and time. .cmd title newname ( C\-t A ) -Overwrite the title of the current window with \fInewname\fP. -All following ratpoison commands will only know the +Overwrite the title of the current window with \fInewname\fP. +All following ratpoison commands will only know the window under the new name. .cmd tmpwm tmpwm Temporarily give control over to the other window manager \fItmpwm\fP, @@ -575,7 +575,7 @@ Un\-do the last change to the frameset. The amount of steps that can be undone is specified by the variable \fBmaxundos\fP. .cmd unmanage [ name ] -Add \fIname\fP to the list of unmanaged windows. +Add \fIname\fP to the list of unmanaged windows. Thus, windows of this name will not be managed but allowed to choose their position themselves. @@ -601,9 +601,9 @@ the number or not. Select if focusing a window moves the rat cursor to the place it had been last time this window was focused, or not. .cmd windows [ format ] ( C\-t w ) -In interactive mode, +In interactive mode, show the list of all windows in the current group for -the duration specified by \fBmsgwait\fP +the duration specified by \fBmsgwait\fP If \fBmsgwait\fP is zero, toggle between indefinitely showing and not showing. @@ -634,7 +634,7 @@ In non\-interactive mode, output the list of windows in the current group line by line. The format string can be overwritten by the optional parameter \fIformat\fP. .SH VARIABLES -Ratpoison variables can be shown and set with \fBset\fP. +Ratpoison variables can be shown and set with \fBset\fP. There are: .var resizeunit pixels Set the amount of pixels interactive \fBresize\fPing will add/subtract @@ -723,7 +723,7 @@ Determines whether windows are shown in \fBrow\fPs or in \fBcolumn\fPs. .br Default is column. .var framesels selectors -Override the frame selectors \fBfselect\fP uses. +Override the frame selectors \fBfselect\fP uses. The first character is the selector for the first frame, the second character is the selector for the second frame and so on. diff --git a/doc/ratpoison.texi b/doc/ratpoison.texi index 8debef0..63e9e10 100644 --- a/doc/ratpoison.texi +++ b/doc/ratpoison.texi @@ -85,24 +85,24 @@ This document explains how to use ratpoison. Windows -* Manipulating Windows:: -* Window Classes:: -* Unmanaged Windows:: -* Rudeness:: +* Manipulating Windows:: +* Window Classes:: +* Unmanaged Windows:: +* Rudeness:: Frames -* Splitting Frames:: -* Resizing Frames:: -* Frame Navigation Commands:: -* Saving and Restoring Frame Sets:: -* Frame Numbering:: -* Dedicated Frames:: +* Splitting Frames:: +* Resizing Frames:: +* Frame Navigation Commands:: +* Saving and Restoring Frame Sets:: +* Frame Numbering:: +* Dedicated Frames:: Keystrokes -* Key Maps:: -* Default Key Bindings:: +* Key Maps:: +* Default Key Bindings:: @end detailmenu @end menu @@ -156,7 +156,7 @@ associated with a frame, that window will be opened in the current frame and resized to fit that frame. If the window associated with a frame does not fill the frame -completely, the various gravity commands control how it is placed. +completely, the various gravity commands control how it is placed. If no window was open in that frame before the current window was opened, the X root will be visible behind it. @@ -205,10 +205,10 @@ its best. Windows are what ratpoison manages. @menu -* Manipulating Windows:: -* Window Classes:: -* Unmanaged Windows:: -* Rudeness:: +* Manipulating Windows:: +* Window Classes:: +* Unmanaged Windows:: +* Rudeness:: @end menu @node Manipulating Windows, Window Classes, Windows, Windows @@ -519,7 +519,7 @@ Tells ratpoison to grant raise requests on normal windows @item Bit 2 Tells ratpoison to grant display requests on new transient windows -@item Bit 3 +@item Bit 3 Tells ratpoison to grant display requests on new normal windows @end table @@ -537,7 +537,7 @@ returned. @chapter Groups ratpoison provides functionality to group windows together. This coupled with saving and restoring frames configurations is what most -people would call @dfn{virtual desktops} or @dfn{workspaces}. +people would call @dfn{virtual desktops} or @dfn{workspaces}. While ratpoison doesn't explicitly provide support for such things, it does allow you to write scripts to this end. Such a script exists in @@ -602,12 +602,12 @@ time. ratpoison allows you to split the display into frames (see @ref{Concepts}). Each frame can then contain 1 window. @menu -* Splitting Frames:: -* Resizing Frames:: -* Frame Navigation Commands:: -* Saving and Restoring Frame Sets:: -* Frame Numbering:: -* Dedicated Frames:: +* Splitting Frames:: +* Resizing Frames:: +* Frame Navigation Commands:: +* Saving and Restoring Frame Sets:: +* Frame Numbering:: +* Dedicated Frames:: @end menu @node Splitting Frames, Resizing Frames, Frames, Frames @@ -940,8 +940,8 @@ key. ratpoison will tell you it isn't bound and give you the name of the key. @menu -* Key Maps:: -* Default Key Bindings:: +* Key Maps:: +* Default Key Bindings:: @end menu @node Key Maps, Default Key Bindings, Keystrokes, Keystrokes @@ -971,7 +971,7 @@ definekey top C-x readkey ctrl-x The following functions control creating, editing, and deleting key maps. @deffn Command newkmap @var{kmap} -Create a new keymap named @var{kmap}. +Create a new keymap named @var{kmap}. @end deffn @@ -1228,7 +1228,7 @@ List the commands that will be run when @var{hook} is fired. @chapter The Status Bar ratpoison presents status and output through the status bar. By default -it is located in the top right corner of the screen. +it is located in the top right corner of the screen. This chapter presents commands for manipulating the status bar. @@ -1324,7 +1324,7 @@ alternative's missing functionality. According to independant studies, @command{tmpwm} has been used almost exclusively to verify its correct operation -- like a vintage sports -car: always kept in prime condition and never used. +car: always kept in prime condition and never used. @command{tmpwm} and @command{newwm} are provided for boasting and completeness. @@ -1448,7 +1448,7 @@ This command is only useful when called non-interactively. @command{prompt} prompts the user for input using @var{prompt} and returns the input. @end deffn - + @deffn Command putsel @var{text} Make text the X11 selection. @end deffn @@ -1700,7 +1700,7 @@ in conjunction with the @option{-c} option. @item -f, --file Specify an alternate configuration file. @xref{Startup file}. - + @end table @node Startup file, Command Index, Command Line Arguments, Top @@ -1711,7 +1711,7 @@ old file I forgot about. You're probably wondering, ``say, didn't he say there was no configuration file to customize?''. Okay, ya got me. But let's be honest here: ratpoison is so pure and fast-acting, customization is barely worth the extra effort. In the off chance that you need to make -ratpoison your own, we now support it. +ratpoison your own, we now support it. On startup ratpoison looks for @file{~/.ratpoisonrc} and runs it through the command parser. If @file{~/.ratpoisonrc} does not exist, ratpoison diff --git a/doc/sample.ratpoisonrc b/doc/sample.ratpoisonrc index 6dbfc99..786b576 100644 --- a/doc/sample.ratpoisonrc +++ b/doc/sample.ratpoisonrc @@ -18,7 +18,7 @@ exec xterm bind e exec emacs # bind s to interactively run a surfraw query on freshmeat -bind s colon exec xterm -e freshmeat +bind s colon exec xterm -e freshmeat # bind b (`b' for browse) to interactively ask for an URL to open bind b colon exec mozilla http://www. -- cgit v1.2.3