code.delx.au - gnu-emacs-elpa/blob - README.md

   1 [![Build Status](https://travis-ci.org/abo-abo/swiper.svg?branch=master)](https://travis-ci.org/abo-abo/swiper) [![MELPA](https://melpa.org/packages/swiper-badge.svg)](https://melpa.org/#/swiper)
   2
   3 ## Swiper
   4
   5 Package for GNU Emacs that gives you an overview as you search for a regex
   6
   7 ![swiper.png](http://oremacs.com/download/swiper.png)
   8
   9 The package uses the `ivy` back end for the overview, see also
  10 [swiper-helm](https://github.com/abo-abo/swiper-helm).
  11
  12 ## Screenshots
  13
  14 ![ivy-swiper-1.png](http://oremacs.com/download/ivy-swiper-1.png)
  15
  16 There's also a ten minute [video demo](https://www.youtube.com/watch?v=VvnJQpTFVDc).
  17
  18 ## Ivy
  19
  20 Ivy is a generic completion method for Emacs, similar to
  21 `icomplete-mode`. It aims to be more efficient, more simple, and more
  22 pleasant to use than the alternatives. It's also highly customizable
  23 and very small.
  24
  25 To try it, just call <kbd>M-x</kbd> `ivy-mode`, and all generic
  26 completion, including file and buffer names, will be done with Ivy.
  27
  28 ## Installation
  29
  30 You can install the package from MELPA / GNU ELPA.
  31
  32 ## Documentation
  33
  34 ### Manual
  35 If you install from MELPA, you'll automatically get an `(ivy)` Info node.
  36
  37 The same information is also available in [HTML](http://oremacs.com/swiper/).  The source file for the Info page is [here](https://github.com/abo-abo/swiper/blob/master/doc/ivy.org).
  38
  39 ### Wiki
  40 Additionally, there's some information on [the wiki](https://github.com/abo-abo/swiper/wiki).
  41
  42 ### Small config example
  43 ```elisp
  44 (ivy-mode 1)
  45 (setq ivy-use-virtual-buffers t)
  46 (global-set-key "\C-s" 'swiper)
  47 (global-set-key (kbd "C-c C-r") 'ivy-resume)
  48 (global-set-key (kbd "<f6>") 'ivy-resume)
  49 (global-set-key (kbd "M-x") 'counsel-M-x)
  50 (global-set-key (kbd "C-x C-f") 'counsel-find-file)
  51 (global-set-key (kbd "<f1> f") 'counsel-describe-function)
  52 (global-set-key (kbd "<f1> v") 'counsel-describe-variable)
  53 (global-set-key (kbd "<f1> l") 'counsel-load-library)
  54 (global-set-key (kbd "<f2> i") 'counsel-info-lookup-symbol)
  55 (global-set-key (kbd "<f2> u") 'counsel-unicode-char)
  56 (global-set-key (kbd "C-c g") 'counsel-git)
  57 (global-set-key (kbd "C-c j") 'counsel-git-grep)
  58 (global-set-key (kbd "C-c k") 'counsel-ag)
  59 (global-set-key (kbd "C-x l") 'counsel-locate)
  60 (global-set-key (kbd "C-S-o") 'counsel-rhythmbox)
  61 ```