annotate runtime/doc/vim.1 @ 100:1f3902f3eb5c v7.0038

updated for version 7.0038
author vimboss
date Fri, 14 Jan 2005 21:53:12 +0000
parents f6033dcbaf31
children 8c60f65311fa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1 .TH VIM 1 "2002 Feb 22"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2 .SH NAME
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3 vim \- Vi IMproved, a programmers text editor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 .SH SYNOPSIS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6 .B vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 [options] [file ..]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 .B vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 [options] -
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12 .B vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 [options] \-t tag
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 .B vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 [options] \-q [errorfile]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 .B ex
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 .B view
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 .B gvim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 .B gview
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 .B evim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 .B eview
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 .B rvim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 .B rview
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 .B rgvim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 .B rgview
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 .SH DESCRIPTION
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 is a text editor that is upwards compatible to Vi.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 It can be used to edit all kinds of plain text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 It is especially useful for editing programs.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 There are a lot of enhancements above Vi: multi level undo,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 multi windows and buffers, syntax highlighting, command line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 editing, filename completion, on-line help, visual selection, etc..
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 See ":help vi_diff.txt" for a summary of the differences between
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 and Vi.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45 While running
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 a lot of help can be obtained from the on-line help system, with the ":help"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 See the ON-LINE HELP section below.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 Most often
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 is started to edit a single file with the command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 vim file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 More generally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 is started with:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 vim [options] [filelist]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 If the filelist is missing, the editor will start with an empty buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 Otherwise exactly one out of the following four may be used to choose one or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 more files to be edited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 .TP 12
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 file ..
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 A list of filenames.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 The first one will be the current file and read into the buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 The cursor will be positioned on the first line of the buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 You can get to the other files with the ":next" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 To edit a file that starts with a dash, precede the filelist with "--".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 -
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 The file to edit is read from stdin. Commands are read from stderr, which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 should be a tty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 -t {tag}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 The file to edit and the initial cursor position depends on a "tag", a sort
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 of goto label.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 {tag} is looked up in the tags file, the associated file becomes the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 file and the associated command is executed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 Mostly this is used for C programs, in which case {tag} could be a function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 The effect is that the file containing that function becomes the current file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 and the cursor is positioned on the start of the function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 See ":help tag-commands".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 -q [errorfile]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 Start in quickFix mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 The file [errorfile] is read and the first error is displayed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 If [errorfile] is omitted, the filename is obtained from the 'errorfile'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 option (defaults to "AztecC.Err" for the Amiga, "errors.err" on other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94 systems).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 Further errors can be jumped to with the ":cn" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 See ":help quickfix".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99 behaves differently, depending on the name of the command (the executable may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 still be the same file).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101 .TP 10
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 The "normal" way, everything is default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105 ex
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 Start in Ex mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 Go to Normal mode with the ":vi" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 Can also be done with the "-e" argument.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 view
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 Start in read-only mode. You will be protected from writing the files. Can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 also be done with the "-R" argument.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 gvim gview
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 The GUI version.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116 Starts a new window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117 Can also be done with the "-g" argument.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 evim eview
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120 The GUI version in easy mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
121 Starts a new window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122 Can also be done with the "-y" argument.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
123 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
124 rvim rview rgvim rgview
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
125 Like the above, but with restrictions. It will not be possible to start shell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126 commands, or suspend
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127 .B Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 Can also be done with the "-Z" argument.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129 .SH OPTIONS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
130 The options may be given in any order, before or after filenames.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
131 Options without an argument can be combined after a single dash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132 .TP 12
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133 +[num]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134 For the first file the cursor will be positioned on line "num".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135 If "num" is missing, the cursor will be positioned on the last line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137 +/{pat}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
138 For the first file the cursor will be positioned on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139 first occurrence of {pat}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140 See ":help search-pattern" for the available search patterns.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
141 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
142 +{command}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144 -c {command}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145 {command} will be executed after the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 first file has been read.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147 {command} is interpreted as an Ex command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 If the {command} contains spaces it must be enclosed in double quotes (this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
149 depends on the shell that is used).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150 Example: Vim "+set si" main.c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 Note: You can use up to 10 "+" or "-c" commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154 -S {file}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155 {file} will be sourced after the first file has been read.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156 This is equivalent to -c "source {file}".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
157 {file} cannot start with '-'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
158 If {file} is omitted "Session.vim" is used (only works when -S is the last
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
159 argument).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
160 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
161 --cmd {command}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
162 Like using "-c", but the command is executed just before
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
163 processing any vimrc file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
164 You can use up to 10 of these commands, independently from "-c" commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
165 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
166 -A
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
167 If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
168 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
169 has been compiled with ARABIC support for editing right-to-left
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
170 oriented files and Arabic keyboard mapping, this option starts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
171 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
172 in Arabic mode, i.e. 'arabic' is set. Otherwise an error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
173 message is given and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
174 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
175 aborts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
176 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
177 -b
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
178 Binary mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
179 A few options will be set that makes it possible to edit a binary or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
180 executable file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182 -C
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183 Compatible. Set the 'compatible' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
184 This will make
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
185 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
186 behave mostly like Vi, even though a .vimrc file exists.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
187 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
188 -d
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
189 Start in diff mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
190 There should be two or three file name arguments.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
191 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
192 will open all the files and show differences between them.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
193 Works like vimdiff(1).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
194 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
195 -d {device}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
196 Open {device} for use as a terminal.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
197 Only on the Amiga.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
198 Example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
199 "\-d con:20/30/600/150".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
200 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
201 -D
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
202 Debugging. Go to debugging mode when executing the first command from a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
203 script.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
204 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
205 -e
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
206 Start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
207 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
208 in Ex mode, just like the executable was called "ex".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
209 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
210 -E
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
211 Start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
212 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
213 in improved Ex mode, just like the executable was called "exim".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
214 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
215 -f
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
216 Foreground. For the GUI version,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
217 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
218 will not fork and detach from the shell it was started in.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
219 On the Amiga,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
220 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
221 is not restarted to open a new window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
222 This option should be used when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
223 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
224 is executed by a program that will wait for the edit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
225 session to finish (e.g. mail).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
226 On the Amiga the ":sh" and ":!" commands will not work.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
227 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
228 --nofork
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
229 Foreground. For the GUI version,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
230 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
231 will not fork and detach from the shell it was started in.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
232 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
233 -F
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
234 If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
235 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
236 has been compiled with FKMAP support for editing right-to-left
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
237 oriented files and Farsi keyboard mapping, this option starts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
238 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
239 in Farsi mode, i.e. 'fkmap' and 'rightleft' are set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
240 Otherwise an error message is given and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
241 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
242 aborts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
243 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
244 -g
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
245 If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
246 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
247 has been compiled with GUI support, this option enables the GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
248 If no GUI support was compiled in, an error message is given and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
249 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
250 aborts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
251 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
252 -h
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
253 Give a bit of help about the command line arguments and options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
254 After this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
255 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
256 exits.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
257 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
258 -H
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
259 If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
260 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
261 has been compiled with RIGHTLEFT support for editing right-to-left
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
262 oriented files and Hebrew keyboard mapping, this option starts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
263 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
264 in Hebrew mode, i.e. 'hkmap' and 'rightleft' are set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
265 Otherwise an error message is given and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
266 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
267 aborts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
268 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
269 -i {viminfo}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
270 When using the viminfo file is enabled, this option sets the filename to use,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
271 instead of the default "~/.viminfo".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
272 This can also be used to skip the use of the .viminfo file, by giving the name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
273 "NONE".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
274 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
275 -L
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
276 Same as -r.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
277 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
278 -l
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
279 Lisp mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
280 Sets the 'lisp' and 'showmatch' options on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
281 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
282 -m
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
283 Modifying files is disabled.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
284 Resets the 'write' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
285 You can still modify the buffer, but writing a file is not possible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
286 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
287 -M
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
288 Modifications not allowed. The 'modifiable' and 'write' options will be unset,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
289 so that changes are not allowed and files can not be written. Note that these
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
290 options can be set to enable making modifications.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
291 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
292 -N
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
293 No-compatible mode. Reset the 'compatible' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
294 This will make
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
295 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
296 behave a bit better, but less Vi compatible, even though a .vimrc file does
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
297 not exist.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
298 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
299 -n
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
300 No swap file will be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
301 Recovery after a crash will be impossible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
302 Handy if you want to edit a file on a very slow medium (e.g. floppy).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
303 Can also be done with ":set uc=0".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
304 Can be undone with ":set uc=200".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
305 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
306 -nb
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
307 Become an editor server for NetBeans. See the docs for details.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
308 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
309 -o[N]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
310 Open N windows stacked.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
311 When N is omitted, open one window for each file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
312 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
313 -O[N]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
314 Open N windows side by side.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
315 When N is omitted, open one window for each file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
316 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
317 -R
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
318 Read-only mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
319 The 'readonly' option will be set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
320 You can still edit the buffer, but will be prevented from accidently
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
321 overwriting a file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
322 If you do want to overwrite a file, add an exclamation mark to the Ex command,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
323 as in ":w!".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
324 The -R option also implies the -n option (see below).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
325 The 'readonly' option can be reset with ":set noro".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
326 See ":help 'readonly'".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
327 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
328 -r
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
329 List swap files, with information about using them for recovery.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
330 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
331 -r {file}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
332 Recovery mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
333 The swap file is used to recover a crashed editing session.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
334 The swap file is a file with the same filename as the text file with ".swp"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
335 appended.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
336 See ":help recovery".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
337 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
338 -s
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
339 Silent mode. Only when started as "Ex" or when the "-e" option was given
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
340 before the "-s" option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
341 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
342 -s {scriptin}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
343 The script file {scriptin} is read.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
344 The characters in the file are interpreted as if you had typed them.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
345 The same can be done with the command ":source! {scriptin}".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
346 If the end of the file is reached before the editor exits, further characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
347 are read from the keyboard.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
348 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
349 -T {terminal}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
350 Tells
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
351 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
352 the name of the terminal you are using.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
353 Only required when the automatic way doesn't work.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
354 Should be a terminal known
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
355 to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
356 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
357 (builtin) or defined in the termcap or terminfo file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
358 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
359 -u {vimrc}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
360 Use the commands in the file {vimrc} for initializations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
361 All the other initializations are skipped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
362 Use this to edit a special kind of files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
363 It can also be used to skip all initializations by giving the name "NONE".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
364 See ":help initialization" within vim for more details.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
365 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
366 -U {gvimrc}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
367 Use the commands in the file {gvimrc} for GUI initializations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
368 All the other GUI initializations are skipped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
369 It can also be used to skip all GUI initializations by giving the name "NONE".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
370 See ":help gui-init" within vim for more details.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
371 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
372 -V[N]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
373 Verbose. Give messages about which files are sourced and for reading and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
374 writing a viminfo file. The optional number N is the value for 'verbose'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
375 Default is 10.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
376 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
377 -v
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
378 Start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
379 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
380 in Vi mode, just like the executable was called "vi". This only has effect
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
381 when the executable is called "ex".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
382 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
383 -w {scriptout}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
384 All the characters that you type are recorded in the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
385 {scriptout}, until you exit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
386 .B Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
387 This is useful if you want to create a script file to be used with "vim -s" or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
388 ":source!".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
389 If the {scriptout} file exists, characters are appended.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
390 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
391 -W {scriptout}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
392 Like -w, but an existing file is overwritten.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
393 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
394 -x
33
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 7
diff changeset
395 Use encryption when writing files. Will prompt for a crypt key.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
396 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
397 -X
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
398 Don't connect to the X server. Shortens startup time in a terminal, but the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
399 window title and clipboard will not be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
400 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
401 -y
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
402 Start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
403 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
404 in easy mode, just like the executable was called "evim" or "eview".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
405 Makes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
406 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
407 behave like a click-and-type editor.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
408 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
409 -Z
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
410 Restricted mode. Works like the executable starts with "r".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
411 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
412 --
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
413 Denotes the end of the options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
414 Arguments after this will be handled as a file name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
415 This can be used to edit a filename that starts with a '-'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
416 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
417 --echo-wid
33
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 7
diff changeset
418 GTK GUI only: Echo the Window ID on stdout.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
419 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
420 --help
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
421 Give a help message and exit, just like "-h".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
422 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
423 --literal
33
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 7
diff changeset
424 Take file name arguments literally, do not expand wildcards. This has no
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 7
diff changeset
425 effect on Unix where the shell expands wildcards.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
426 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
427 --noplugin
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
428 Skip loading plugins. Implied by -u NONE.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
429 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
430 --remote
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
431 Connect to a Vim server and make it edit the files given in the rest of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
432 arguments. If no server is found a warning is given and the files are edited
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
433 in the current Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
434 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
435 --remote-expr {expr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
436 Connect to a Vim server, evaluate {expr} in it and print the result on stdout.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
437 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
438 --remote-send {keys}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
439 Connect to a Vim server and send {keys} to it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
440 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
441 --remote-silent
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
442 As --remote, but without the warning when no server is found.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
443 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
444 --remote-wait
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
445 As --remote, but Vim does not exit until the files have been edited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
446 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
447 --remote-wait-silent
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
448 As --remote-wait, but without the warning when no server is found.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
449 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
450 --serverlist
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
451 List the names of all Vim servers that can be found.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
452 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
453 --servername {name}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
454 Use {name} as the server name. Used for the current Vim, unless used with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
455 --remote argument, then it's the name of the server to connect to.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
456 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
457 --socketid {id}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
458 GTK GUI only: Use the GtkPlug mechanism to run gvim in another window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
459 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
460 --version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
461 Print version information and exit.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
462 .SH ON-LINE HELP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
463 Type ":help" in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
464 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
465 to get started.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
466 Type ":help subject" to get help on a specific subject.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
467 For example: ":help ZZ" to get help for the "ZZ" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
468 Use <Tab> and CTRL-D to complete subjects (":help cmdline-completion").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
469 Tags are present to jump from one place to another (sort of hypertext links,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
470 see ":help").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
471 All documentation files can be viewed in this way, for example
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
472 ":help syntax.txt".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
473 .SH FILES
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
474 .TP 15
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
475 /usr/local/lib/vim/doc/*.txt
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
476 The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
477 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
478 documentation files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
479 Use ":help doc-file-list" to get the complete list.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
480 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
481 /usr/local/lib/vim/doc/tags
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
482 The tags file used for finding information in the documentation files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
483 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
484 /usr/local/lib/vim/syntax/syntax.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
485 System wide syntax initializations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
486 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
487 /usr/local/lib/vim/syntax/*.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
488 Syntax files for various languages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
489 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
490 /usr/local/lib/vim/vimrc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
491 System wide
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
492 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
493 initializations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
494 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
495 /usr/local/lib/vim/gvimrc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
496 System wide gvim initializations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
497 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
498 /usr/local/lib/vim/optwin.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
499 Script used for the ":options" command, a nice way to view and set options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
500 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
501 /usr/local/lib/vim/menu.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
502 System wide menu initializations for gvim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
503 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
504 /usr/local/lib/vim/bugreport.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
505 Script to generate a bug report. See ":help bugs".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
506 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
507 /usr/local/lib/vim/filetype.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
508 Script to detect the type of a file by its name. See ":help 'filetype'".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
509 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
510 /usr/local/lib/vim/scripts.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
511 Script to detect the type of a file by its contents. See ":help 'filetype'".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
512 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
513 /usr/local/lib/vim/*.ps
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
514 Files used for PostScript printing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
515 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
516 For recent info read the VIM home page:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
517 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
518 <URL:http://www.vim.org/>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
519 .SH SEE ALSO
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
520 vimtutor(1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
521 .SH AUTHOR
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
522 Most of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
523 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
524 was made by Bram Moolenaar, with a lot of help from others.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
525 See ":help credits" in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
526 .B Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
527 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
528 .B Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
529 is based on Stevie, worked on by: Tim Thompson,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
530 Tony Andrews and G.R. (Fred) Walter.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
531 Although hardly any of the original code remains.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
532 .SH BUGS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
533 Probably.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
534 See ":help todo" for a list of known problems.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
535 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
536 Note that a number of things that may be regarded as bugs by some, are in fact
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
537 caused by a too-faithful reproduction of Vi's behaviour.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
538 And if you think other things are bugs "because Vi does it differently",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
539 you should take a closer look at the vi_diff.txt file (or type :help
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
540 vi_diff.txt when in Vim).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
541 Also have a look at the 'compatible' and 'cpoptions' options.