| Bram Moolenaar | 71badf9 | 2023-04-22 22:40:14 +0100 | [diff] [blame] | 1 | VIMTUTOR(1) General Commands Manual VIMTUTOR(1) |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2 | |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3 | NAME |
| 4 | vimtutor - the Vim tutor |
| 5 | |
| 6 | SYNOPSIS |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 7 | vimtutor [-l | --language ISO639] [-c | --chapter NUMBER] [-g | --gui] |
| 8 | [ISO639] |
| 9 | vimtutor [-h | --help] |
| 10 | vimtutor [--list] |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 11 | |
| 12 | DESCRIPTION |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 13 | Vimtutor starts the Vim tutor. |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 14 | |
| Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 15 | The Vimtutor is useful for people that want to learn their first Vim |
| RestorerZ | 6fa304f | 2024-12-02 20:19:52 +0100 | [diff] [blame] | 16 | commands. The optional [ISO639] argument is the two or three letter |
| 17 | name of a language, like "it" or "es". |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 18 | |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 19 | Vimtutor only opens temporary copies of the original tutor files, there |
| 20 | is no danger of overwriting the lessons. |
| 21 | |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 22 | Vim is always started in Vi compatible mode. |
| 23 | |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 24 | OPTIONS |
| Christian Brabandt | 23eea9b | 2024-12-03 21:23:43 +0100 | [diff] [blame] | 25 | -l, --language ISO639 |
| 26 | Set the two or three letter language code. E.g. 'it', 'es', |
| 27 | 'bar'. Defaults to language of locale if available, else to |
| RestorerZ | 6fa304f | 2024-12-02 20:19:52 +0100 | [diff] [blame] | 28 | English. |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 29 | |
| Christian Brabandt | 23eea9b | 2024-12-03 21:23:43 +0100 | [diff] [blame] | 30 | -c, --chapter NUMBER |
| Christian Brabandt | 5ccac75 | 2024-11-04 21:02:42 +0100 | [diff] [blame] | 31 | Set the chapter number. Defaults to chapter one. |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 32 | |
| 33 | -g, --gui |
| 34 | Start vimtutor in the GUI version of vim if available, otherwise |
| 35 | fallback to console vim. |
| 36 | |
| 37 | -h, --help |
| 38 | Display usage information. |
| 39 | |
| 40 | --list Display chapters and languages. |
| 41 | |
| 42 | EXAMPLES |
| 43 | To start vimtutor in German on chapter one: |
| 44 | |
| 45 | vimtutor de |
| 46 | |
| 47 | In English on chapter two: |
| 48 | |
| 49 | vimtutor -c2 |
| 50 | |
| 51 | Longform command for Bavarian in the GUI on chapter one: |
| 52 | |
| 53 | vimtutor --language bar --chapter 1 --gui |
| 54 | |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 55 | FILES |
| RestorerZ | 6fa304f | 2024-12-02 20:19:52 +0100 | [diff] [blame] | 56 | /usr/local/share/vim/vim??/tutor/tutor1[.language] |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 57 | The Vimtutor chapter one text file(s). |
| 58 | |
| Christian Brabandt | 5ccac75 | 2024-11-04 21:02:42 +0100 | [diff] [blame] | 59 | /usr/local/share/vim/vim??/tutor/tutor2[.language] |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 60 | The Vimtutor chapter two text file(s). |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 61 | |
| RestorerZ | 81b62dd | 2024-08-15 21:39:33 +0200 | [diff] [blame] | 62 | /usr/local/share/vim/vim??/tutor/tutor.vim |
| Christian Brabandt | 5ccac75 | 2024-11-04 21:02:42 +0100 | [diff] [blame] | 63 | The Vim script used to copy the Vimtutor text file. |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 64 | |
| 65 | AUTHOR |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 66 | The Vi Tutorial was originally written for Vi by Michael C. Pierce and |
| 67 | Robert K. Ware, Colorado School of Mines using ideas supplied by |
| 68 | Charles Smith, Colorado State University. E-mail: bware@mines.col‐ |
| Christian Brabandt | 5ccac75 | 2024-11-04 21:02:42 +0100 | [diff] [blame] | 69 | orado.edu (now invalid). |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 70 | |
| 71 | Modified for Vim by Bram Moolenaar. |
| 72 | |
| 73 | Translation contributors are listed in the tutor files. |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 74 | |
| 75 | SEE ALSO |
| 76 | vim(1) |
| 77 | |
| Christian Brabandt | 23eea9b | 2024-12-03 21:23:43 +0100 | [diff] [blame] | 78 | 2024 December 03 VIMTUTOR(1) |