8. Groups

Groups in StumpWM are more commonly known as virtual desktops or workspaces. Why not create a new term for it?

Command: gnew NAME

Create a new group with the specified name. The new group becomes the current group. If name begins with a dot (“.”) the group new group will be created in the hidden state. Hidden groups have group numbers less than one and are invisible to from gprev, gnext, and, optionally, groups and vgroups commands.

Command: gnew-float NAME

Create a floating window group with the specified name and switch to it.

Command: gnewbg NAME

Create a new group but do not switch to it.

Command: gnewbg-float NAME

Create a floating window group with the specified name, but do not switch to it.

Command: gnext

Cycle to the next group in the group list.

Command: gprev

Cycle to the previous group in the group list.

Command: gnext-with-window

Cycle to the next group in the group list, taking the current window along.

Command: gprev-with-window

Cycle to the previous group in the group list, taking the current window along.

Command: gother

Go back to the last group.

Command: gmerge FROM

Merge from into the current group. from is not deleted.

Command: groups &OPTIONAL (FMT *GROUP-FORMAT*)

NIL

Command: vgroups &OPTIONAL GFMT WFMT

NIL

Command: gselect TO-GROUP

Select the first group that starts with substring. substring can also be a number, in which case gselect selects the group with that number.

Command: gmove TO-GROUP

Move the current window to the specified group.

Command: gkill

Kill the current group. All windows in the current group are migrated to the next group.

Command: grename NAME

Rename the current group.

Command: grouplist &OPTIONAL (FMT *GROUP-FORMAT*)

NIL

8.1 Customizing Groups

Variable: *group-formatters*

An alist of characters and formatter functions. The character can be used as a format character in *group-format*. When the character is encountered in the string, the corresponding function is called with a group as an argument. The functions return value is inserted into the string. If the return value isn't a string it is converted to one using prin1-to-string.

Variable: *group-format*

The format string that decides what information will show up in the group listing. The following format options are available:

%n

The group's number.

%s

The group's status. Similar to a window's status.

%t

The group's name.

Function: current-group &OPTIONAL (SCREEN (CURRENT-SCREEN))

NIL

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