RPFJ

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
EXIT STATUS
FILES
NOTES
BUGS
EXAMPLE
SEE ALSO

NAME

rpfj − RatPoison Frameset Juggler

SYNOPSIS

rpfj [-d] [-g [id]] [-h] [-l] [-s [id]] [-V]

DESCRIPTION

rpfj works with the ratpoison(1) window manager to store and recall framesets, both immediately and across sessions.

OPTIONS

	-d		Dump framesets 1 to 9 to rpfj’s data file (see section FILES, below). Dumping framesets with arbitrary names is not supported: Single-digit names only, 1 to 9.
	-g[id]		Go to frameset id, or — with no argument given — to the formerly selected frameset (ping-pong between the two most recently seen framesets).
	-h		Display a usage summary and exit.
	-i		Display the currently selected frameset’s number.
	-l		Load framesets from rpfj’s data file (see section FILES, below).
	-q		Quiet: the -g and -s options will not show a message on ratpoison’s bar.
	-s[id]		Store current frameset to frameset id, or — with no argument given — to itself (thus updating the current frameset).
	-V		Print version information and exit.

EXIT STATUS

	0		OK.
	1		ratpoison not found in your $PATH.
	64		Command line usage error.
	73		Error while dumping framesets to rpfj’s data file (see section FILES, below).

FILES

rpfj will try to create and read its data file at one of the following locations, in preferential order:
$HOME/etc/rpfj.dat

if $HOME/etc exists and is writable;

$HOME/.rpfj

if $HOME exists and is writable.

Failing both attempts:

	•		the -d option will simply give up dumping framesets to disk; rpfj will fail with error code 73 (see section EXIT STATUS, above);
	•		the -l option will initialize ratpoison’s environment with default frameset pointers.

NOTES

Option order matters:
rpfj -s -g2

will first store the current frameset into itself (i.e.: update it), then switch to frameset 2;

rpfj -g2 -s

will first switch to frameset 2, then update it (which probably isn’t very useful).

BUGS

	•		For performance reasons, no checks are performed on the argument passed to options -g and -s. Passing strange frameset names containing spaces or other, non-alphanumeric characters, will fail ungracefully;
	•		rpfj stores its framesets and pointers in ratpoison’s environment, rudely overwriting whatever variable might already live there, whose name collides with rpfj’s namespace. Such a collision would however be an incredibly unlucky coincidence;
	•		the -d option only works correctly if rpfj is launched by ratpoison, because rpfj needs to inherit ratpoison’s environment in order to store the framesets to its data file.

Report actual bugs to the author:

Andrea Remondini

EXAMPLE

rpfj’s distribution directory contains a file called EXAMPLE.ratpoisonrc, which shows how to configure ratpoison(1) for use with rpfj. A key combination (Windows Key + f) is defined to enter, let’s call it, frameset mode. A number key — 1 to 9 — pressed thereafter, will switch to the corresponding frameset. Ctrl + number key will store the current set of frames at that number. The a key will recall the formerly selected frameset. The i key will display information on which frameset is currently on screen.

Simply append said file, as it is, to your ~/.ratpoisonrc, or tweak it to taste.