| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 1 | .TH VIMTUTOR 1 "2024 November 03" |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2 | .SH NAME |
| 3 | vimtutor \- the Vim tutor |
| 4 | .SH SYNOPSIS |
| 5 | .br |
| Paul Desmond Parker | 17c71da | 2024-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 Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 11 | .SH DESCRIPTION |
| 12 | .B Vimtutor |
| 13 | starts the |
| 14 | .B Vim |
| 15 | tutor. |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 16 | .PP |
| 17 | The |
| 18 | .B Vimtutor |
| 19 | is useful for people that want to learn their first |
| 20 | .B Vim |
| 21 | commands. |
| 22 | .PP |
| Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 23 | The optional argument \-g starts vimtutor with gvim rather than vim, if the |
| RestorerZ | 81b62dd | 2024-08-15 21:39:33 +0200 | [diff] [blame] | 24 | GUI version of Vim is available, or falls back to vim if gvim is not found. |
| Bram Moolenaar | 2b57078 | 2008-05-07 15:40:33 +0000 | [diff] [blame] | 25 | .PP |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 26 | The optional [language] argument is the two-letter name of a language, like |
| 27 | "it" or "es". |
| 28 | If the [language] argument is missing, the language of the current locale will |
| 29 | be used. |
| 30 | If a tutor in this language is available, it will be used. |
| 31 | Otherwise the English version will be used. |
| 32 | .PP |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 33 | .B Vimtutor |
| 34 | only opens temporary copies of the original tutor files, there is no danger of overwriting the lessons. |
| 35 | .PP |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 36 | .B Vim |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 37 | is always started in |
| 38 | .B Vi |
| 39 | compatible mode. |
| 40 | .SH OPTIONS |
| 41 | .TP |
| 42 | .BR \-l ", " \-\-language =\fIISO639\fR |
| 43 | Set the two or three letter language code. E.g. 'it', 'es', 'bar'. Defaults to language of locale if available, else to English. |
| 44 | .TP |
| 45 | .BR \-c ", " \-\-chapter =\fINUMBER\fR |
| 46 | Set the one or two digit chapter number. Defaults to chapter one. |
| 47 | .TP |
| 48 | .BR \-g ", " \-\-gui |
| 49 | Start |
| 50 | .B vimtutor |
| 51 | in the GUI version of vim if available, otherwise fallback to console vim. |
| 52 | .TP |
| 53 | .BR \-h ", " \-\-help |
| 54 | Display usage information. |
| 55 | .TP |
| 56 | .BR \-\-list |
| 57 | Display chapters and languages. |
| 58 | .SH EXAMPLES |
| 59 | To start |
| 60 | .B vimtutor |
| 61 | in German on chapter one: |
| 62 | .PP |
| 63 | .nf |
| 64 | .RS |
| 65 | vimtutor de |
| 66 | .RE |
| 67 | .fi |
| 68 | .PP |
| 69 | In English on chapter two: |
| 70 | .PP |
| 71 | .nf |
| 72 | .RS |
| 73 | vimtutor -c2 |
| 74 | .RE |
| 75 | .fi |
| 76 | .PP |
| 77 | Longform command for Bavarian in the GUI on chapter one: |
| 78 | .PP |
| 79 | .nf |
| 80 | .RS |
| 81 | vimtutor --language bar --chapter 1 --gui |
| 82 | .RE |
| 83 | .fi |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 84 | .SH FILES |
| 85 | .TP 15 |
| RestorerZ | 81b62dd | 2024-08-15 21:39:33 +0200 | [diff] [blame] | 86 | /usr/local/share/vim/vim??/tutor/tutor[.language] |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 87 | The |
| 88 | .B Vimtutor |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 89 | chapter one text file(s). |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 90 | .TP 15 |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 91 | /usr/local/share/vim/vim??/tutor/tutor02[.language] |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 92 | The |
| 93 | .B Vimtutor |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 94 | chapter two text file(s). |
| 95 | .TP 15 |
| 96 | /usr/local/share/vim/vim??/tutor/tutor.vim |
| 97 | The |
| 98 | .B Vim |
| 99 | script used to copy the |
| 100 | .B Vimtutor |
| 101 | chapter one text file. |
| 102 | .TP 15 |
| 103 | /usr/local/share/vim/vim??/tutor/tutor02.vim |
| 104 | The |
| 105 | .B Vim |
| 106 | script used to copy the |
| 107 | .B Vimtutor |
| 108 | chapter two text file. |
| 109 | .SH AUTHOR |
| 110 | .B The Vi Tutorial |
| 111 | was 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. |
| 112 | .B E-mail: bware@mines.colorado.edu. |
| 113 | .PP |
| 114 | Modified for |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 115 | .B Vim |
| 116 | by Bram Moolenaar. |
| Paul Desmond Parker | 17c71da | 2024-11-03 20:47:53 +0100 | [diff] [blame] | 117 | .PP |
| 118 | Translation contributors are listed in the tutor files. |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 119 | .SH SEE ALSO |
| 120 | vim(1) |