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.1 b/runtime/doc/vimtutor.1
index a71bc02..3d3f32b 100644
--- a/runtime/doc/vimtutor.1
+++ b/runtime/doc/vimtutor.1
@@ -1,16 +1,18 @@
-.TH VIMTUTOR 1 "2024 August 12"
+.TH VIMTUTOR 1 "2024 November 03"
.SH NAME
vimtutor \- the Vim tutor
.SH SYNOPSIS
.br
-.B vimtutor [\-g] [language]
+.B vimtutor [\-l | \-\-language ISO639] [\-c | \-\-chapter NUMBER] [\-g | \-\-gui] [ISO639]
+.br
+.B vimtutor [\-h | \-\-help]
+.br
+.B vimtutor [\-\-list]
.SH DESCRIPTION
.B Vimtutor
starts the
.B Vim
tutor.
-It copies the tutor file first, so that it can be modified without changing
-the original file.
.PP
The
.B Vimtutor
@@ -28,34 +30,91 @@
If a tutor in this language is available, it will be used.
Otherwise the English version will be used.
.PP
+.B Vimtutor
+only opens temporary copies of the original tutor files, there is no danger of overwriting the lessons.
+.PP
.B Vim
-is always started in Vi compatible mode.
+is always started in
+.B Vi
+compatible mode.
+.SH OPTIONS
+.TP
+.BR \-l ", " \-\-language =\fIISO639\fR
+Set the two or three letter language code. E.g. 'it', 'es', 'bar'. Defaults to language of locale if available, else to English.
+.TP
+.BR \-c ", " \-\-chapter =\fINUMBER\fR
+Set the one or two digit chapter number. Defaults to chapter one.
+.TP
+.BR \-g ", " \-\-gui
+Start
+.B vimtutor
+in the GUI version of vim if available, otherwise fallback to console vim.
+.TP
+.BR \-h ", " \-\-help
+Display usage information.
+.TP
+.BR \-\-list
+Display chapters and languages.
+.SH EXAMPLES
+To start
+.B vimtutor
+in German on chapter one:
+.PP
+.nf
+.RS
+vimtutor de
+.RE
+.fi
+.PP
+In English on chapter two:
+.PP
+.nf
+.RS
+vimtutor -c2
+.RE
+.fi
+.PP
+Longform command for Bavarian in the GUI on chapter one:
+.PP
+.nf
+.RS
+vimtutor --language bar --chapter 1 --gui
+.RE
+.fi
.SH FILES
.TP 15
/usr/local/share/vim/vim??/tutor/tutor[.language]
The
.B Vimtutor
-text file(s).
-.br
-.I vim??
-is short version number, like vim91 for
-.B Vim 9.1
+chapter one text file(s).
.TP 15
-/usr/local/share/vim/vim??/tutor/tutor.vim
-The Vim script used to copy the
-.B Vimtutor
-text file.
-.SH AUTHOR
+/usr/local/share/vim/vim??/tutor/tutor02[.language]
The
.B 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.colorado.edu (now invalid).
-.br
-It was modified for
+chapter two text file(s).
+.TP 15
+/usr/local/share/vim/vim??/tutor/tutor.vim
+The
+.B Vim
+script used to copy the
+.B Vimtutor
+chapter one text file.
+.TP 15
+/usr/local/share/vim/vim??/tutor/tutor02.vim
+The
+.B Vim
+script used to copy the
+.B Vimtutor
+chapter two text file.
+.SH AUTHOR
+.B 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.
+.B E-mail: bware@mines.colorado.edu.
+.PP
+Modified for
.B Vim
by Bram Moolenaar.
-For the names of the translators see the tutor files.
+.PP
+Translation contributors are listed in the tutor files.
.SH SEE ALSO
vim(1)