Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_vim / 12e1729e893269758b15a4491b20de105120edfd / . / runtime / doc / vimtutor.1
blob: 87f09785ff9f9c5d0565e883057982b73ad489bb [file] [log] [blame]
Christian Brabandt5ccac752024-11-04 21:02:42 +0100[diff] [blame]1.TH VIMTUTOR 1 "2024 November 04"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]2.SH NAME
3vimtutor \- the Vim tutor
4.SH SYNOPSIS
5.br
Paul Desmond Parker17c71da2024-11-03 20:47:53 +0100[diff] [blame]6.B vimtutor [\-l | \-\-language ISO639] [\-c | \-\-chapter NUMBER] [\-g | \-\-gui] [ISO639]
7.br
8.B vimtutor [\-h | \-\-help]
9.br
10.B vimtutor [\-\-list]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]11.SH DESCRIPTION
12.B Vimtutor
13starts the
14.B Vim
15tutor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]16.PP
17The
18.B Vimtutor
19is useful for people that want to learn their first
20.B Vim
21commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]22The optional [language] argument is the two-letter name of a language, like
23"it" or "es".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]24.PP
Paul Desmond Parker17c71da2024-11-03 20:47:53 +0100[diff] [blame]25.B Vimtutor
26only opens temporary copies of the original tutor files, there is no danger of overwriting the lessons.
27.PP
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]28.B Vim
Paul Desmond Parker17c71da2024-11-03 20:47:53 +0100[diff] [blame]29is always started in
30.B Vi
31compatible mode.
32.SH OPTIONS
33.TP
34.BR \-l ", " \-\-language =\fIISO639\fR
35Set the two or three letter language code. E.g. 'it', 'es', 'bar'. Defaults to language of locale if available, else to English.
36.TP
37.BR \-c ", " \-\-chapter =\fINUMBER\fR
Christian Brabandt5ccac752024-11-04 21:02:42 +0100[diff] [blame]38Set the chapter number. Defaults to chapter one.
Paul Desmond Parker17c71da2024-11-03 20:47:53 +0100[diff] [blame]39.TP
40.BR \-g ", " \-\-gui
41Start
42.B vimtutor
43in the GUI version of vim if available, otherwise fallback to console vim.
44.TP
45.BR \-h ", " \-\-help
46Display usage information.
47.TP
48.BR \-\-list
49Display chapters and languages.
50.SH EXAMPLES
51To start
52.B vimtutor
53in German on chapter one:
54.PP
55.nf
56.RS
57vimtutor de
58.RE
59.fi
60.PP
61In English on chapter two:
62.PP
63.nf
64.RS
65vimtutor -c2
66.RE
67.fi
68.PP
69Longform command for Bavarian in the GUI on chapter one:
70.PP
71.nf
72.RS
73vimtutor --language bar --chapter 1 --gui
74.RE
75.fi
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]76.SH FILES
77.TP 15
RestorerZ81b62dd2024-08-15 21:39:33 +0200[diff] [blame]78/usr/local/share/vim/vim??/tutor/tutor[.language]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]79The
80.B Vimtutor
Paul Desmond Parker17c71da2024-11-03 20:47:53 +0100[diff] [blame]81chapter one text file(s).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]82.TP 15
Christian Brabandt5ccac752024-11-04 21:02:42 +0100[diff] [blame]83/usr/local/share/vim/vim??/tutor/tutor2[.language]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]84The
85.B Vimtutor
Paul Desmond Parker17c71da2024-11-03 20:47:53 +0100[diff] [blame]86chapter two text file(s).
87.TP 15
88/usr/local/share/vim/vim??/tutor/tutor.vim
89The
90.B Vim
91script used to copy the
92.B Vimtutor
Christian Brabandt5ccac752024-11-04 21:02:42 +0100[diff] [blame]93text file.
Paul Desmond Parker17c71da2024-11-03 20:47:53 +0100[diff] [blame]94.SH AUTHOR
95.B The Vi Tutorial
96was originally written for Vi by Michael C. Pierce and Robert K. Ware, Colorado School of Mines using ideas supplied by Charles Smith, Colorado State University.
Christian Brabandt5ccac752024-11-04 21:02:42 +0100[diff] [blame]97.B E-mail: bware@mines.colorado.edu (now invalid).
Paul Desmond Parker17c71da2024-11-03 20:47:53 +0100[diff] [blame]98.PP
99Modified for
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]100.B Vim
101by Bram Moolenaar.
Paul Desmond Parker17c71da2024-11-03 20:47:53 +0100[diff] [blame]102.PP
103Translation contributors are listed in the tutor files.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]104.SH SEE ALSO
105vim(1)