|
1 | | -.TH VIMTUTOR 1 "2024 August 12" |
| 1 | +.TH VIMTUTOR 1 "2024 December 03" |
2 | 2 | .SH NAME |
3 | 3 | vimtutor \- the Vim tutor |
4 | 4 | .SH SYNOPSIS |
5 | 5 | .br |
6 | | -.B vimtutor [\-g] [language] |
| 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] |
7 | 11 | .SH DESCRIPTION |
8 | 12 | .B Vimtutor |
9 | 13 | starts the |
10 | 14 | .B Vim |
11 | 15 | tutor. |
12 | | -It copies the tutor file first, so that it can be modified without changing |
13 | | -the original file. |
14 | 16 | .PP |
15 | 17 | The |
16 | 18 | .B Vimtutor |
17 | 19 | is useful for people that want to learn their first |
18 | 20 | .B Vim |
19 | 21 | commands. |
| 22 | +The optional [ISO639] argument is the two or three letter name of a language, |
| 23 | +like "it" or "es". |
20 | 24 | .PP |
21 | | -The optional argument \-g starts vimtutor with gvim rather than vim, if the |
22 | | -GUI version of Vim is available, or falls back to vim if gvim is not found. |
23 | | -.PP |
24 | | -The optional [language] argument is the two-letter name of a language, like |
25 | | -"it" or "es". |
26 | | -If the [language] argument is missing, the language of the current locale will |
27 | | -be used. |
28 | | -If a tutor in this language is available, it will be used. |
29 | | -Otherwise the English version will be used. |
| 25 | +.B Vimtutor |
| 26 | +only opens temporary copies of the original tutor files, there is no danger |
| 27 | +of overwriting the lessons. |
30 | 28 | .PP |
31 | 29 | .B Vim |
32 | | -is always started in Vi compatible mode. |
| 30 | +is always started in |
| 31 | +.B Vi |
| 32 | +compatible mode. |
| 33 | +.SH OPTIONS |
| 34 | +.TP |
| 35 | +.BR \-l ", " \-\-language\ \fIISO639\fR |
| 36 | +Set the two or three letter language code. E.g. 'it', 'es', 'bar'. |
| 37 | +Defaults to language of locale if available, else to English. |
| 38 | +.TP |
| 39 | +.BR \-c ", " \-\-chapter\ \fINUMBER\fR |
| 40 | +Set the chapter number. Defaults to chapter one. |
| 41 | +.TP |
| 42 | +.BR \-g ", " \-\-gui |
| 43 | +Start |
| 44 | +.B vimtutor |
| 45 | +in the GUI version of vim if available, otherwise fallback to console vim. |
| 46 | +.TP |
| 47 | +.BR \-h ", " \-\-help |
| 48 | +Display usage information. |
| 49 | +.TP |
| 50 | +.BR \-\-list |
| 51 | +Display chapters and languages. |
| 52 | +.SH EXAMPLES |
| 53 | +To start |
| 54 | +.B vimtutor |
| 55 | +in German on chapter one: |
| 56 | +.PP |
| 57 | +.nf |
| 58 | +.RS |
| 59 | +vimtutor de |
| 60 | +.RE |
| 61 | +.fi |
| 62 | +.PP |
| 63 | +In English on chapter two: |
| 64 | +.PP |
| 65 | +.nf |
| 66 | +.RS |
| 67 | +vimtutor -c2 |
| 68 | +.RE |
| 69 | +.fi |
| 70 | +.PP |
| 71 | +Longform command for Bavarian in the GUI on chapter one: |
| 72 | +.PP |
| 73 | +.nf |
| 74 | +.RS |
| 75 | +vimtutor --language bar --chapter 1 --gui |
| 76 | +.RE |
| 77 | +.fi |
33 | 78 | .SH FILES |
34 | 79 | .TP 15 |
35 | | -/usr/local/share/vim/vim??/tutor/tutor[.language] |
| 80 | +/usr/local/share/vim/vim??/tutor/tutor1[.language] |
36 | 81 | The |
37 | 82 | .B Vimtutor |
38 | | -text file(s). |
39 | | -.br |
40 | | -.I vim?? |
41 | | -is short version number, like vim91 for |
42 | | -.B Vim 9.1 |
| 83 | +chapter one text file(s). |
| 84 | +.TP 15 |
| 85 | +/usr/local/share/vim/vim??/tutor/tutor2[.language] |
| 86 | +The |
| 87 | +.B Vimtutor |
| 88 | +chapter two text file(s). |
43 | 89 | .TP 15 |
44 | 90 | /usr/local/share/vim/vim??/tutor/tutor.vim |
45 | | -The Vim script used to copy the |
| 91 | +The |
| 92 | +.B Vim |
| 93 | +script used to copy the |
46 | 94 | .B Vimtutor |
47 | 95 | text file. |
48 | 96 | .SH AUTHOR |
49 | | -The |
50 | | -.B Vimtutor |
51 | | -was originally written for Vi by Michael C. Pierce and Robert K. Ware, |
52 | | -Colorado School of Mines using ideas supplied by Charles Smith, |
53 | | -Colorado State University. |
54 | | -E-mail: [email protected] (now invalid). |
55 | | -.br |
56 | | -It was modified for |
| 97 | +.B The Vi Tutorial |
| 98 | +was originally written for Vi by Michael C. Pierce and Robert K. Ware, Colorado |
| 99 | +School of Mines using ideas supplied by Charles Smith, Colorado State University. |
| 100 | +. B E-mail: [email protected] (now invalid). |
| 101 | +.PP |
| 102 | +Modified for |
57 | 103 | .B Vim |
58 | 104 | by Bram Moolenaar. |
59 | | -For the names of the translators see the tutor files. |
| 105 | +.PP |
| 106 | +Translation contributors are listed in the tutor files. |
60 | 107 | .SH SEE ALSO |
61 | 108 | vim(1) |
0 commit comments