blob: a71bc02858484ddef159145cd4a438b2c87a00db [file] [log] [blame]
RestorerZ81b62dd2024-08-15 21:39:33 +02001.TH VIMTUTOR 1 "2024 August 12"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002.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
RestorerZ81b62dd2024-08-15 21:39:33 +020022GUI version of Vim is available, or falls back to vim if gvim is not found.
Bram Moolenaar2b570782008-05-07 15:40:33 +000023.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
RestorerZ81b62dd2024-08-15 21:39:33 +020035/usr/local/share/vim/vim??/tutor/tutor[.language]
Bram Moolenaar071d4272004-06-13 20:20:40 +000036The
37.B Vimtutor
38text file(s).
RestorerZ81b62dd2024-08-15 21:39:33 +020039.br
40.I vim??
41is short version number, like vim91 for
42.B Vim 9.1
Bram Moolenaar071d4272004-06-13 20:20:40 +000043.TP 15
RestorerZ81b62dd2024-08-15 21:39:33 +020044/usr/local/share/vim/vim??/tutor/tutor.vim
Bram Moolenaar071d4272004-06-13 20:20:40 +000045The Vim script used to copy the
46.B Vimtutor
47text file.
48.SH AUTHOR
49The
50.B Vimtutor
51was originally written for Vi by Michael C. Pierce and Robert K. Ware,
52Colorado School of Mines using ideas supplied by Charles Smith,
53Colorado State University.
Bram Moolenaar71badf92023-04-22 22:40:14 +010054E-mail: bware@mines.colorado.edu (now invalid).
Bram Moolenaar071d4272004-06-13 20:20:40 +000055.br
56It was modified for
57.B Vim
58by Bram Moolenaar.
59For the names of the translators see the tutor files.
60.SH SEE ALSO
61vim(1)