Skip to content
Manage Emacs frames by name
Emacs Lisp
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE.txt
README.org
nameframe-demo.gif
nameframe-eyebrowse.el
nameframe-perspective.el
nameframe-projectile.el
nameframe.el

README.org

Nameframe

Nameframe provides utility functions to manage frames by their names.

It’s primary goal is to be used with Projectile and/or perspective.el. When opening a Projectile project, it will either switch to an existing frame of the project, or create a new frame for the project.

Installation

MELPA

Nameframe is now available on MELPA. The Projectile and perspective.el integrations are distributed separately (and thus will need to be installed separately).

  • M-x package-install RET nameframe RET
  • M-x package-install RET nameframe-projectile RET
  • M-x package-install RET nameframe-perspective RET

Manual install

Copy nameframe.el into your Emacs load path.

Optionally, copy nameframe-projectile.el and nameframe-perspective.el into your load path as well. See Usage section below for details.

Usage

Vanilla

symboldescription
nameframe-switch-frame(interactive) function to switch between existing frames by name
nameframe-create-frame(interactive) function to create a new frame

Projectile

Nameframe provides Projectile integration to open projects in their own frames. To enable Projectile integration, add the following line to your init file:

(nameframe-projectile-mode t)

With Projectile integration enabled, a hook is added to create/switch to a project’s frame when switching projects.

Perspective

Nameframe also provides perspective.el integration, so each frame has its own perspective (and thus have its own list of buffers).

To enable perspective integration, add the following line to your init file:

(nameframe-perspective-mode t)

With perspective integration enabled, calling nameframe-create-frame will now create a perspective.

Recommended setup

Although the Projectile and perspective.el integrations are optional, nameframe really shines when used in conjunction with both packages. Here is a snippet on how to use nameframe to its full potential:

;; Assuming Projectile and perspective.el are already installed

(projectile-global-mode)
(persp-mode)

(nameframe-projectile-mode t)
(nameframe-perspective-mode t)

;; If your OS can't switch between applications windows by default *cough* OS X *cough*
;; you can have a shortcut to switch between existing frames by name
(global-set-key (kbd "M-P") 'nameframe-switch-frame)

With this setup, switching to a project will open it in its own dedicated frame with isolated buffers.

Caveats

  • Only (thoroughly) tested on GUI Emacs 24.5 on OS X
    • but seems to work fine on terminal Emacs
  • Does not work with Helm (I personally don’t use Helm. Pull-requests welcome.)

Demo with Projectile

https://raw.githubusercontent.com/john2x/nameframe/master/nameframe-demo.gif

License

See LICENSE.txt.

You can’t perform that action at this time.