emacs-winum/README.org

Window numbers for Emacs !

• Contents
• Introduction
• Installation
• How to use
  • Navigate windows
  • Delete windows
• Configuration
  • Custom keymap
  • Customize options

Contents   TOC

• Introduction
• Installation

• How to use

  • Navigate windows
  • Delete windows

• Configuration

  • Custom keymap
  • Customize options

Introduction

Window numbers for Emacs: Navigate your windows and frames using numbers !

This package is an extended and actively maintained version of the https://github.com/nschum/window-numbering.el package by Nikolaj Schumacher, with some ideas and code taken from https://github.com/abo-abo/ace-window.

This version brings, among other things, support for number sets across multiple frames, giving the user a smoother experience of multi-screen Emacs.

Installation

• Clone the repo:

  cd /path/to/install/folder
  git clone https://github.com/deb0ch/winum.el

• Add the following to your Emacs configuration:

  (add-to-list 'load-path "/path/to/install/folder/winum.el/")

  (require 'winum)

  (winum-mode)

How to use

Navigate windows

Use M-1 to M-9 to navigate windows numbered 1 to 9.

The functions for selecting windows are the select-window-[1..N] functions, where N is the maximum window number.

See configuration to rebind them any way you prefer.

Delete windows

Use M-1 to M-9 with an Emacs prefix argument to delete a window instead of selecting it.

Configuration

Custom keymap

To define your own bindings and override the default ones, override winum-keymap before activating the mode:

  (require 'winum)

  (setq winum-keymap (let ((map (make-sparse-keymap)))
  (define-key map "\M-m 0" 'select-window-0)
		     ; ...
  (define-key map "\M-m 9" 'select-window-9)
  map))
  (winum-mode)

This way your bindings will not error when the mode is turned off.

Customize options

Several options are available through Emacs' Customize interface under convenience > winum:

• winum-scope

Frames affected by a number set. Choices are 'frame-local 'visible or 'global.

Default: 'global

• winum-reverse-frame-list

If t, order frames by reverse order of creation. Has effect only when `winum-scope' is not 'frame-local.

Default: nil

• winum-auto-assign-0-to-minibuffer

If non-nil, winum-mode assigns 0 to the minibuffer if active.

Default: t

• winum-before-hook

Hook called before winum-mode starts assigning numbers. The list of windows to be numbered is passed as a parameter. Use winum--assign to manually assign some of them a number. If you want to assign a number to just one buffer, use winum-assign-func instead.

Default: nil

• winum-assign-func

Function called for each window by winum-mode. This is called before automatic assignment begins. The function should return a number to have it assigned to the current-window, nil otherwise.

Default: nil

Example: always assign the calculator window the number 9:

    (setq winum-assign-func
	  (lambda () (when (equal (buffer-name) "*Calculator*") 9)))

• winum-mode-line-position

The position in the mode-line `winum-mode' displays the number.

Default: 1

• winum-window-number-max 10

Max number of windows that can be numbered.

Default: 10

• winum-ignored-buffers

List of buffers to ignore when selecting window.

Default: '(" which-key")

• face: winum-face

Face used for the number in the mode-line.