#lang scribble/doc

@begin[(require scribble/manual)
       (require scribble/eval)
       (require scribble/basic)]

@title[#:tag "top"]{@bold{Vi mode}: Vi mode for Drscheme}

by Jon Rafkind (@tt{rafkind at cs dot utah dot edu})

This package provides a mode for Drscheme that emulates some Vi commands. This package is in beta mode, it doesn't have a lot of features and probably has some bugs. Feedback and bug reports is more than welcome!

@table-of-contents[]

@section[#:tag "install"]{Install}

Execute the following line in Drscheme or Mzscheme
@scheme{(require (planet "tool.ss" ("kazzmir" "vi.plt")))}

Then restart Drscheme.

@section[#:tag "use"]{Usage}

Vi mode provides the usual vi environment. You start in escape mode and move to other modes by pressing the responsibly key. The following (non-exhaustive) list of features are supported.

@itemize[
  @item{Movement keys - h, j, k, l, ^, $}
  @item{Cut - x}
  @item{Insert - i}
  @item{Paste - p}
  @item{Copy - y}
  @item{Visual mode - v}
  @item{Repeat - <number> then a command}
  @item{: ... - ed mode}
]

Press `esc' to go back to escape mode at any time. Click the "Vi mode" button on the toolbar to disable/enable Vi mode.