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