code.delx.au - gnu-emacs-elpa/blob - packages/rich-minority/README.org

   1 #+OPTIONS: tags:nil
   2 #+OPTIONS: toc:nil num:nil
   3
   4 * rich-minority-mode
   5
   6 Emacs package for hiding and/or highlighting the list of minor-modes
   7 in the mode-line.
   8
   9 ** Usage
  10
  11 To activate the enrichment of your minor-modes list, call =M-x rich-minority-mode=, or add this to your init file:
  12
  13 #+begin_src emacs-lisp
  14 (rich-minority-mode 1)
  15 #+end_src
  16
  17 By default, this has a couple of small effects (provided as examples)
  18 it is up to you to customize it to your liking with the following
  19 three variables:
  20
  21 - ~rm-blacklist~ :: List of minor mode names that will be hidden
  22      from the minor-modes list. Use this to hide *only* a few modes that
  23      are always active and don’t really contribute information.
  24 - ~rm-whitelist~ :: List of minor mode names that are allowed on
  25      the minor-modes list. Use this to hide *all but* a few modes.
  26 - ~rm-text-properties~ :: List text properties to apply to each
  27      minor-mode lighter. For instance, by default we highlight =Ovwrt=
  28      with a red face, so you always know if you’re in =overwrite-mode=.
  29
  30 ** Comparison to Diminish
  31 Diminish is an established player in the mode-line world, who also
  32 handles the minor-modes list. What can rich-minority /offer in contrast/?
  33
  34 - rich-minority is more versatile:
  35   1. It accepts *regexps*, instead of having to specify each minor-mode individually;
  36   2. It also offers a *whitelist* behaviour, in addition to the blacklist;
  37   3. It supports *highlighting* specific minor-modes with completely arbitrary text properties.
  38 - rich-minority takes a cleaner, functional approach. It doesn’t hack
  39   into the =minor-mode-alist= variable.
  40
  41 What is rich-minority /missing/?
  42
  43 It just doesn’t have a quick and simple replacement functionality yet.
  44 However, you can set the =display= property of a minor-mode to
  45 whatever string you want and that will function as a replacement.
  46
  47 ** Installation
  48
  49 This package is available from GNU Elpa and Melpa, you may install it
  50 by calling =M-x list-packages=.