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 shows an overview during regex searching.
   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 mechanism for Emacs. While it operates
  21 similarly to other completion schemes such as `icomplete-mode`, Ivy
  22 aims to be more efficient, smaller, simpler, and smoother to use yet
  23 highly customizable.
  24
  25 To try Ivy, just call <kbd>M-x</kbd> `ivy-mode`. This will enable
  26 generic Ivy completion, including specific completion for file and
  27 buffer names.
  28
  29 ## Installation
  30
  31 Install the `swiper` package from MELPA / GNU ELPA.
  32
  33 ## Documentation
  34
  35 ### Manual
  36 The manual is available as [HTML](http://oremacs.com/swiper/).
  37
  38 After installing from MELPA, the manual is also available through the `(ivy)` Info node.
  39
  40 The source file for the Info page is
  41 [here](https://github.com/abo-abo/swiper/blob/master/doc/ivy.org).
  42
  43 ### Wiki
  44 Ivy and Swiper wiki is here: [the wiki](https://github.com/abo-abo/swiper/wiki).
  45
  46 ### Small config example
  47 ```elisp
  48 (ivy-mode 1)
  49 (setq ivy-use-virtual-buffers t)
  50 (global-set-key "\C-s" 'swiper)
  51 (global-set-key (kbd "C-c C-r") 'ivy-resume)
  52 (global-set-key (kbd "<f6>") 'ivy-resume)
  53 (global-set-key (kbd "M-x") 'counsel-M-x)
  54 (global-set-key (kbd "C-x C-f") 'counsel-find-file)
  55 (global-set-key (kbd "<f1> f") 'counsel-describe-function)
  56 (global-set-key (kbd "<f1> v") 'counsel-describe-variable)
  57 (global-set-key (kbd "<f1> l") 'counsel-load-library)
  58 (global-set-key (kbd "<f2> i") 'counsel-info-lookup-symbol)
  59 (global-set-key (kbd "<f2> u") 'counsel-unicode-char)
  60 (global-set-key (kbd "C-c g") 'counsel-git)
  61 (global-set-key (kbd "C-c j") 'counsel-git-grep)
  62 (global-set-key (kbd "C-c k") 'counsel-ag)
  63 (global-set-key (kbd "C-x l") 'counsel-locate)
  64 (global-set-key (kbd "C-S-o") 'counsel-rhythmbox)
  65 ```