annotate runtime/doc/various.txt @ 9:4102fb4ea781 v7.0002

updated for version 7.0002
author vimboss
date Sun, 20 Jun 2004 12:51:53 +0000
parents 7edf9b6e4c36
children 946da5994c01
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 8
diff changeset
1 *various.txt* For Vim version 7.0aa. Last change: 2004 Jun 18
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 VIM REFERENCE MANUAL by Bram Moolenaar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 Various commands *various*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 1. Various commands |various-cmds|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 2. Online help |online-help|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 3. Printing |printing|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12 4. Using Vim like less or more |less|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 1. Various commands *various-cmds*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 *CTRL-L*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 CTRL-L Clear and redraw the screen (later).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20 *:redr* *:redraw*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 :redr[aw][!] Redraw the screen right now. When ! is included it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 cleared first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 Useful to update the screen halfway executing a script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 or function. Also when halfway a mapping and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 'lazyredraw' is set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 *:redraws* *:redrawstatus*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 :redraws[tatus][!] Redraw the status line of the current window. When !
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 is included all status lines are redrawn.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 Useful to update the status line(s) when 'statusline'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 includes an item that doesn't cause automatic
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 updating.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 *N<Del>*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 <Del> When entering a number: Remove the last digit.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 Note: if you like to use <BS> for this, add this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 mapping to your .vimrc: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 :map CTRL-V <BS> CTRL-V <Del>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 < See |:fixdel| if your <Del> key does not do what you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 want.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 :as[cii] or *ga* *:as* *:ascii*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 ga Print the ascii value of the character under the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 cursor in decimal, hexadecimal and octal. For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45 example, when the cursor is on a 'R':
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 <R> 82, Hex 52, Octal 122 ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 When the character is a non-standard ASCII character,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 but printable according to the 'isprint' option, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 non-printable version is also given. When the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 character is larger than 127, the <M-x> form is also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 printed. For example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 <~A> <M-^A> 129, Hex 81, Octal 201 ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 <p> <|~> <M-~> 254, Hex fe, Octal 376 ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 (where <p> is a special character)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 The <Nul> character in a file is stored internally as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56 <NL>, but it will be shown as:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 <^@> 0, Hex 00, Octal 000 ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 Mnemonic: Get Ascii value. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60 *g8*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 g8 Print the hex values of the bytes used in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 character under the cursor, assuming it is in |UTF-8|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 encoding. This also shows composing characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 Example of a character with three composing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 characters:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 e0 b8 81 + e0 b8 b9 + e0 b9 89 ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 *:p* *:pr* *:print*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 :[range]p[rint] Print [range] lines (default current line).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 Note: If you are looking for a way to print your text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 file, you need an external program for that. In the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 GUI you can use the File.Print menu entry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 (For printing on paper see |:hardcopy|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 :[range]p[rint] {count}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 Print {count} lines, starting with [range] (default
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 current line |cmdline-ranges|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 *:P* *:Print*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 :[range]P[rint] [count]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 Just as ":print". Was apparently added to Vi for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 people that keep the shift key pressed too long...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 *:l* *:list*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 :[range]l[ist] [count]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 Same as :print, but display unprintable characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 with '^'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 *:nu* *:number*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 :[range]nu[mber] [count]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 Same as :print, but precede each line with its line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 number. (See also 'highlight' option).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 *:#*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 :[range]# [count] synonym for :number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 *:z* *E144*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99 :{range}z[+-^.=]{count} Display several lines of text surrounding the line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 specified with {range}, or around the current line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101 if there is no {range}. If there is a {count}, that's
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 how many lines you'll see; otherwise, the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 window size is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105 :z can be used either alone or followed by any of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 several punctuation marks. These have the following
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 effect:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109 mark first line last line new location ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 ---- ---------- --------- ------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 + current line 1 scr forward 1 scr forward
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 - 1 scr back current line current line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113 ^ 2 scr back 1 scr back 1 scr back
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 . 1/2 scr back 1/2 scr fwd 1/2 src fwd
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 = 1/2 src back 1/2 scr fwd current line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117 Specifying no mark at all is the same as "+".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118 If the mark is "=", a line of dashes is printed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 around the current line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
121 :{range}z#[+-^.=]{count} *:z#*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122 Like ":z", but number the lines.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
123 {not in all versions of Vi, not with these arguments}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
124
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
125 *:=*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126 := Print the last line number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 :{range}= Prints the last line number in {range}. For example,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129 this prints the current line number: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
130 :.=
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
131
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132 :norm[al][!] {commands} *:norm* *:normal*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133 Execute Normal mode commands {commands}. This makes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134 it possible to execute Normal mode commands typed on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135 the command-line. {commands} is executed like it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 typed. For undo all commands are undone together.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137 If the [!] is given, mappings will not be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
138 {commands} should be a complete command. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139 {commands} does not finish a command, the last one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140 will be aborted as if <Esc> or <C-C> was typed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
141 The display isn't updated while ":normal" is busy.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
142 This implies that an insert command must be completed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143 (to start Insert mode, see |:startinsert|). A ":"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144 command must be completed as well.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145 {commands} cannot start with a space. Put a 1 (one)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 before it, 1 space is one space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147 The 'insertmode' option is ignored for {commands}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 This command cannot be followed by another command,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
149 since any '|' is considered part of the command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150 This command can be used recursively, but the depth is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151 limited by 'maxmapdepth'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 When this command is called from a non-remappable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153 mapping |:noremap|, the argument can be mapped anyway.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154 An alternative is to use |:execute|, which uses an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155 expression as argument. This allows the use of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156 printable characters. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
157 :exe "normal \<c-w>\<c-w>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
158 < {not in Vi, of course}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
159 {not available when the |+ex_extra| feature was
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
160 disabled at compile time}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
161
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
162 :{range}norm[al][!] {commands} *:normal-range*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
163 Execute Normal mode commands {commands} for each line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
164 in the {range}. Before executing the {commands}, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
165 cursor is positioned in the first column of the range,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
166 for each line. Otherwise it's the same as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
167 ":normal" command without a range.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
168 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
169 Not available when |+ex_extra| feature was disabled at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
170 compile time.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
171
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
172 *:sh* *:shell* *E371*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
173 :sh[ell] This command starts a shell. When the shell exits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
174 (after the "exit" command) you return to Vim. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
175 name for the shell command comes from 'shell' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
176 *E360*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
177 Note: This doesn't work when Vim on the Amiga was
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
178 started in QuickFix mode from a compiler, because the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
179 compiler will have set stdin to a non-interactive
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
180 mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182 *:!cmd* *:!* *E34*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183 :!{cmd} Execute {cmd} with the shell. See also the 'shell'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
184 and 'shelltype' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
185 Any '!' in {cmd} is replaced with the previous
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
186 external command (see also 'cpoptions'). But not when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
187 there is a backslash before the '!', then that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
188 backslash is removed. Example: ":!ls" followed by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
189 ":!echo ! \! \\!" executes "echo ls ! \!".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
190 After the command has been executed, the timestamp of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
191 the current file is checked |timestamp|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
192 There cannot be a '|' in {cmd}, see |:bar|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
193 A newline character ends {cmd}, what follows is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
194 interpreted as a following ":" command. However, if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
195 there is a backslash before the newline it is removed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
196 and {cmd} continues. It doesn't matter how many
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
197 backslashes are before the newline, only one is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
198 removed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
199 On Unix the command normally runs in a non-interactive
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
200 shell. If you want an interactive shell to be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
201 (to use aliases) set 'shellcmdflag' to "-ic".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
202 For Win32 also see |:!start|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
203 Vim redraws the screen after the command is finished,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
204 because it may have printed any text. This requires a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
205 hit-enter prompt, so that you can read any messages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
206 To avoid this use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
207 :silent !{cmd}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
208 < The screen is not redrawn then, thus you have to use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
209 CTRL-L or ":redraw!" if the command did display
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
210 something.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
211 Also see |shell-window|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
212
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
213 *:!!*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
214 :!! Repeat last ":!{cmd}".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
215
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
216 *:ve* *:version*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
217 :ve[rsion] Print the version number of the editor. If the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
218 compiler used understands "__DATE__" the compilation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
219 date is mentioned. Otherwise a fixed release-date is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
220 shown.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
221 The following lines contain information about which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
222 features were enabled when Vim was compiled. When
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
223 there is a preceding '+', the feature is included,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
224 when there is a '-' it is excluded. To change this,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
225 you have to edit feature.h and recompile Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
226 To check for this in an expression, see |has()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
227 Here is an overview of the features.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
228 The first column shows the smallest version in which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
229 they are included:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
230 T tiny
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
231 S small
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
232 N normal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
233 B big
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
234 H huge
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
235 m manually enabled or depends on other features
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
236 (none) system dependent
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
237 Thus if a feature is marked with "N", it is included
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
238 in the normal, big and huge versions of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
239
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
240 *+feature-list*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
241 *+ARP* Amiga only: ARP support included
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
242 B *+arabic* |Arabic| language support
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
243 N *+autocmd* |:autocmd|, automatic commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
244 m *+balloon_eval* |balloon-eval| support
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
245 N *+browse* |:browse| command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
246 N *+builtin_terms* some terminals builtin |builtin-terms|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
247 B *++builtin_terms* maximal terminals builtin |builtin-terms|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
248 N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
249 and ":goto" commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
250 N *+cindent* |'cindent'|, C indenting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
251 N *+clientserver* Unix and Win32: Remote invocation |clientserver|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
252 *+clipboard* |clipboard| support
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
253 N *+cmdline_compl* command line completion |cmdline-completion|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
254 N *+cmdline_hist* command line history |cmdline-history|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
255 N *+cmdline_info* |'showcmd'| and |'ruler'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
256 N *+comments* |'comments'| support
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
257 N *+cryptv* encryption support |encryption|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
258 B *+cscope* |cscope| support
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
259 N *+dialog_gui* Support for |:confirm| with GUI dialog.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
260 N *+dialog_con* Support for |:confirm| with console dialog.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
261 N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
262 N *+diff* |vimdiff| and 'diff'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
263 N *+digraphs* |digraphs| *E196*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
264 *+dnd* Support for DnD into the "~ register |quote_~|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
265 B *+emacs_tags* |emacs-tags| files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
266 N *+eval* expression evaluation |eval.txt|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
267 N *+ex_extra* Vim's extra Ex commands: |:center|, |:left|,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
268 |:normal|, |:retab| and |:right|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
269 N *+extra_search* |'hlsearch'| and |'incsearch'| options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
270 B *+farsi* |farsi| language
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
271 N *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
272 N *+find_in_path* include file searches: |[I|, |:isearch|,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
273 |CTRL-W_CTRL-I|, |:checkpath|, etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
274 N *+folding* |folding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
275 *+footer* |gui-footer|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
276 *+fork* Unix only: |fork| shell commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
277 N *+gettext* message translations |multi-lang|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
278 *+GUI_Athena* Unix only: Athena |GUI|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
279 *+GUI_neXtaw* Unix only: neXtaw |GUI|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
280 *+GUI_BeOS* BeOS only: BeOS |GUI|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
281 *+GUI_GTK* Unix only: GTK+ |GUI|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
282 *+GUI_Motif* Unix only: Motif |GUI|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
283 *+GUI_Photon* QNX only: Photon |GUI|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
284 m *+hangul_input* Hangul input support |hangul|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
285 *+iconv* Compiled with the |iconv()| function, may have |/dyn|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
286 N *+insert_expand* |insert_expand| Insert mode completion
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
287 N *+jumplist* |jumplist|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
288 B *+keymap* |'keymap'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
289 B *+langmap* |'langmap'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
290 N *+libcall* |libcall()|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
291 N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
292 N *+lispindent* |'lisp'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
293 N *+listcmds* Vim commands for the list of buffers |buffer-hidden|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
294 and argument list |:argdelete|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
295 N *+localmap* Support for mappings local to a buffer |:map-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
296 N *+menu* |:menu|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
297 N *+mksession* |:mksession|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
298 N *+modify_fname* |filename-modifiers|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
299 N *+mouse* Mouse handling |mouse-using|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
300 N *+mouseshape* |'mouseshape'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
301 B *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
302 N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
303 B *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
304 N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
305 N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
306 B *+multi_byte* Korean and other languages |multibyte|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
307 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
308 N *+multi_lang* non-English language support |multi-lang|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
309 m *+netbeans_intg* |netbeans|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
310 m *+ole* Win32 GUI only: |ole-interface|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
311 *+osfiletype* Support for the 'osfiletype' option and filetype
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
312 checking in automatic commands. |autocmd-osfiletypes|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
313 N *+path_extra* Up/downwards search in 'path' and 'tags'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
314 m *+perl* Perl interface |perl|, may have |/dyn|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
315 *+postscript* |:hardcopy| writes a PostScript file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
316 N *+printer* |:hardcopy| command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
317 m *+python* Python interface |python|, may have |/dyn|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
318 N *+quickfix* |:make| and |quickfix| commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
319 B *+rightleft* Right to left typing |'rightleft'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
320 m *+ruby* Ruby interface |ruby|, may have |/dyn|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
321 N *+scrollbind* |'scrollbind'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
322 B *+signs* |:sign|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
323 N *+smartindent* |'smartindent'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
324 m *+sniff* SniFF interface |sniff|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
325 N *+statusline* Options 'statusline', 'rulerformat' and special
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
326 formats of 'titlestring' and 'iconstring'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
327 m *+sun_workshop* |workshop|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
328 N *+syntax* Syntax highlighting |syntax|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
329 *+system()* Unix only: opposite of |+fork|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
330 N *+tag_binary* binary searching in tags file |tag-binary-search|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
331 N *+tag_old_static* old method for static tags |tag-old-static|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
332 m *+tag_any_white* any white space allowed in tags file |tag-any-white|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
333 m *+tcl* Tcl interface |tcl|, may have |/dyn|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
334 *+terminfo* uses |terminfo| instead of termcap
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
335 N *+termresponse* support for |t_RV| and |v:termresponse|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
336 N *+textobjects* |text-objects| selection
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
337 *+tgetent* non-Unix only: able to use external termcap
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
338 N *+title* Setting the window title |'title'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
339 N *+toolbar* |gui-toolbar|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
340 N *+user_commands* User-defined commands. |user-commands|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
341 N *+viminfo* |'viminfo'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
342 N *+vertsplit* Vertically split windows |:vsplit|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
343 N *+virtualedit* |'virtualedit'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
344 S *+visual* Visual mode |Visual-mode|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
345 N *+visualextra* extra Visual mode commands |blockwise-operators|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
346 N *+vreplace* |gR| and |gr|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
347 N *+wildignore* |'wildignore'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
348 N *+wildmenu* |'wildmenu'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
349 S *+windows* more than one window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
350 m *+writebackup* |'writebackup'| is default on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
351 m *+xim* X input method |xim|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
352 *+xfontset* X fontset support |xfontset|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
353 *+xsmp* XSMP (X session management) support
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
354 *+xsmp_interact* interactive XSMP (X session management) support
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
355 N *+xterm_clipboard* Unix only: xterm clipboard handling
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
356 m *+xterm_save* save and restore xterm screen |xterm-screens|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
357 N *+X11* Unix only: can restore window title |X11|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
358
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
359 */dyn* *E370* *E448*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
360 To some of the features "/dyn" is added when the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
361 feature is only available when the related library can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
362 be dynamically loaded.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
363
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
364 :ve[rsion] {nr} Is now ignored. This was previously used to check the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
365 version number of a .vimrc file. It was removed,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
366 because you can now use the ":if" command for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
367 version-dependent behavior. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
368
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
369 *:redi* *:redir*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
370 :redi[r][!] > {file} Redirect messages to file {file}. The messages which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
371 are the output of commands are written to that file,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
372 until redirection ends. The messages are also still
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
373 shown on the screen. When [!] is included, an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
374 existing file is overwritten. When [!] is omitted,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
375 and {file} exists, this command fails.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
376 Only one ":redir" can be active at a time. Calls to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
377 ":redir" will close any active redirection before
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
378 starting redirection to the new target.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
379 To stop the messages and commands from being echoed to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
380 the screen, put the commands in a function and call it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
381 with ":silent call Function()".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
382 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
383
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
384 :redi[r] >> {file} Redirect messages to file {file}. Append if {file}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
385 already exists. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
386
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
387 :redi[r] @{a-zA-Z} Redirect messages to register {a-z}. Append to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
388 contents of the register if its name is given
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
389 uppercase {A-Z}. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
390
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
391 :redi[r] @* Redirect messages to the clipboard. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
392
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
393 :redi[r] @" Redirect messages to the unnamed register. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
394
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
395 :redi[r] END End redirecting messages. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
396
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
397 *:sil* *:silent*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
398 :sil[ent][!] {command} Execute {command} silently. Normal messages will not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
399 be given or added to the message history.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
400 When [!] is added, error messages will also be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
401 skipped, and commands and mappings will not be aborted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
402 when an error is detected. |v:errmsg| is still set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
403 When [!] is not used, an error message will cause
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
404 further messages to be displayed normally.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
405 Redirection, started with |:redir|, will continue as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
406 usual, although there might be small differences.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
407 This will allow redirecting the output of a command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
408 without seeing it on the screen. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
409 :redir >/tmp/foobar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
410 :silent g/Aap/p
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
411 :redir END
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
412 < To execute a Normal mode command silently, use the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
413 |:normal| command. For example, to search for a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
414 string without messages: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
415 :silent exe "normal /path\<CR>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
416 < ":silent!" is useful to execute a command that may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
417 fail, but the failure is to be ignored. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
418 :let v:errmsg = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
419 :silent! /^begin
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
420 :if v:errmsg != ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
421 : ... pattern was not found
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
422 < ":silent" will also avoid the hit-enter prompt. When
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
423 using this for an external command, this may cause the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
424 screen to be messed up. Use |CTRL-L| to clean it up
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
425 then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
426 ":silent menu ..." defines a menu that will not echo a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
427 Command-line command. The command will still produce
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
428 messages though. Use ":silent" in the command itself
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
429 to avoid that: ":silent menu .... :silent command".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
430
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
431 *:verb* *:verbose*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
432 :[count]verb[ose] {command}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
433 Execute {command} with 'verbose' set to [count]. If
8
7edf9b6e4c36 Various changes
vimboss
parents: 7
diff changeset
434 [count] is omitted one is used. ":0verbose" can be
7edf9b6e4c36 Various changes
vimboss
parents: 7
diff changeset
435 used to set 'verbose' to zero.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
436 The additional use of ":silent" makes messages
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
437 generated but not displayed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
438 The combination of ":silent" and ":verbose" can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
439 used to generate messages and check them with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
440 |v:statusmsg| and friends. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
441 :let v:statusmsg = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
442 :silent verbose runtime foobar.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
443 :if v:statusmsg != ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
444 : " foobar.vim could not be found
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
445 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
446 < When concatenating another command, the ":verbose"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
447 only applies to the first one: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
448 :4verbose set verbose | set verbose
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
449 < verbose=4 ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
450 verbose=0 ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
451
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
452 *K*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
453 K Run a program to lookup the keyword under the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
454 cursor. The name of the program is given with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
455 'keywordprg' (kp) option (default is "man"). The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
456 keyword is formed of letters, numbers and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
457 characters in 'iskeyword'. The keyword under or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
458 right of the cursor is used. The same can be done
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
459 with the command >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
460 :!{program} {keyword}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
461 < There is an example of a program to use in the tools
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
462 directory of Vim. It is called 'ref' and does a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
463 simple spelling check.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
464 Special cases:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
465 - If 'keywordprg' is empty, the ":help" command is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
466 used. It's a good idea to include more characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
467 in 'iskeyword' then, to be able to find more help.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
468 - When 'keywordprg' is equal to "man", a count before
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
469 "K" is inserted after the "man" command and before
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
470 the keyword. For example, using "2K" while the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
471 cursor is on "mkdir", results in: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
472 !man 2 mkdir
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
473 < - When 'keywordprg' is equal to "man -s", a count
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
474 before "K" is inserted after the "-s". If there is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
475 no count, the "-s" is removed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
476 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
477
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
478 *v_K*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
479 {Visual}K Like "K", but use the visually highlighted text for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
480 the keyword. Only works when the highlighted text is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
481 not more than one line. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
482
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
483 [N]gs *gs* *:sl* *:sleep*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
484 :[N]sl[eep] [N] [m] Do nothing for [N] seconds. When [m] is included,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
485 sleep for [N] milliseconds. The count for "gs" always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
486 uses seconds. The default is one second. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
487 :sleep "sleep for one second
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
488 :5sleep "sleep for five seconds
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
489 :sleep 100m "sleep for a hundred milliseconds
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
490 10gs "sleep for ten seconds
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
491 < Can be interrupted with CTRL-C (CTRL-Break on MS-DOS).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
492 "gs" stands for "goto sleep". While sleeping the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
493 cursor is positioned in the text (if visible). {not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
494 in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
495
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
496 *g_CTRL-A*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
497 g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
498 (which is very rare): print memory usage statistics.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
499 Only useful for debugging Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
500
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
501 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
502 2. Online help *online-help*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
503
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
504 *help* *<Help>* *:h* *:help* *<F1>* *i_<F1>* *i_<Help>*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
505 <Help> or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
506 :h[elp] Open a window and display the help file in read-only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
507 mode. If there is a help window open already, use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
508 that one. Otherwise, if the current window uses the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
509 full width of the screen or is at least 80 characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
510 wide, the help window will appear just above the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
511 current window. Otherwise the new window is put at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
512 the very top.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
513 The 'helplang' option is used to select a language, if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
514 the main help file is available in several languages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
515 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
516
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
517 *{subject}* *E149* *E661*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
518 :h[elp] {subject} Like ":help", additionally jump to the tag {subject}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
519 {subject} can include wildcards like "*", "?" and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
520 "[a-z]":
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
521 :help z? jump to help for any "z" command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
522 :help z. jump to the help for "z."
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
523 If there is no full match for the pattern, or there
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
524 are several matches, the "best" match will be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
525 A sophisticated algorithm is used to decide which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
526 match is better than another one. These items are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
527 considered in the computation:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
528 - A match with same case is much better than a match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
529 with different case.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
530 - A match that starts after a non-alphanumeric
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
531 character is better than a match in the middle of a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
532 word.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
533 - A match at or near the beginning of the tag is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
534 better than a match further on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
535 - The more alphanumeric characters match, the better.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
536 - The shorter the length of the match, the better.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
537
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
538 The 'helplang' option is used to select a language, if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
539 the {subject} is available in several languages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
540 To find a tag in a specific language, append "@ab",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
541 where "ab" is the two-letter language code. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
542 |help-translated|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
543
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
544 Note that the longer the {subject} you give, the less
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
545 matches will be found. You can get an idea how this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
546 all works by using commandline completion (type CTRL-D
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
547 after ":help subject").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
548 If there are several matches, you can have them listed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
549 by hitting CTRL-D. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
550 :help cont<Ctrl-D>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
551 < To use a regexp |pattern|, first do ":help" and then
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
552 use ":tag {pattern}" in the help window. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
553 ":tnext" command can then be used to jump to other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
554 matches, "tselect" to list matches and choose one. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
555 :help index| :tse z.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
556 < This command can be followed by '|' and another
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
557 command, but you don't need to escape the '|' inside a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
558 help command. So these both work: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
559 :help |
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
560 :help k| only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
561 < Note that a space before the '|' is seen as part of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
562 the ":help" argument.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
563 You can also use <LF> or <CR> to separate the help
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
564 command from a following command. You need to type
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
565 CTRL-V first to insert the <LF> or <CR>. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
566 :help so<C-V><CR>only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
567 < {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
568
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
569 :h[elp]! [subject] Like ":help", but in non-English help files prefer to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
570 find a tag in a file with the same language as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
571 current file. See |help-translated|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
572
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
573 *:helpg* *:helpgrep*
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 8
diff changeset
574 :helpg[rep] {pattern}[@xx]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
575 Search all help text files and make a list of lines
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
576 in which {pattern} matches. Jumps to the first match.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 8
diff changeset
577 The optional [@xx] specifies that only matches in the
4102fb4ea781 updated for version 7.0002
vimboss
parents: 8
diff changeset
578 "xx" language are to be found.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
579 You can navigate through the matches with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
580 |quickfix| commands, e.g., |:cnext| to jump to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
581 next one. Or use |:cwindow| to get the list of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
582 matches in the quickfix window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
583 {pattern} is used as a Vim regexp |pattern|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
584 'ignorecase' is not used, add "\c" to ignore case.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
585 Example for case sensitive search: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
586 :helpgrep Uganda
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
587 < Example for case ignoring search: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
588 :helpgrep uganda\c
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 8
diff changeset
589 < Example for searching in French help: >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 8
diff changeset
590 :helpgrep backspace@fr
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
591 < Cannot be followed by another command, everything is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
592 used as part of the pattern. But you can use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
593 |:execute| when needed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
594 Compressed help files will not be searched (Debian
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
595 compresses the help files).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
596 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
597
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
598
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
599 When no argument is given to |:help| the file given with the 'helpfile' option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
600 will be opened. Otherwise the specified tag is searched for in all "doc/tags"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
601 files in the directories specified in the 'runtimepath' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
602
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
603 The initial height of the help window can be set with the 'helpheight' option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
604 (default 20).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
605
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
606 Jump to specific subjects by using tags. This can be done in two ways:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
607 - Use the "CTRL-]" command while standing on the name of a command or option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
608 This only works when the tag is a keyword. "<C-Leftmouse>" and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
609 "g<LeftMouse>" work just like "CTRL-]".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
610 - use the ":ta {subject}" command. This also works with non-keyword
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
611 characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
612
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
613 Use CTRL-T or CTRL-O to jump back.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
614 Use ":q" to close the help window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
615
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
616 If there are several matches for an item you are looking for, this is how you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
617 can jump to each one of them:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
618 1. Open a help window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
619 2. Use the ":tag" command with a slash prepended to the tag. E.g.: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
620 :tag /min
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
621 3. Use ":tnext" to jump to the next matching tag.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
622
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
623 It is possible to add help files for plugins and other items. You don't need
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
624 to change the distributed help files for that. See |add-local-help|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
625
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
626 To write a local help file, see |write-local-help|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
627
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
628 Note that the title lines from the local help files are automagically added to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
629 the "LOCAL ADDITIONS" section in the "help.txt" help file |local-additions|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
630 This is done when viewing the file in Vim, the file itself is not changed. It
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
631 is done by going through all help files and obtaining the first line of each
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
632 file. The files in $VIMRUNTIME/doc are skipped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
633
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
634 *help-xterm-window*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
635 If you want to have the help in another xterm window, you could use this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
636 command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
637 :!xterm -e vim +help &
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
638 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
639
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
640 *:helpfind* *:helpf*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
641 :helpf[ind] Like |:help|, but use a dialog to enter the argument.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
642 Only for backwards compatibility. It now executes the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
643 ToolBar.FindHelp menu entry instead of using a builtin
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
644 dialog. {only when compiled with |+GUI_GTK|}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
645 < {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
646
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
647 *:helpt* *:helptags*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
648 *E154* *E150* *E151* *E152* *E153* *E670*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
649 :helpt[ags] {dir} Generate the help tags file(s) for directory {dir}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
650 All "*.txt" and "*.??x" files in the directory are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
651 scanned for a help tag definition in between stars.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
652 The "*.??x" files are for translated docs, they
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
653 generate the "tags-??" file, see |help-translated|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
654 The generated tags files are sorted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
655 When there are duplicates an error message is given.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
656 An existing tags file is silently overwritten.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
657 To rebuild the help tags in the runtime directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
658 (requires write permission there): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
659 :helptags $VIMRUNTIME/doc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
660 < {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
661
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
662
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
663 TRANSLATED HELP *help-translated*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
664
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
665 It is possible to add translated help files, next to the original English help
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
666 files. Vim will search for all help in "doc" directories in 'runtimepath'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
667 This is only available when compiled with the |+multi_lang| feature.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
668
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
669 A set of translated help files consists of these files:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
670
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
671 help.abx
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
672 howto.abx
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
673 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
674 tags-ab
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
675
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
676 "ab" is the two-letter language code. Thus for Italian the names are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
677
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
678 help.itx
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
679 howto.itx
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
680 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
681 tags-it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
682
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
683 The 'helplang' option can be set to the preferred language(s). The default is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
684 set according to the environment. Vim will first try to find a matching tag
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
685 in the preferred language(s). English is used when it cannot be found.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
686
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
687 To find a tag in a specific language, append "@ab" to a tag, where "ab" is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
688 two-letter language code. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
689 :he user-manual@it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
690 :he user-manual@en
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
691 The first one finds the Italian user manual, even when 'helplang' is empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
692 The second one finds the English user manual, even when 'helplang' is set to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
693 "it".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
694
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
695 When using command-line completion for the ":help" command, the "@en"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
696 extention is only shown when a tag exists for multiple languages. When the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
697 tag only exists for English "@en" is omitted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
698
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
699 When using |CTRL-]| or ":help!" in a non-English help file Vim will try to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
700 find the tag in the same language. If not found then 'helplang' will be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
701 to select a language.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
702
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
703 Help files must use latin1 or utf-8 encoding. Vim assumes the encoding is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
704 utf-8 when finding non-ASCII characters in the first line. Thus you must
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
705 translate the header with "For Vim version".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
706
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
707 The same encoding must be used for the help files of one language in one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
708 directory. You can use a different encoding for different languages and use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
709 a different encoding for help files of the same language but in a different
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
710 directory.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
711
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
712 Hints for translators:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
713 - Do not translate the tags. This makes it possible to use 'helplang' to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
714 specify the preferred language. You may add new tags in your language.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
715 - When you do not translate a part of a file, add tags to the English version,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
716 using the "tag@en" notation.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
717 - Make a package with all the files and the tags file available for download.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
718 Users can drop it in one of the "doc" directories and start use it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
719 Report this to Bram, so that he can add a link on www.vim.org.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
720 - Use the |:helptags| command to generate the tags files. It will find all
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
721 languages in the specified directory.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
722
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
723 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
724 3. Printing *printing*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
725
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
726 On MS-Windows Vim can print your text on any installed printer. On other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
727 systems a PostScript file is produced. This can be directly sent to a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
728 PostScript printer. For other printers a program like ghostscript needs to be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
729 used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
730
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
731 3.1 PostScript Printing |postscript-printing|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
732 3.2 PostScript Printing Encoding |postscript-print-encoding|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
733 3.3 PostScript Printing Troubleshooting |postscript-print-trouble|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
734 3.4 PostScript Utilities |postscript-print-util|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
735 3.5 Formfeed Characters |printing-formfeed|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
736
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
737 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
738 {only available when compiled with |+printer| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
739
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
740 *:ha* *:hardcopy* *E237* *E238* *E324*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
741 :[range]ha[rdcopy][!] [arguments]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
742 Send [range] lines (default whole file) to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
743 printer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
744
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
745 On MS-Windows a dialog is displayed to allow selection
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
746 of printer, paper size etc. To skip the dialog, use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
747 the [!]. In this case the printer defined by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
748 'printdevice' is used, or, if 'printdevice' is empty,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
749 the system default printer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
750
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
751 For systems other than MS-Windows, PostScript is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
752 written in a temp file and 'printexpr' is used to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
753 actually print it. Then [arguments] can be used by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
754 'printexpr' through |v:cmdarg|. Otherwise [arguments]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
755 is ignored. 'printoptions' can be used to specify
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
756 paper size, duplex, etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
757
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
758 :[range]ha[rdcopy][!] >{filename}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
759 As above, but write the resulting PostScript in file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
760 {filename}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
761 Things like "%" are expanded |cmdline-special|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
762 Careful: An existing file is silently overwritten.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
763 {only available when compiled with the |+postscript|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
764 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
765 On MS-Windows use the "print to file" feature of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
766 printer driver.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
767
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
768 Progress is displayed during printing as a page number and a percentage. To
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
769 abort printing use the interrupt key (CTRL-C or, on MS-systems, CTRL-Break).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
770
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
771 Printer output is controlled by the 'printfont' and 'printoptions' options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
772 'printheader' specifies the format of a page header.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
773
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
774 The printed file is always limited to the selected margins, irrespective of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
775 the current window's 'wrap' or 'linebreak' settings. The "wrap" item in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
776 'printoptions' can be used to switch wrapping off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
777 The current highlighting colors are used in the printout, with the following
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
778 considerations:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
779 1) The normal background is always rendered as white (i.e. blank paper.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
780 2) White text or the default foreground is rendered as black, so that it shows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
781 up!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
782 3) If 'background' is "dark", then the colours are darkened to compensate for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
783 the fact that otherwise they would be too bright to show up clearly on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
784 white paper.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
785
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
786
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
787 3.1 PostScript Printing *postscript-printing*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
788 *E455* *E456* *E457* *E624*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
789 Provided you have enough disk space there should be no problems generating a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
790 PostScript file. You need to have the runtime files correctly installed (if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
791 you can find the help files, they probably are).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
792
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
793 There are currently a number of limitations with PostScript printing:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
794
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
795 - 'printfont' - The font name is ignored (the Courier family is always used -
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
796 it should be available on all PostScript printers) but the font size is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
797 used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
798
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
799 - 'printoptions' - The duplex setting is used when generating PostScript
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
800 output, but it is up to the printer to take notice of the setting. If the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
801 printer does not support duplex printing then it should be silently ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
802 Some printers, however, don't print at all.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
803
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
804 - 8-bit support - While a number of 8-bit print character encodings are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
805 supported it is possible that some characters will not print. Whether a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
806 character will print depends on the font in the printer knowing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
807 character. Missing characters will be replaced with an upside down question
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
808 mark, or a space if that character is also not known by the font. It may be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
809 possible to get all the characters in an encoding to print by installing a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
810 new version of the Courier font family.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
811
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
812 - Multi-byte support - Currently VIM will try to convert multi-byte characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
813 to the 8-bit encoding specified by 'printencoding' (or latin1 if it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
814 empty). Any characters that are not successfully converted are shown as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
815 unknown characters. Printing will fail if VIM cannot convert the multi-byte
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
816 to the 8-bit encoding.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
817
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
818
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
819 3.2 Custom 8-bit Print Character Encodings *postscript-print-encoding*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
820 *E618* *E619*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
821 To use your own print character encoding when printing 8-bit character data
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
822 you need to define your own PostScript font encoding vector. Details on how
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
823 to to define a font encoding vector is beyond the scope of this help file, but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
824 you can find details in the PostScript Language Reference Manual, 3rd Edition,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
825 published by Addison-Wesley and available in PDF form at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
826 http://www.adobe.com/. The following describes what you need to do for VIM to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
827 locate and use your print character encoding.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
828
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
829 i. Decide on a unique name for your encoding vector, one that does not clash
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
830 with any of the recognized or standard encoding names that VIM uses (see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
831 |encoding-names| for a list), and that no one else is likely to use.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
832 ii. Copy $VIMRUNTIME/print/latin1.ps to the print subdirectory in your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
833 'runtimepath' and rename it with your unique name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
834 iii. Edit your renamed copy of latin1.ps, replacing all occurrences of latin1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
835 with your unique name (don't forget the line starting %%Title:), and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
836 modify the array of glyph names to define your new encoding vector. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
837 array must have exactly 256 entries or you will not be able to print!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
838 iv. Within VIM, set 'printencoding' to your unique encoding name and then
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
839 print your file. VIM will now use your custom print character encoding.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
840
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
841 VIM will report an error with the resource file if you change the order or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
842 content of the first 3 lines, other than the name of the encoding on the line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
843 starting %%Title: or the version number on the line starting %%Version:.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
844
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
845 [Technical explanation for those that know PostScript - VIM looks for a file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
846 with the same name as the encoding it will use when printing. The file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
847 defines a new PostScript Encoding resource called /VIM-name, where name is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
848 print character encoding VIM will use.]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
849
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
850
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
851 3.3 PostScript Printing Troubleshooting *postscript-print-trouble*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
852 *E621*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
853 Usually the only sign of a problem when printing with PostScript is that your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
854 printout does not appear. If you are lucky you may get a printed page that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
855 tells you the PostScript operator that generated the error that prevented the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
856 print job completing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
857
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
858 There are a number of possible causes as to why the printing may have failed:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
859
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
860 - Wrong version of the prolog resource file. The prolog resource file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
861 contains some PostScript that VIM needs to be able to print. Each version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
862 of VIM needs one particular version. Make sure you have correctly installed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
863 the runtime files, and don't have any old versions of a file called prolog
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
864 in the print directory in your 'runtimepath' directory.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
865
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
866 - Paper size. Some PostScript printers will abort printing a file if they do
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
867 not support the requested paper size. By default VIM uses A4 paper. Find
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
868 out what size paper your printer normally uses and set the appropriate paper
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
869 size with 'printoptions'. If you cannot find the name of the paper used,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
870 measure a sheet and compare it with the table of supported paper sizes listed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
871 for 'printoptions', using the paper that is closest in both width AND height.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
872 Note: The dimensions of actual paper may vary slightly from the ones listed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
873 If there is no paper listed close enough, then you may want to try psresize
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
874 from PSUtils, discussed below.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
875
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
876 - Two-sided printing (duplex). Normally a PostScript printer that does not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
877 support two-sided printing will ignore any request to do it. However, some
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
878 printers may abort the job altogether. Try printing with duplex turned off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
879 Note: Duplex prints can be achieved manually using PS utils - see below.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
880
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
881 - Collated printing. As with Duplex printing, most PostScript printers that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
882 do not support collating printouts will ignore a request to do so. Some may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
883 not. Try printing with collation turned off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
884
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
885 - Syntax highlighting. Some print management code may prevent the generated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
886 PostScript file from being printed on a black and white printer when syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
887 highlighting is turned on, even if solid black is the only color used. Try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
888 printing with syntax highlighting turned off.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
889
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
890 A safe printoptions setting to try is: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
891
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
892 :set printoptions=paper:A4,duplex:off,collate:n,syntax:n
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
893
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
894 Replace "A4" with the paper size that best matches your printer paper.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
895
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
896
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
897 3.4 PostScript Utilities *postscript-print-util*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
898
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
899 3.4.1 Ghostscript
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
900
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
901 Ghostscript is a PostScript and PDF interpreter that can be used to display
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
902 and print on non-PostScript printers PostScript and PDF files. It can also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
903 generate PDF files from PostScript.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
904
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
905 Ghostscript will run on a wide variety of platforms.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
906
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
907 There are three available versions:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
908
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
909 - AFPL Ghostscript (formerly Aladdin Ghostscript) which is free for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
910 non-commercial use. It can be obtained from:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
911
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
912 http://www.cs.wisc.edu/~ghost/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
913
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
914 - GNU Ghostscript which is available under the GNU General Public License. It
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
915 can be obtained from:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
916
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
917 ftp://mirror.cs.wisc.edu/pub/mirrors/ghost/gnu/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
918
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
919 - A commercial version for inclusion in commercial products.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
920
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
921 Additional information on Ghostscript can also be found at:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
922
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
923 http://www.ghostscript.com/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
924
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
925 Support for a number of non PostScript printers is provided in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
926 distribution as standard, but if you cannot find support for your printer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
927 check the Ghostscript site for other printers not included by default.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
928
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
929
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
930 3.4.2 Ghostscript Previewers.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
931
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
932 The interface to Ghostscript is very primitive so a number of graphical front
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
933 ends have been created. These allow easier PostScript file selection,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
934 previewing at different zoom levels, and printing. Check supplied
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
935 documentation for full details.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
936
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
937 X11
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
938
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
939 - Ghostview. Obtainable from:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
940
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
941 http://www.cs.wisc.edu/~ghost/gv/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
942
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
943 - gv. Derived from Ghostview. Obtainable from:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
944
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
945 http://wwwthep.physik.uni-mainz.de/~plass/gv/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
946
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
947 Copies (possibly not the most recent) can be found at:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
948
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
949 http://www.cs.wisc.edu/~ghost/gv/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
950
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
951 OpenVMS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
952
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
953 - Is apparently supported in the main code now (untested). See:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
954
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
955 http://wwwthep.physik.uni-mainz.de/~plass/gv/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
956
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
957 Windows and OS/2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
958
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
959 - GSview. Obtainable from:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
960
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
961 http://www.cs.wisc.edu/~ghost/gsview/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
962
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
963 DOS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
964
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
965 - ps_view. Obtainable from:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
966
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
967 ftp://ftp.pg.gda.pl/pub/TeX/support/ps_view/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
968 ftp://ftp.dante.de/tex-archive/support/ps_view/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
969
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
970 Linux
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
971
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
972 - GSview. Linux version of the popular Windows and OS/2 previewer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
973 Obtainable from:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
974
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
975 http://www.cs.wisc.edu/~ghost/gsview/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
976
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
977 - BMV. Different from Ghostview and gv in that it doesn't use X but svgalib.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
978 Obtainable from:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
979
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
980 ftp://sunsite.unc.edu/pub/Linux/apps/graphics/viewers/svga/bmv-1.2.tgz
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
981
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
982
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
983 3.4.3 PSUtils
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
984
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
985 PSUtils is a collection of utility programs for manipulating PostScript
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
986 documents. Binary distributions are available for many platforms, as well as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
987 the full source. PSUtils can be found at:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
988
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
989 http://knackered.org/angus/psutils
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
990
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
991 The utilities of interest include:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
992
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
993 - psnup. Convert PS files for N-up printing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
994 - psselect. Select page range and order of printing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
995 - psresize. Change the page size.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
996 - psbook. Reorder and lay out pages ready for making a book.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
997
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
998 The output of one program can be used as the input to the next, allowing for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
999 complex print document creation.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1000
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1001
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1002 N-UP PRINTING
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1003
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1004 The psnup utility takes an existing PostScript file generated from VIM and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1005 convert it to an n-up version. The simplest way to create a 2-up printout is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1006 to first create a PostScript file with: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1007
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1008 :hardcopy > test.ps
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1009
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1010 Then on your command line execute: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1011
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1012 psnup -n 2 test.ps final.ps
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1013
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1014 Note: You may get warnings from some Ghostscript previewers for files produced
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1015 by psnup - these may safely be ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1016
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1017 Finally print the file final.ps to your PostScript printer with your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1018 platform's print command. (You will need to delete the two PostScript files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1019 afterwards yourself.) 'printexpr' could be modified to perform this extra
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1020 step before printing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1021
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1022
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1023 ALTERNATE DUPLEX PRINTING
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1024
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1025 It is possible to achieve a poor man's version of duplex printing using the PS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1026 utility psselect. This utility has options -e and -o for printing just the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1027 even or odd pages of a PS file respectively.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1028
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1029 First generate a PS file with the 'hardcopy' command, then generate a new
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1030 files with all the odd and even numbered pages with: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1031
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1032 psselect -o test.ps odd.ps
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1033 psselect -e test.ps even.ps
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1034
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1035 Next print odd.ps with your platform's normal print command. Then take the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1036 print output, turn it over and place it back in the paper feeder. Now print
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1037 even.ps with your platform's print command. All the even pages should now
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1038 appear on the back of the odd pages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1039
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1040 There a couple of points to bear in mind:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1041
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1042 1. Position of the first page. If the first page is on top of the printout
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1043 when printing the odd pages then you need to reverse the order that the odd
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1044 pages are printed. This can be done with the -r option to psselect. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1045 will ensure page 2 is printed on the back of page 1.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1046 Note: it is better to reverse the odd numbered pages rather than the even
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1047 numbered in case there are an odd number of pages in the original PS file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1048
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1049 2. Paper flipping. When turning over the paper with the odd pages printed on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1050 them you may have to either flip them horizontally (along the long edge) or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1051 vertically (along the short edge), as well as possibly rotating them 180
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1052 degrees. All this depends on the printer - it will be more obvious for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1053 desktop ink jets than for small office laser printers where the paper path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1054 is hidden from view.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1055
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1056
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1057 3.5 Formfeed Characters *printing-formfeed*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1058
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1059 By default VIM does not do any special processing of |formfeed| control
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1060 characters. Setting the 'printoptions' formfeed item will make VIM recognize
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1061 formfeed characters and continue printing the current line at the beginning
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1062 of the first line on a new page. The use of formfeed characters provides
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1063 rudimentary print control but there are certain things to be aware of.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1064
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1065 VIM will always start printing a line (including a line number if enabled)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1066 containing a formfeed character, even if it is the first character on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1067 line. This means if a line starting with a formfeed character is the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1068 line of a page then VIM will print a blank page.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1069
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1070 Since the line number is printed at the start of printing the line containing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1071 the formfeed character, the remainder of the line printed on the new page
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1072 will not have a line number printed for it (in the same way as the wrapped
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1073 lines of a long line when wrap in 'printoptions' is enabled).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1074
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1075 If the formfeed character is the last character on a line, then printing will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1076 continue on the second line of the new page, not the first. This is due to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1077 VIM processing the end of the line after the formfeed character and moving
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1078 down a line to continue printing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1079
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1080 Due to the points made above it is recommended that when formfeed character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1081 processing is enabled, printing of line numbers is disabled, and that form
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1082 feed characters are not the last character on a line. Even then you may need
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1083 to adjust the number of lines before a formfeed character to prevent
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1084 accidental blank pages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1085
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1086 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1087 4. Using Vim like less or more *less*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1088
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1089 If you use the less or more program to view a file, you don't get syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1090 highlighting. Thus you would like to use Vim instead. You can do this by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1091 using the shell script "$VIMRUNTIME/macros/less.sh".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1092
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1093 This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1094 up mappings to simulate the commands that less supports. Otherwise, you can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1095 still use the Vim commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1096
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1097 This isn't perfect. For example, when viewing a short file Vim will still use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1098 the whole screen. But it works good enough for most uses, and you get syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1099 highlighting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1100
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1101 The "h" key will give you a short overview of the available commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1102
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1103 vim:tw=78:ts=8:ft=help:norl: