6. Frames

Frames contain windows. All windows exist within a frame.

Those used to ratpoison will notice that this differs from ratpoison's window pool, where windows and frames are not so tightly connected.

Command: pull-window-by-number N &OPTIONAL (GROUP (CURRENT-GROUP))

NIL

Command: hsplit

Split the current frame into 2 side-by-side frames.

Command: vsplit

Split the current frame into 2 frames, one on top of the other.

Command: remove-split &OPTIONAL (GROUP (CURRENT-GROUP)) (FRAME

(TILE-GROUP-CURRENT-FRAME GROUP)) NIL

Command: only

Delete all the frames but the current one and grow it to take up the entire head.

Command: curframe

Display a window indicating which frame is focused.

Command: fnext

Cycle through the frame tree to the next frame.

Command: sibling

Jump to the frame's sibling. If a frame is split into two frames, these two frames are siblings.

Command: fother

Jump to the last frame that had focus.

Command: fselect FRAME-NUMBER

Display a number in the corner of each frame and let the user to select a frame by number. If frame-number is specified, just jump to that frame.

Command: resize WIDTH HEIGHT

Resize the current frame by width and height pixels

Command: balance-frames

Make frames the same height or width in the current frame's subtree.

Command: fclear

Clear the current frame.

Command: move-focus DIR

Focus the frame adjacent to the current one in the specified direction. The following are valid directions:

up

down

left

right

Command: move-window DIR

Just like move-focus except that the current is pulled along.

Command: next-in-frame

Go to the next window in the current frame.

Command: prev-in-frame

Go to the previous window in the current frame.

Command: other-in-frame

Go to the last accessed window in the current frame.

Command: echo-frame-windows &OPTIONAL (FMT *WINDOW-FORMAT*)

NIL

Command: exchange-direction DIR &OPTIONAL (WIN (CURRENT-WINDOW))

NIL

Variable: *min-frame-width*

The minimum width a frame can be. A frame will not shrink below this width. Splitting will not affect frames if the new frame widths are less than this value.

Variable: *min-frame-height*

The minimum height a frame can be. A frame will not shrink below this height. Splitting will not affect frames if the new frame heights are less than this value.

Variable: *new-frame-action*

When a new frame is created, this variable controls what is put in the new frame. Valid values are

:empty

The frame is left empty

:last-window

The last focused window that is not currently visible is placed in the frame. This is the default.

6.1 Interactively Resizing Frames

There is a mode called iresize that lets you interactively resize the current frame. To enter the mode use the iresize command or type <C-t r>.

The following keybindings apply to the mode:

C-p

Up

k

Shrink the frame vertically.

C-n

Down

j

Expand the frame vertically.

C-f

Right

l

Expand the frame horizontally.

C-b

Left

h

Shrink the frame horizontally.

C-g

ESC

Abort the interactive resize. NOTE: This currently doesn't work.

RET

Select the highlighted option.

Command: iresize

Start the interactive resize mode. A new keymap specific to resizing the current frame is loaded. Hit <C-g>, <RET>, or <ESC> to exit.

Command: abort-iresize

Exit from the interactive resize mode.

Command: exit-iresize

Exit from the interactive resize mode.

Variable: *resize-increment*

Number of pixels to increment by when interactively resizing frames.

6.2 Frame Dumping

The configuration of frames and groups can be saved and restored using the following commands.

Command: dump-desktop-to-file FILE

Dumps the frames of all groups of all screens to the named file

Command: dump-group-to-file FILE

Dumps the frames of the current group of the current screen to the named file.

Command: dump-screen-to-file FILE

Dumps the frames of all groups of the current screen to the named file

Command: restore-from-file FILE

Restores screen, groups, or frames from named file, depending on file's contents.

Command: place-existing-windows

Re-arrange existing windows according to placement rules.

This document was generated by Shawn Betts on August, 4 2009 using texi2html 1.78.