runtime(vimtutor): Add a second chapter
fixes: #5719
closes: #5729
Signed-off-by: Paul Desmond Parker <pauldesmondparker@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
diff --git a/runtime/doc/vimtutor.man b/runtime/doc/vimtutor.man
index f1e113e..459542e 100644
--- a/runtime/doc/vimtutor.man
+++ b/runtime/doc/vimtutor.man
@@ -1,16 +1,16 @@
VIMTUTOR(1) General Commands Manual VIMTUTOR(1)
-
-
NAME
vimtutor - the Vim tutor
SYNOPSIS
- vimtutor [-g] [language]
+ vimtutor [-l | --language ISO639] [-c | --chapter NUMBER] [-g | --gui]
+ [ISO639]
+ vimtutor [-h | --help]
+ vimtutor [--list]
DESCRIPTION
- Vimtutor starts the Vim tutor. It copies the tutor file first, so that
- it can be modified without changing the original file.
+ Vimtutor starts the Vim tutor.
The Vimtutor is useful for people that want to learn their first Vim
commands.
@@ -21,31 +21,73 @@
The optional [language] argument is the two-letter name of a language,
like "it" or "es". If the [language] argument is missing, the language
- of the current locale will be used. If a tutor in this language is
- available, it will be used. Otherwise the English version will be
+ of the current locale will be used. If a tutor in this language is
+ available, it will be used. Otherwise the English version will be
used.
+ Vimtutor only opens temporary copies of the original tutor files, there
+ is no danger of overwriting the lessons.
+
Vim is always started in Vi compatible mode.
+OPTIONS
+ -l, --language=ISO639
+ Set the two or three letter language code. E.g. 'it', 'es',
+ 'bar'. Defaults to language of locale if available, else to Eng‐
+ lish.
+
+ -c, --chapter=NUMBER
+ Set the one or two digit chapter number. Defaults to chapter
+ one.
+
+ -g, --gui
+ Start vimtutor in the GUI version of vim if available, otherwise
+ fallback to console vim.
+
+ -h, --help
+ Display usage information.
+
+ --list Display chapters and languages.
+
+EXAMPLES
+ To start vimtutor in German on chapter one:
+
+ vimtutor de
+
+ In English on chapter two:
+
+ vimtutor -c2
+
+ Longform command for Bavarian in the GUI on chapter one:
+
+ vimtutor --language bar --chapter 1 --gui
+
FILES
/usr/local/share/vim/vim??/tutor/tutor[.language]
- The Vimtutor text file(s).
- vim?? is short version number, like vim91 for Vim 9.1
+ The Vimtutor chapter one text file(s).
+
+ /usr/local/share/vim/vim??/tutor/tutor02[.language]
+ The Vimtutor chapter two text file(s).
/usr/local/share/vim/vim??/tutor/tutor.vim
- The Vim script used to copy the Vimtutor text file.
+ The Vim script used to copy the Vimtutor chapter one
+ text file.
+
+ /usr/local/share/vim/vim??/tutor/tutor02.vim
+ The Vim script used to copy the Vimtutor chapter two
+ text file.
AUTHOR
- The Vimtutor 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. E-mail: bware@mines.col‐
- orado.edu (now invalid).
- It was modified for Vim by Bram Moolenaar. For the names of the trans‐
- lators see the tutor files.
+ The Vi Tutorial 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. E-mail: bware@mines.col‐
+ orado.edu.
+
+ Modified for Vim by Bram Moolenaar.
+
+ Translation contributors are listed in the tutor files.
SEE ALSO
vim(1)
-
-
- 2024 August 12 VIMTUTOR(1)
+ 2024 November 03 VIMTUTOR(1)