runtime/doc/vimtutor.1

   1 .TH VIMTUTOR 1 "2001 April 2"
   2 .SH NAME
   3 vimtutor \- the Vim tutor
   4 .SH SYNOPSIS
   5 .br
   6 .B vimtutor [-g] [language]
   7 .SH DESCRIPTION
   8 .B Vimtutor
   9 starts the
  10 .B Vim
  11 tutor.
  12 It copies the tutor file first, so that it can be modified without changing
  13 the original file.
  14 .PP
  15 The
  16 .B Vimtutor
  17 is useful for people that want to learn their first
  18 .B Vim
  19 commands.
  20 .PP
  21 The optional argument -g starts vimtutor with gvim rather than vim, if the
  22 GUI version of vim is available, or falls back to Vim if gvim is not found.
  23 .PP
  24 The optional [language] argument is the two-letter name of a language, like
  25 "it" or "es".
  26 If the [language] argument is missing, the language of the current locale will
  27 be used.
  28 If a tutor in this language is available, it will be used.
  29 Otherwise the English version will be used.
  30 .PP
  31 .B Vim
  32 is always started in Vi compatible mode.
  33 .SH FILES
  34 .TP 15
  35 /usr/local/lib/vim/tutor/tutor[.language]
  36 The
  37 .B Vimtutor
  38 text file(s).
  39 .TP 15
  40 /usr/local/lib/vim/tutor/tutor.vim
  41 The Vim script used to copy the
  42 .B Vimtutor
  43 text file.
  44 .SH AUTHOR
  45 The
  46 .B Vimtutor
  47 was originally written for Vi by Michael C. Pierce and Robert K. Ware,
  48 Colorado School of Mines using ideas supplied by Charles Smith,
  49 Colorado State University.
  50 E-mail: bware@mines.colorado.edu.
  51 .br
  52 It was modified for
  53 .B Vim
  54 by Bram Moolenaar.
  55 For the names of the translators see the tutor files.
  56 .SH SEE ALSO
  57 vim(1)