vim

Fork of vim, an acceptable text editor
git clone git://git.laack.co/vim.git
Log | Files | Refs | README | LICENSE

vimtutor.1 (2114B)


      1 .TH VIMTUTOR 1 "2024 December 03"
      2 .SH NAME
      3 vimtutor \- the Vim tutor
      4 .SH SYNOPSIS
      5 .br
      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]
     11 .SH DESCRIPTION
     12 .B Vimtutor
     13 starts the
     14 .B Vim
     15 tutor.
     16 .PP
     17 The
     18 .B Vimtutor
     19 is useful for people that want to learn their first
     20 .B Vim
     21 commands.
     22 The optional [ISO639] argument is the two or three letter name of a language,
     23 like "it" or "es".
     24 .PP
     25 .B Vimtutor
     26 only opens temporary copies of the original tutor files, there is no danger
     27 of overwriting the lessons.
     28 .PP
     29 .B Vim
     30 is always started in
     31 .B Vi
     32 nocompatible 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
     78 .SH FILES
     79 .TP 15
     80 /usr/local/share/vim/vim??/tutor/tutor1[.language]
     81 The
     82 .B Vimtutor
     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).
     89 .TP 15
     90 /usr/local/share/vim/vim??/tutor/tutor.vim
     91 The
     92 .B Vim
     93 script used to copy the
     94 .B Vimtutor
     95 text file.
     96 .SH AUTHOR
     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: bware@mines.colorado.edu (now invalid).
    101 .PP
    102 Modified for
    103 .B Vim
    104 by Bram Moolenaar.
    105 .PP
    106 Translation contributors are listed in the tutor files.
    107 .SH SEE ALSO
    108 vim(1)