blob: 2f5a1a96c91477547dfc7135c8ab85f39576194b [file] [log] [blame]
Bram Moolenaarb1c91982018-05-17 17:04:55 +02001*print.txt* For Vim version 8.1. Last change: 2010 Jul 20
Bram Moolenaar8299df92004-07-10 09:47:34 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Printing *printing*
8
91. Introduction |print-intro|
102. Print options |print-options|
113. PostScript Printing |postscript-printing|
124. PostScript Printing Encoding |postscript-print-encoding|
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000135. PostScript CJK Printing |postscript-cjk-printing|
Bram Moolenaar8299df92004-07-10 09:47:34 +0000146. PostScript Printing Troubleshooting |postscript-print-trouble|
157. PostScript Utilities |postscript-print-util|
168. Formfeed Characters |printing-formfeed|
17
18{Vi has None of this}
19{only available when compiled with the |+printer| feature}
20
21==============================================================================
221. Introduction *print-intro*
23
24On MS-Windows Vim can print your text on any installed printer. On other
25systems a PostScript file is produced. This can be directly sent to a
26PostScript printer. For other printers a program like ghostscript needs to be
27used.
28
Bram Moolenaara7241f52008-06-24 20:39:31 +000029Note: If you have problems printing with |:hardcopy|, an alternative is to use
30|:TOhtml| and print the resulting html file from a browser.
31
Bram Moolenaar8299df92004-07-10 09:47:34 +000032 *:ha* *:hardcopy* *E237* *E238* *E324*
33:[range]ha[rdcopy][!] [arguments]
34 Send [range] lines (default whole file) to the
35 printer.
36
37 On MS-Windows a dialog is displayed to allow selection
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000038 of printer, paper size etc. To skip the dialog, use
Bram Moolenaar8299df92004-07-10 09:47:34 +000039 the [!]. In this case the printer defined by
40 'printdevice' is used, or, if 'printdevice' is empty,
41 the system default printer.
42
43 For systems other than MS-Windows, PostScript is
44 written in a temp file and 'printexpr' is used to
45 actually print it. Then [arguments] can be used by
46 'printexpr' through |v:cmdarg|. Otherwise [arguments]
47 is ignored. 'printoptions' can be used to specify
48 paper size, duplex, etc.
Bram Moolenaard473c8c2018-08-11 18:00:22 +020049 Note: If you want PDF, there are tools such as
50 "ps2pdf" that can convert the PostScript to PDF.
Bram Moolenaar8299df92004-07-10 09:47:34 +000051
52:[range]ha[rdcopy][!] >{filename}
53 As above, but write the resulting PostScript in file
54 {filename}.
55 Things like "%" are expanded |cmdline-special|
56 Careful: An existing file is silently overwritten.
57 {only available when compiled with the |+postscript|
58 feature}
59 On MS-Windows use the "print to file" feature of the
60 printer driver.
61
62Progress is displayed during printing as a page number and a percentage. To
63abort printing use the interrupt key (CTRL-C or, on MS-systems, CTRL-Break).
64
65Printer output is controlled by the 'printfont' and 'printoptions' options.
66'printheader' specifies the format of a page header.
67
68The printed file is always limited to the selected margins, irrespective of
69the current window's 'wrap' or 'linebreak' settings. The "wrap" item in
70'printoptions' can be used to switch wrapping off.
71The current highlighting colors are used in the printout, with the following
72considerations:
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000731) The normal background is always rendered as white (i.e. blank paper).
Bram Moolenaar8299df92004-07-10 09:47:34 +0000742) White text or the default foreground is rendered as black, so that it shows
75 up!
763) If 'background' is "dark", then the colours are darkened to compensate for
77 the fact that otherwise they would be too bright to show up clearly on
78 white paper.
79
80==============================================================================
812. Print options *print-options*
82
83Here are the details for the options that change the way printing is done.
84For generic info about setting options see |options.txt|.
85
86 *pdev-option*
87'printdevice' 'pdev' string (default empty)
88 global
89This defines the name of the printer to be used when the |:hardcopy| command
90is issued with a bang (!) to skip the printer selection dialog. On Win32, it
91should be the printer name exactly as it appears in the standard printer
92dialog.
93If the option is empty, then vim will use the system default printer for
94":hardcopy!"
95
96 *penc-option* *E620*
97'printencoding' 'penc' String (default empty, except for:
98 Windows, OS/2: cp1252,
99 Macintosh: mac-roman,
100 VMS: dec-mcs,
101 HPUX: hp-roman8,
102 EBCDIC: ebcdic-uk)
103 global
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200104Sets the character encoding used when printing. This option tells Vim which
Bram Moolenaar8299df92004-07-10 09:47:34 +0000105print character encoding file from the "print" directory in 'runtimepath' to
106use.
107
108This option will accept any value from |encoding-names|. Any recognized names
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200109are converted to Vim standard names - see 'encoding' for more details. Names
110not recognized by Vim will just be converted to lower case and underscores
Bram Moolenaar8299df92004-07-10 09:47:34 +0000111replaced with '-' signs.
112
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200113If 'printencoding' is empty or Vim cannot find the file then it will use
114'encoding' (if Vim is compiled with |+multi_byte| and it is set an 8-bit
115encoding) to find the print character encoding file. If Vim is unable to find
Bram Moolenaar8299df92004-07-10 09:47:34 +0000116a character encoding file then it will use the "latin1" print character
117encoding file.
118
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200119When 'encoding' is set to a multi-byte encoding, Vim will try to convert
Bram Moolenaar8299df92004-07-10 09:47:34 +0000120characters to the printing encoding for printing (if 'printencoding' is empty
121then the conversion will be to latin1). Conversion to a printing encoding
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200122other than latin1 will require Vim to be compiled with the |+iconv| feature.
Bram Moolenaar8299df92004-07-10 09:47:34 +0000123If no conversion is possible then printing will fail. Any characters that
124cannot be converted will be replaced with upside down question marks.
125
126Four print character encoding files are provided to support default Mac, VMS,
127HPUX, and EBCDIC character encodings and are used by default on these
128platforms. Code page 1252 print character encoding is used by default on
129Windows and OS/2 platforms.
130
131 *pexpr-option*
132'printexpr' 'pexpr' String (default: see below)
133 global
134Expression that is evaluated to print the PostScript produced with
135|:hardcopy|.
136The file name to be printed is in |v:fname_in|.
137The arguments to the ":hardcopy" command are in |v:cmdarg|.
138The expression must take care of deleting the file after printing it.
139When there is an error, the expression must return a non-zero number.
140If there is no error, return zero or an empty string.
141The default for non MS-Windows or VMS systems is to simply use "lpr" to print
142the file: >
143
144 system('lpr' . (&printdevice == '' ? '' : ' -P' . &printdevice)
145 . ' ' . v:fname_in) . delete(v:fname_in) + v:shell_error
146
147On MS-Dos, MS-Windows and OS/2 machines the default is to copy the file to the
148currently specified printdevice: >
149
150 system('copy' . ' ' . v:fname_in . (&printdevice == ''
151 ? ' LPT1:' : (' \"' . &printdevice . '\"')))
152 . delete(v:fname_in)
153
154On VMS machines the default is to send the file to either the default or
155currently specified printdevice: >
156
157 system('print' . (&printdevice == '' ? '' : ' /queue=' .
158 &printdevice) . ' ' . v:fname_in) . delete(v:fname_in)
159
160If you change this option, using a function is an easy way to avoid having to
161escape all the spaces. Example: >
162
163 :set printexpr=PrintFile(v:fname_in)
164 :function PrintFile(fname)
165 : call system("ghostview " . a:fname)
166 : call delete(a:fname)
167 : return v:shell_error
168 :endfunc
169
170Be aware that some print programs return control before they have read the
171file. If you delete the file too soon it will not be printed. These programs
172usually offer an option to have them remove the file when printing is done.
173 *E365*
174If evaluating the expression fails or it results in a non-zero number, you get
175an error message. In that case Vim will delete the file. In the default
176value for non-MS-Windows a trick is used: Adding "v:shell_error" will result
177in a non-zero number when the system() call fails.
178
179This option cannot be set from a |modeline| or in the |sandbox|, for security
180reasons.
181
182 *pfn-option* *E613*
183'printfont' 'pfn' string (default "courier")
184 global
185This is the name of the font that will be used for the |:hardcopy| command's
186output. It has the same format as the 'guifont' option, except that only one
187font may be named, and the special "guifont=*" syntax is not available.
188
189In the Win32 GUI version this specifies a font name with its extra attributes,
190as with the 'guifont' option.
191
192For other systems, only ":h11" is recognized, where "11" is the point size of
193the font. When omitted, the point size is 10.
194
195 *pheader-option*
196'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
197 global
198This defines the format of the header produced in |:hardcopy| output. The
199option is defined in the same way as the 'statusline' option. If Vim has not
200been compiled with the |+statusline| feature, this option has no effect and a
Bram Moolenaara7241f52008-06-24 20:39:31 +0000201simple default header is used, which shows the page number. The same simple
202header is used when this option is empty.
Bram Moolenaar8299df92004-07-10 09:47:34 +0000203
204 *pmbcs-option*
205'printmbcharset' 'pmbcs' string (default "")
206 global
207Sets the CJK character set to be used when generating CJK output from
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200208|:hardcopy|. The following predefined values are currently recognised by Vim:
Bram Moolenaar8299df92004-07-10 09:47:34 +0000209
210 Value Description ~
211 Chinese GB_2312-80
212 (Simplified) GBT_12345-90
213 MAC Apple Mac Simplified Chinese
214 GBT-90_MAC GB/T 12345-90 Apple Mac Simplified
215 Chinese
216 GBK GBK (GB 13000.1-93)
217 ISO10646 ISO 10646-1:1993
218
219 Chinese CNS_1993 CNS 11643-1993, Planes 1 & 2
220 (Traditional) BIG5
221 ETEN Big5 with ETen extensions
222 ISO10646 ISO 10646-1:1993
223
224 Japanese JIS_C_1978
225 JIS_X_1983
226 JIS_X_1990
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000227 MSWINDOWS Win3.1/95J (JIS X 1997 + NEC +
Bram Moolenaar8299df92004-07-10 09:47:34 +0000228 IBM extensions)
229 KANJITALK6 Apple Mac KanjiTalk V6.x
230 KANJITALK7 Apple Mac KanjiTalk V7.x
231
232 Korean KS_X_1992
233 MAC Apple Macintosh Korean
234 MSWINDOWS KS X 1992 with MS extensions
235 ISO10646 ISO 10646-1:1993
236
237Only certain combinations of the above values and 'printencoding' are
238possible. The following tables show the valid combinations:
239
240 euc-cn gbk ucs-2 utf-8 ~
241 Chinese GB_2312-80 x
242 (Simplified) GBT_12345-90 x
243 MAC x
244 GBT-90_MAC x
245 GBK x
246 ISO10646 x x
247
248 euc-tw big5 ucs-2 utf-8 ~
249 Chinese CNS_1993 x
250 (Traditional) BIG5 x
251 ETEN x
252 ISO10646 x x
253
254 euc-jp sjis ucs-2 utf-8 ~
255 Japanese JIS_C_1978 x x
256 JIS_X_1983 x x
257 JIS_X_1990 x x x
258 MSWINDOWS x
259 KANJITALK6 x
260 KANJITALK7 x
261
262 euc-kr cp949 ucs-2 utf-8 ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000263 Korean KS_X_1992 x
Bram Moolenaar8299df92004-07-10 09:47:34 +0000264 MAC x
265 MSWINDOWS x
266 ISO10646 x x
267
268To set up the correct encoding and character set for printing some
269Japanese text you would do the following; >
270 :set printencoding=euc-jp
271 :set printmbcharset=JIS_X_1983
272
273If 'printmbcharset' is not one of the above values then it is assumed to
274specify a custom multi-byte character set and no check will be made that it is
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200275compatible with the value for 'printencoding'. Vim will look for a file
Bram Moolenaar8299df92004-07-10 09:47:34 +0000276defining the character set in the "print" directory in 'runtimepath'.
277
278 *pmbfn-option*
279'printmbfont' 'pmbfn' string (default "")
280 global
281This is a comma-separated list of fields for font names to be used when
282generating CJK output from |:hardcopy|. Each font name has to be preceded
283with a letter indicating the style the font is to be used for as follows:
284
285 r:{font-name} font to use for normal characters
286 b:{font-name} font to use for bold characters
287 i:{font-name} font to use for italic characters
288 o:{font-name} font to use for bold-italic characters
289
290A field with the r: prefix must be specified when doing CJK printing. The
291other fontname specifiers are optional. If a specifier is missing then
292another font will be used as follows:
293
294 if b: is missing, then use r:
295 if i: is missing, then use r:
Bram Moolenaar57657d82006-04-21 22:12:41 +0000296 if o: is missing, then use b:
Bram Moolenaar8299df92004-07-10 09:47:34 +0000297
298Some CJK fonts do not contain characters for codes in the ASCII code range.
299Also, some characters in the CJK ASCII code ranges differ in a few code points
300from traditional ASCII characters. There are two additional fields to control
301printing of characters in the ASCII code range.
302
303 c:yes Use Courier font for characters in the ASCII
304 c:no (default) code range.
305
306 a:yes Use ASCII character set for codes in the ASCII
307 a:no (default) code range.
308
309The following is an example of specifying two multi-byte fonts, one for normal
310and italic printing and one for bold and bold-italic printing, and using
311Courier to print codes in the ASCII code range but using the national
312character set: >
313 :set printmbfont=r:WadaMin-Regular,b:WadaMin-Bold,c:yes
314<
315 *popt-option*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000316'printoptions' 'popt' string (default "")
Bram Moolenaar8299df92004-07-10 09:47:34 +0000317 global
318This is a comma-separated list of items that control the format of the output
319of |:hardcopy|:
320
321 left:{spec} left margin (default: 10pc)
322 right:{spec} right margin (default: 5pc)
323 top:{spec} top margin (default: 5pc)
324 bottom:{spec} bottom margin (default: 5pc)
325 {spec} is a number followed by "in" for inches, "pt"
326 for points (1 point is 1/72 of an inch), "mm" for
327 millimeters or "pc" for a percentage of the media
328 size.
329 Weird example:
330 left:2in,top:30pt,right:16mm,bottom:3pc
331 If the unit is not recognized there is no error and
332 the default value is used.
333
334 header:{nr} Number of lines to reserve for the header.
335 Only the first line is actually filled, thus when {nr}
336 is 2 there is one empty line. The header is formatted
337 according to 'printheader'.
338 header:0 Do not print a header.
339 header:2 (default) Use two lines for the header
340
341 syntax:n Do not use syntax highlighting. This is faster and
342 thus useful when printing large files.
343 syntax:y Do syntax highlighting.
344 syntax:a (default) Use syntax highlighting if the printer appears to be
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000345 able to print color or grey.
Bram Moolenaar8299df92004-07-10 09:47:34 +0000346
347 number:y Include line numbers in the printed output.
348 number:n (default) No line numbers.
349
350 wrap:y (default) Wrap long lines.
351 wrap:n Truncate long lines.
352
353 duplex:off Print on one side.
354 duplex:long (default) Print on both sides (when possible), bind on long
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000355 side.
Bram Moolenaar8299df92004-07-10 09:47:34 +0000356 duplex:short Print on both sides (when possible), bind on short
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000357 side.
Bram Moolenaar8299df92004-07-10 09:47:34 +0000358
359 collate:y (default) Collating: 1 2 3, 1 2 3, 1 2 3
360 collate:n No collating: 1 1 1, 2 2 2, 3 3 3
361
362 jobsplit:n (default) Do all copies in one print job
363 jobsplit:y Do each copy as a separate print job. Useful when
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000364 doing N-up postprocessing.
Bram Moolenaar8299df92004-07-10 09:47:34 +0000365
366 portrait:y (default) Orientation is portrait.
367 portrait:n Orientation is landscape.
368 *a4* *letter*
369 paper:A4 (default) Paper size: A4
370 paper:{name} Paper size from this table:
371 {name} size in cm size in inch ~
372 10x14 25.4 x 35.57 10 x 14
373 A3 29.7 x 42 11.69 x 16.54
374 A4 21 x 29.7 8.27 x 11.69
375 A5 14.8 x 21 5.83 x 8.27
376 B4 25 x 35.3 10.12 x 14.33
377 B5 17.6 x 25 7.17 x 10.12
378 executive 18.42 x 26.67 7.25 x 10.5
379 folio 21 x 33 8.27 x 13
380 ledger 43.13 x 27.96 17 x 11
381 legal 21.59 x 35.57 8.5 x 14
382 letter 21.59 x 27.96 8.5 x 11
383 quarto 21.59 x 27.5 8.5 x 10.83
384 statement 13.97 x 21.59 5.5 x 8.5
385 tabloid 27.96 x 43.13 11 x 17
386
387 formfeed:n (default) Treat form feed characters (0x0c) as a normal print
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000388 character.
Bram Moolenaar8299df92004-07-10 09:47:34 +0000389 formfeed:y When a form feed character is encountered, continue
390 printing of the current line at the beginning of the
391 first line on a new page.
392
393The item indicated with (default) is used when the item is not present. The
394values are not always used, especially when using a dialog to select the
395printer and options.
396Example: >
397 :set printoptions=paper:letter,duplex:off
398
399==============================================================================
4003. PostScript Printing *postscript-printing*
401 *E455* *E456* *E457* *E624*
402Provided you have enough disk space there should be no problems generating a
403PostScript file. You need to have the runtime files correctly installed (if
404you can find the help files, they probably are).
405
406There are currently a number of limitations with PostScript printing:
407
408- 'printfont' - The font name is ignored (the Courier family is always used -
409 it should be available on all PostScript printers) but the font size is
410 used.
411
412- 'printoptions' - The duplex setting is used when generating PostScript
413 output, but it is up to the printer to take notice of the setting. If the
414 printer does not support duplex printing then it should be silently ignored.
415 Some printers, however, don't print at all.
416
417- 8-bit support - While a number of 8-bit print character encodings are
418 supported it is possible that some characters will not print. Whether a
419 character will print depends on the font in the printer knowing the
420 character. Missing characters will be replaced with an upside down question
421 mark, or a space if that character is also not known by the font. It may be
422 possible to get all the characters in an encoding to print by installing a
423 new version of the Courier font family.
424
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200425- Multi-byte support - Currently Vim will try to convert multi-byte characters
Bram Moolenaar8299df92004-07-10 09:47:34 +0000426 to the 8-bit encoding specified by 'printencoding' (or latin1 if it is
427 empty). Any characters that are not successfully converted are shown as
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200428 unknown characters. Printing will fail if Vim cannot convert the multi-byte
Bram Moolenaar8299df92004-07-10 09:47:34 +0000429 to the 8-bit encoding.
430
431==============================================================================
4324. Custom 8-bit Print Character Encodings *postscript-print-encoding*
433 *E618* *E619*
434To use your own print character encoding when printing 8-bit character data
435you need to define your own PostScript font encoding vector. Details on how
Bram Moolenaar9964e462007-05-05 17:54:07 +0000436to define a font encoding vector is beyond the scope of this help file, but
Bram Moolenaar8299df92004-07-10 09:47:34 +0000437you can find details in the PostScript Language Reference Manual, 3rd Edition,
438published by Addison-Wesley and available in PDF form at
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200439http://www.adobe.com/. The following describes what you need to do for Vim to
Bram Moolenaar8299df92004-07-10 09:47:34 +0000440locate and use your print character encoding.
441
442i. Decide on a unique name for your encoding vector, one that does not clash
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200443 with any of the recognized or standard encoding names that Vim uses (see
Bram Moolenaar8299df92004-07-10 09:47:34 +0000444 |encoding-names| for a list), and that no one else is likely to use.
445ii. Copy $VIMRUNTIME/print/latin1.ps to the print subdirectory in your
446 'runtimepath' and rename it with your unique name.
447iii. Edit your renamed copy of latin1.ps, replacing all occurrences of latin1
448 with your unique name (don't forget the line starting %%Title:), and
449 modify the array of glyph names to define your new encoding vector. The
450 array must have exactly 256 entries or you will not be able to print!
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200451iv. Within Vim, set 'printencoding' to your unique encoding name and then
452 print your file. Vim will now use your custom print character encoding.
Bram Moolenaar8299df92004-07-10 09:47:34 +0000453
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200454Vim will report an error with the resource file if you change the order or
Bram Moolenaar8299df92004-07-10 09:47:34 +0000455content of the first 3 lines, other than the name of the encoding on the line
456starting %%Title: or the version number on the line starting %%Version:.
457
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200458[Technical explanation for those that know PostScript - Vim looks for a file
Bram Moolenaar8299df92004-07-10 09:47:34 +0000459with the same name as the encoding it will use when printing. The file
460defines a new PostScript Encoding resource called /VIM-name, where name is the
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200461print character encoding Vim will use.]
Bram Moolenaar8299df92004-07-10 09:47:34 +0000462
463==============================================================================
4645. PostScript CJK Printing *postscript-cjk-printing*
465 *E673* *E674* *E675*
466
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200467Vim supports printing of Chinese, Japanese, and Korean files. Setting up Vim
Bram Moolenaar8299df92004-07-10 09:47:34 +0000468to correctly print CJK files requires setting up a few more options.
469
470Each of these countries has many standard character sets and encodings which
471require that both be specified when printing. In addition, CJK fonts normally
472do not have the concept of italic glyphs and use different weight or stroke
473style to achieve emphasis when printing. This in turn requires a different
474approach to specifying fonts to use when printing.
475
476The encoding and character set are specified with the 'printencoding' and
477'printmbcharset' options. If 'printencoding' is not specified then 'encoding'
478is used as normal. If 'printencoding' is specified then characters will be
479translated to this encoding for printing. You should ensure that the encoding
480is compatible with the character set needed for the file contents or some
481characters may not appear when printed.
482
483The fonts to use for CJK printing are specified with 'printmbfont'. This
484option allows you to specify different fonts to use when printing characters
485which are syntax highlighted with the font styles normal, italic, bold and
486bold-italic.
487
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200488No CJK fonts are supplied with Vim. There are some free Korean, Japanese, and
Bram Moolenaar8299df92004-07-10 09:47:34 +0000489Traditional Chinese fonts available at:
490
491 http://examples.oreilly.com/cjkvinfo/adobe/samples/
492
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000493You can find descriptions of the various fonts in the read me file at
Bram Moolenaar8299df92004-07-10 09:47:34 +0000494
Bram Moolenaara17d4c12010-05-30 18:30:36 +0200495 http://examples.oreilly.de/english_examples/cjkvinfo/adobe/00README
Bram Moolenaar8299df92004-07-10 09:47:34 +0000496
497Please read your printer documentation on how to install new fonts.
498
499CJK fonts can be large containing several thousand glyphs, and it is not
500uncommon to find that they only contain a subset of a national standard. It
501is not unusual to find the fonts to not include characters for codes in the
502ASCII code range. If you find half-width Roman characters are not appearing
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200503in your printout then you should configure Vim to use the Courier font the
Bram Moolenaar8299df92004-07-10 09:47:34 +0000504half-width ASCII characters with 'printmbfont'. If your font does not include
505other characters then you will need to find another font that does.
506
507Another issue with ASCII characters, is that the various national character
508sets specify a couple of different glyphs in the ASCII code range. If you
509print ASCII text using the national character set you may see some unexpected
510characters. If you want true ASCII code printing then you need to configure
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200511Vim to output ASCII characters for the ASCII code range with 'printmbfont'.
Bram Moolenaar8299df92004-07-10 09:47:34 +0000512
513It is possible to define your own multi-byte character set although this
514should not be attempted lightly. A discussion on the process if beyond the
515scope of these help files. You can find details on CMap (character map) files
516in the document 'Adobe CMap and CIDFont Files Specification, Version 1.0',
517available from http://www.adobe.com as a PDF file.
518
519==============================================================================
5206. PostScript Printing Troubleshooting *postscript-print-trouble*
521 *E621*
522Usually the only sign of a problem when printing with PostScript is that your
523printout does not appear. If you are lucky you may get a printed page that
524tells you the PostScript operator that generated the error that prevented the
525print job completing.
526
527There are a number of possible causes as to why the printing may have failed:
528
529- Wrong version of the prolog resource file. The prolog resource file
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200530 contains some PostScript that Vim needs to be able to print. Each version
531 of Vim needs one particular version. Make sure you have correctly installed
Bram Moolenaar8299df92004-07-10 09:47:34 +0000532 the runtime files, and don't have any old versions of a file called prolog
533 in the print directory in your 'runtimepath' directory.
534
535- Paper size. Some PostScript printers will abort printing a file if they do
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200536 not support the requested paper size. By default Vim uses A4 paper. Find
Bram Moolenaar8299df92004-07-10 09:47:34 +0000537 out what size paper your printer normally uses and set the appropriate paper
538 size with 'printoptions'. If you cannot find the name of the paper used,
539 measure a sheet and compare it with the table of supported paper sizes listed
540 for 'printoptions', using the paper that is closest in both width AND height.
541 Note: The dimensions of actual paper may vary slightly from the ones listed.
542 If there is no paper listed close enough, then you may want to try psresize
543 from PSUtils, discussed below.
544
545- Two-sided printing (duplex). Normally a PostScript printer that does not
546 support two-sided printing will ignore any request to do it. However, some
547 printers may abort the job altogether. Try printing with duplex turned off.
548 Note: Duplex prints can be achieved manually using PS utils - see below.
549
550- Collated printing. As with Duplex printing, most PostScript printers that
551 do not support collating printouts will ignore a request to do so. Some may
552 not. Try printing with collation turned off.
553
554- Syntax highlighting. Some print management code may prevent the generated
555 PostScript file from being printed on a black and white printer when syntax
556 highlighting is turned on, even if solid black is the only color used. Try
557 printing with syntax highlighting turned off.
558
559A safe printoptions setting to try is: >
560
561 :set printoptions=paper:A4,duplex:off,collate:n,syntax:n
562
563Replace "A4" with the paper size that best matches your printer paper.
564
565==============================================================================
5667. PostScript Utilities *postscript-print-util*
567
5687.1 Ghostscript
569
570Ghostscript is a PostScript and PDF interpreter that can be used to display
571and print on non-PostScript printers PostScript and PDF files. It can also
572generate PDF files from PostScript.
573
574Ghostscript will run on a wide variety of platforms.
575
576There are three available versions:
577
578- AFPL Ghostscript (formerly Aladdin Ghostscript) which is free for
579 non-commercial use. It can be obtained from:
580
581 http://www.cs.wisc.edu/~ghost/
582
583- GNU Ghostscript which is available under the GNU General Public License. It
584 can be obtained from:
585
586 ftp://mirror.cs.wisc.edu/pub/mirrors/ghost/gnu/
587
588- A commercial version for inclusion in commercial products.
589
590Additional information on Ghostscript can also be found at:
591
592 http://www.ghostscript.com/
593
594Support for a number of non PostScript printers is provided in the
595distribution as standard, but if you cannot find support for your printer
596check the Ghostscript site for other printers not included by default.
597
598
5997.2 Ghostscript Previewers.
600
601The interface to Ghostscript is very primitive so a number of graphical front
602ends have been created. These allow easier PostScript file selection,
603previewing at different zoom levels, and printing. Check supplied
604documentation for full details.
605
606X11
607
608- Ghostview. Obtainable from:
609
610 http://www.cs.wisc.edu/~ghost/gv/
611
612- gv. Derived from Ghostview. Obtainable from:
613
614 http://wwwthep.physik.uni-mainz.de/~plass/gv/
615
616 Copies (possibly not the most recent) can be found at:
617
618 http://www.cs.wisc.edu/~ghost/gv/
619
620OpenVMS
621
622- Is apparently supported in the main code now (untested). See:
623
624 http://wwwthep.physik.uni-mainz.de/~plass/gv/
625
626Windows and OS/2
627
628- GSview. Obtainable from:
629
630 http://www.cs.wisc.edu/~ghost/gsview/
631
632DOS
633
634- ps_view. Obtainable from:
635
636 ftp://ftp.pg.gda.pl/pub/TeX/support/ps_view/
637 ftp://ftp.dante.de/tex-archive/support/ps_view/
638
639Linux
640
641- GSview. Linux version of the popular Windows and OS/2 previewer.
642 Obtainable from:
643
644 http://www.cs.wisc.edu/~ghost/gsview/
645
646- BMV. Different from Ghostview and gv in that it doesn't use X but svgalib.
647 Obtainable from:
648
649 ftp://sunsite.unc.edu/pub/Linux/apps/graphics/viewers/svga/bmv-1.2.tgz
650
651
6527.3 PSUtils
653
654PSUtils is a collection of utility programs for manipulating PostScript
655documents. Binary distributions are available for many platforms, as well as
656the full source. PSUtils can be found at:
657
658 http://knackered.org/angus/psutils
659
660The utilities of interest include:
661
662- psnup. Convert PS files for N-up printing.
663- psselect. Select page range and order of printing.
664- psresize. Change the page size.
665- psbook. Reorder and lay out pages ready for making a book.
666
667The output of one program can be used as the input to the next, allowing for
668complex print document creation.
669
670
671N-UP PRINTING
672
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200673The psnup utility takes an existing PostScript file generated from Vim and
Bram Moolenaar8299df92004-07-10 09:47:34 +0000674convert it to an n-up version. The simplest way to create a 2-up printout is
675to first create a PostScript file with: >
676
677 :hardcopy > test.ps
678
679Then on your command line execute: >
680
681 psnup -n 2 test.ps final.ps
682
683Note: You may get warnings from some Ghostscript previewers for files produced
684by psnup - these may safely be ignored.
685
686Finally print the file final.ps to your PostScript printer with your
687platform's print command. (You will need to delete the two PostScript files
688afterwards yourself.) 'printexpr' could be modified to perform this extra
689step before printing.
690
691
692ALTERNATE DUPLEX PRINTING
693
694It is possible to achieve a poor man's version of duplex printing using the PS
695utility psselect. This utility has options -e and -o for printing just the
696even or odd pages of a PS file respectively.
697
Bram Moolenaar8a94d872015-01-25 13:02:57 +0100698First generate a PS file with the 'hardcopy' command, then generate new
Bram Moolenaar8299df92004-07-10 09:47:34 +0000699files with all the odd and even numbered pages with: >
700
701 psselect -o test.ps odd.ps
702 psselect -e test.ps even.ps
703
704Next print odd.ps with your platform's normal print command. Then take the
705print output, turn it over and place it back in the paper feeder. Now print
706even.ps with your platform's print command. All the even pages should now
707appear on the back of the odd pages.
708
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100709There are a couple of points to bear in mind:
Bram Moolenaar8299df92004-07-10 09:47:34 +0000710
7111. Position of the first page. If the first page is on top of the printout
712 when printing the odd pages then you need to reverse the order that the odd
713 pages are printed. This can be done with the -r option to psselect. This
714 will ensure page 2 is printed on the back of page 1.
715 Note: it is better to reverse the odd numbered pages rather than the even
716 numbered in case there are an odd number of pages in the original PS file.
717
7182. Paper flipping. When turning over the paper with the odd pages printed on
719 them you may have to either flip them horizontally (along the long edge) or
720 vertically (along the short edge), as well as possibly rotating them 180
721 degrees. All this depends on the printer - it will be more obvious for
722 desktop ink jets than for small office laser printers where the paper path
723 is hidden from view.
724
725
726==============================================================================
7278. Formfeed Characters *printing-formfeed*
728
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200729By default Vim does not do any special processing of |formfeed| control
730characters. Setting the 'printoptions' formfeed item will make Vim recognize
Bram Moolenaar8299df92004-07-10 09:47:34 +0000731formfeed characters and continue printing the current line at the beginning
732of the first line on a new page. The use of formfeed characters provides
733rudimentary print control but there are certain things to be aware of.
734
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200735Vim will always start printing a line (including a line number if enabled)
Bram Moolenaar8299df92004-07-10 09:47:34 +0000736containing a formfeed character, even if it is the first character on the
737line. This means if a line starting with a formfeed character is the first
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200738line of a page then Vim will print a blank page.
Bram Moolenaar8299df92004-07-10 09:47:34 +0000739
740Since the line number is printed at the start of printing the line containing
741the formfeed character, the remainder of the line printed on the new page
742will not have a line number printed for it (in the same way as the wrapped
743lines of a long line when wrap in 'printoptions' is enabled).
744
745If the formfeed character is the last character on a line, then printing will
746continue on the second line of the new page, not the first. This is due to
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200747Vim processing the end of the line after the formfeed character and moving
Bram Moolenaar8299df92004-07-10 09:47:34 +0000748down a line to continue printing.
749
750Due to the points made above it is recommended that when formfeed character
751processing is enabled, printing of line numbers is disabled, and that form
752feed characters are not the last character on a line. Even then you may need
753to adjust the number of lines before a formfeed character to prevent
754accidental blank pages.
755
756==============================================================================
Bram Moolenaar91f84f62018-07-29 15:07:52 +0200757 vim:tw=78:ts=8:noet:ft=help:norl: