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