blob: 44cb9daccf6787fafa2c83b63b6d98ce8806a7c8 [file] [log] [blame]
Bram Moolenaar71badf92023-04-22 22:40:14 +01001VIMTUTOR(1) General Commands Manual VIMTUTOR(1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
RestorerZ6fa304f2024-12-02 20:19:52 +01003
4
Bram Moolenaar071d4272004-06-13 20:20:40 +00005NAME
6 vimtutor - the Vim tutor
7
8SYNOPSIS
Paul Desmond Parker17c71da2024-11-03 20:47:53 +01009 vimtutor [-l | --language ISO639] [-c | --chapter NUMBER] [-g | --gui]
10 [ISO639]
11 vimtutor [-h | --help]
12 vimtutor [--list]
Bram Moolenaar071d4272004-06-13 20:20:40 +000013
14DESCRIPTION
Paul Desmond Parker17c71da2024-11-03 20:47:53 +010015 Vimtutor starts the Vim tutor.
Bram Moolenaar071d4272004-06-13 20:20:40 +000016
Bram Moolenaar8299df92004-07-10 09:47:34 +000017 The Vimtutor is useful for people that want to learn their first Vim
RestorerZ6fa304f2024-12-02 20:19:52 +010018 commands. The optional [ISO639] argument is the two or three letter
19 name of a language, like "it" or "es".
Bram Moolenaar071d4272004-06-13 20:20:40 +000020
Paul Desmond Parker17c71da2024-11-03 20:47:53 +010021 Vimtutor only opens temporary copies of the original tutor files, there
22 is no danger of overwriting the lessons.
23
Bram Moolenaar071d4272004-06-13 20:20:40 +000024 Vim is always started in Vi compatible mode.
25
Paul Desmond Parker17c71da2024-11-03 20:47:53 +010026OPTIONS
27 -l, --language=ISO639
Christian Brabandt5ccac752024-11-04 21:02:42 +010028 Set the two or three letter language code. E.g. 'it', 'es',
RestorerZ6fa304f2024-12-02 20:19:52 +010029 'bar'. Defaults to language of locale if available, else to
30 English.
Paul Desmond Parker17c71da2024-11-03 20:47:53 +010031
32 -c, --chapter=NUMBER
Christian Brabandt5ccac752024-11-04 21:02:42 +010033 Set the chapter number. Defaults to chapter one.
Paul Desmond Parker17c71da2024-11-03 20:47:53 +010034
35 -g, --gui
36 Start vimtutor in the GUI version of vim if available, otherwise
37 fallback to console vim.
38
39 -h, --help
40 Display usage information.
41
42 --list Display chapters and languages.
43
44EXAMPLES
45 To start vimtutor in German on chapter one:
46
47 vimtutor de
48
49 In English on chapter two:
50
51 vimtutor -c2
52
53 Longform command for Bavarian in the GUI on chapter one:
54
55 vimtutor --language bar --chapter 1 --gui
56
Bram Moolenaar071d4272004-06-13 20:20:40 +000057FILES
RestorerZ6fa304f2024-12-02 20:19:52 +010058 /usr/local/share/vim/vim??/tutor/tutor1[.language]
Paul Desmond Parker17c71da2024-11-03 20:47:53 +010059 The Vimtutor chapter one text file(s).
60
Christian Brabandt5ccac752024-11-04 21:02:42 +010061 /usr/local/share/vim/vim??/tutor/tutor2[.language]
Paul Desmond Parker17c71da2024-11-03 20:47:53 +010062 The Vimtutor chapter two text file(s).
Bram Moolenaar071d4272004-06-13 20:20:40 +000063
RestorerZ81b62dd2024-08-15 21:39:33 +020064 /usr/local/share/vim/vim??/tutor/tutor.vim
Christian Brabandt5ccac752024-11-04 21:02:42 +010065 The Vim script used to copy the Vimtutor text file.
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67AUTHOR
Paul Desmond Parker17c71da2024-11-03 20:47:53 +010068 The Vi Tutorial was originally written for Vi by Michael C. Pierce and
69 Robert K. Ware, Colorado School of Mines using ideas supplied by
70 Charles Smith, Colorado State University. E-mail: bware@mines.col
Christian Brabandt5ccac752024-11-04 21:02:42 +010071 orado.edu (now invalid).
Paul Desmond Parker17c71da2024-11-03 20:47:53 +010072
73 Modified for Vim by Bram Moolenaar.
74
75 Translation contributors are listed in the tutor files.
Bram Moolenaar071d4272004-06-13 20:20:40 +000076
77SEE ALSO
78 vim(1)
79
RestorerZ6fa304f2024-12-02 20:19:52 +010080
81
Christian Brabandt5ccac752024-11-04 21:02:42 +010082 2024 November 04 VIMTUTOR(1)