blob: a8a6410d5338fd8a80cbb22d8e2e267ba1b38fd4 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001#
2# Makefile for the Vim documentation on Unix
3#
4# If you get "don't know how to make scratch", first run make in the source
5# directory. Or remove the include below.
6
7AWK = awk
8
9# Set to $(VIMTARGET) when executed from src/Makefile.
10VIMEXE = vim
11
12# include the config.mk from the source directory. It's only needed to set
13# AWK, used for "make html". Comment this out if the include gives problems.
14include ../../src/auto/config.mk
15
16DOCS = \
17 arabic.txt \
18 autocmd.txt \
19 change.txt \
20 cmdline.txt \
Bram Moolenaare344bea2005-09-01 20:46:49 +000021 debug.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000022 debugger.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000023 develop.txt \
24 diff.txt \
25 digraph.txt \
26 editing.txt \
27 eval.txt \
28 farsi.txt \
29 filetype.txt \
30 fold.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000031 ft_ada.txt \
32 ft_sql.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000033 gui.txt \
34 gui_w16.txt \
35 gui_w32.txt \
36 gui_x11.txt \
37 hangulin.txt \
38 hebrew.txt \
39 help.txt \
Bram Moolenaar91604412010-06-03 20:25:18 +020040 helphelp.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000041 howto.txt \
42 if_cscop.txt \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +000043 if_mzsch.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000044 if_ole.txt \
45 if_perl.txt \
46 if_pyth.txt \
47 if_ruby.txt \
48 if_sniff.txt \
49 if_tcl.txt \
50 indent.txt \
51 index.txt \
52 insert.txt \
53 intro.txt \
54 map.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 mbyte.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000056 message.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000057 mlang.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000058 motion.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 netbeans.txt \
60 options.txt \
61 os_390.txt \
62 os_amiga.txt \
63 os_beos.txt \
64 os_dos.txt \
65 os_mac.txt \
66 os_mint.txt \
67 os_msdos.txt \
68 os_os2.txt \
69 os_qnx.txt \
70 os_risc.txt \
71 os_unix.txt \
72 os_vms.txt \
73 os_win32.txt \
74 pattern.txt \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +000075 pi_getscript.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 pi_gzip.txt \
77 pi_netrw.txt \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000078 pi_paren.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 pi_spec.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +000080 pi_tar.txt \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +000081 pi_vimball.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +000082 pi_zip.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +000083 print.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000084 quickfix.txt \
85 quickref.txt \
86 quotes.txt \
87 recover.txt \
88 remote.txt \
89 repeat.txt \
90 rileft.txt \
91 russian.txt \
92 scroll.txt \
93 sign.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000094 spell.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000095 sponsor.txt \
96 starting.txt \
97 syntax.txt \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +000098 tabpage.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000099 tagsrch.txt \
100 term.txt \
101 tips.txt \
102 todo.txt \
103 uganda.txt \
104 undo.txt \
105 usr_01.txt \
106 usr_02.txt \
107 usr_03.txt \
108 usr_04.txt \
109 usr_05.txt \
110 usr_06.txt \
111 usr_07.txt \
112 usr_08.txt \
113 usr_09.txt \
114 usr_10.txt \
115 usr_11.txt \
116 usr_12.txt \
117 usr_20.txt \
118 usr_21.txt \
119 usr_22.txt \
120 usr_23.txt \
121 usr_24.txt \
122 usr_25.txt \
123 usr_26.txt \
124 usr_27.txt \
125 usr_28.txt \
126 usr_29.txt \
127 usr_30.txt \
128 usr_31.txt \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000129 usr_32.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130 usr_40.txt \
131 usr_41.txt \
132 usr_42.txt \
133 usr_43.txt \
134 usr_44.txt \
135 usr_45.txt \
136 usr_90.txt \
137 usr_toc.txt \
138 various.txt \
139 version4.txt \
140 version5.txt \
141 version6.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000142 version7.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143 vi_diff.txt \
144 visual.txt \
145 windows.txt \
146 workshop.txt
147
148HTMLS = \
149 arabic.html \
150 autocmd.html \
151 change.html \
152 cmdline.html \
Bram Moolenaare344bea2005-09-01 20:46:49 +0000153 debug.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154 debugger.html \
155 develop.html \
156 diff.html \
157 digraph.html \
158 editing.html \
159 eval.html \
160 farsi.html \
161 filetype.html \
162 fold.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000163 ft_ada.html \
164 ft_sql.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000165 gui.html \
166 gui_w16.html \
167 gui_w32.html \
168 gui_x11.html \
169 hangulin.html \
170 hebrew.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171 howto.html \
172 if_cscop.html \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173 if_mzsch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 if_ole.html \
175 if_perl.html \
176 if_pyth.html \
177 if_ruby.html \
178 if_sniff.html \
179 if_tcl.html \
180 indent.html \
181 index.html \
182 insert.html \
183 intro.html \
184 map.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185 mbyte.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000186 message.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187 mlang.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000188 motion.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189 netbeans.html \
190 options.html \
191 os_390.html \
192 os_amiga.html \
193 os_beos.html \
194 os_dos.html \
195 os_mac.html \
196 os_mint.html \
197 os_msdos.html \
198 os_os2.html \
199 os_qnx.html \
200 os_risc.html \
201 os_unix.html \
202 os_vms.html \
203 os_win32.html \
204 pattern.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000205 pi_getscript.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 pi_gzip.html \
207 pi_netrw.html \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000208 pi_paren.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000209 pi_spec.html \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000210 pi_tar.html \
211 pi_vimball.html \
212 pi_zip.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000213 print.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214 quickfix.html \
215 quickref.html \
216 quotes.html \
217 recover.html \
218 remote.html \
219 repeat.html \
220 rileft.html \
221 russian.html \
222 scroll.html \
223 sign.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000224 spell.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225 sponsor.html \
226 starting.html \
227 syntax.html \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000228 tabpage.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000229 tags.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000230 tagsrch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 term.html \
232 tips.html \
233 todo.html \
234 uganda.html \
235 undo.html \
236 usr_01.html \
237 usr_02.html \
238 usr_03.html \
239 usr_04.html \
240 usr_05.html \
241 usr_06.html \
242 usr_07.html \
243 usr_08.html \
244 usr_09.html \
245 usr_10.html \
246 usr_11.html \
247 usr_12.html \
248 usr_20.html \
249 usr_21.html \
250 usr_22.html \
251 usr_23.html \
252 usr_24.html \
253 usr_25.html \
254 usr_26.html \
255 usr_27.html \
256 usr_28.html \
257 usr_29.html \
258 usr_30.html \
259 usr_31.html \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000260 usr_32.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261 usr_40.html \
262 usr_41.html \
263 usr_42.html \
264 usr_43.html \
265 usr_44.html \
266 usr_45.html \
267 usr_90.html \
268 usr_toc.html \
269 various.html \
270 version4.html \
271 version5.html \
272 version6.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000273 version7.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274 vi_diff.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000275 vimindex.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276 visual.html \
277 windows.html \
278 workshop.html
279
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000280CONVERTED = \
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000281 vim-fr.UTF-8.1 \
282 evim-fr.UTF-8.1 \
283 vimdiff-fr.UTF-8.1 \
284 vimtutor-fr.UTF-8.1 \
285 xxd-fr.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000286 vim-it.UTF-8.1 \
287 evim-it.UTF-8.1 \
288 vimdiff-it.UTF-8.1 \
289 vimtutor-it.UTF-8.1 \
290 xxd-it.UTF-8.1 \
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000291 vim-pl.UTF-8.1 \
292 evim-pl.UTF-8.1 \
293 vimdiff-pl.UTF-8.1 \
294 vimtutor-pl.UTF-8.1 \
295 xxd-pl.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000296 vim-ru.UTF-8.1 \
297 evim-ru.UTF-8.1 \
298 vimdiff-ru.UTF-8.1 \
299 vimtutor-ru.UTF-8.1 \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000300 xxd-ru.UTF-8.1
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000301
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302.SUFFIXES:
303.SUFFIXES: .c .o .txt .html
304
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000305all: tags vim.man evim.man vimdiff.man vimtutor.man xxd.man $(CONVERTED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306
307# Use Vim to generate the tags file. Can only be used when Vim has been
308# compiled and installed. Supports multiple languages.
309vimtags: $(DOCS)
Bram Moolenaar426e5c92008-01-11 20:02:02 +0000310 $(VIMEXE) -u NONE -esX -c "helptags ++t ." -c quit
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311
312# Use "doctags" to generate the tags file. Only works for English!
313tags: doctags $(DOCS)
314 ./doctags $(DOCS) | LANG=C LC_ALL=C sort >tags
315 uniq -d -2 tags
316
317doctags: doctags.c
318 $(CC) doctags.c -o doctags
319
320vim.man: vim.1
321 nroff -man vim.1 | sed -e s/.//g > vim.man
322
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000323evim.man: evim.1
324 nroff -man evim.1 | sed -e s/.//g > evim.man
325
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326vimdiff.man: vimdiff.1
327 nroff -man vimdiff.1 | sed -e s/.//g > vimdiff.man
328
329vimtutor.man: vimtutor.1
330 nroff -man vimtutor.1 | sed -e s/.//g > vimtutor.man
331
332xxd.man: xxd.1
333 nroff -man xxd.1 | sed -e s/.//g > xxd.man
334
335uganda.nsis.txt: uganda.txt
336 sed -e 's/[ ]*\*[-a-zA-Z0-9.]*\*//g' -e 's/vim:tw=78://' \
337 uganda.txt | uniq >uganda.nsis.txt
338
339# Awk version of .txt to .html conversion.
340html: noerrors tags tags.ref $(HTMLS)
341 @if test -f errors.log; then more errors.log; fi
342
343noerrors:
344 -rm -f errors.log
345
346.txt.html:
347 $(AWK) -f makehtml.awk $< >$@
348
Bram Moolenaar371d5402006-03-20 21:47:49 +0000349# index.html is the starting point for HTML, but for the help files it is
350# help.txt. Therefore use vimindex.html for index.txt.
351index.html: help.txt
352 $(AWK) -f makehtml.awk help.txt >index.html
353
354vimindex.html: index.txt
355 $(AWK) -f makehtml.awk index.txt >vimindex.html
356
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357tags.ref tags.html: tags
358 $(AWK) -f maketags.awk tags >tags.html
359
360# Perl version of .txt to .html conversion.
361# There can't be two rules to produce a .html from a .txt file.
362# Just run over all .txt files each time one changes. It's fast anyway.
363perlhtml: tags $(DOCS)
364 ./vim2html.pl tags $(DOCS)
365
366clean:
367 -rm doctags *.html tags.ref
368
369# These files are in the extra archive, skip if not present
370
371arabic.txt:
372 touch arabic.txt
373
374farsi.txt:
375 touch farsi.txt
376
377hebrew.txt:
378 touch hebrew.txt
379
380russian.txt:
381 touch russian.txt
382
383gui_w16.txt:
384 touch gui_w16.txt
385
386gui_w32.txt:
387 touch gui_w32.txt
388
389if_ole.txt:
390 touch if_ole.txt
391
392os_390.txt:
393 touch os_390.txt
394
395os_amiga.txt:
396 touch os_amiga.txt
397
398os_beos.txt:
399 touch os_beos.txt
400
401os_dos.txt:
402 touch os_dos.txt
403
404os_mac.txt:
405 touch os_mac.txt
406
407os_mint.txt:
408 touch os_mint.txt
409
410os_msdos.txt:
411 touch os_msdos.txt
412
413os_os2.txt:
414 touch os_os2.txt
415
416os_qnx.txt:
417 touch os_qnx.txt
418
419os_risc.txt:
420 touch os_risc.txt
421
422os_win32.txt:
423 touch os_win32.txt
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000424
Bram Moolenaarb475fb92006-03-02 22:40:52 +0000425# Note that $< works with GNU make while $> works for BSD make.
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000426# Is there a solution that works for both??
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000427vim-fr.UTF-8.1: vim-fr.1
428 iconv -f latin1 -t utf-8 $< >$@
429
430evim-fr.UTF-8.1: evim-fr.1
431 iconv -f latin1 -t utf-8 $< >$@
432
433vimdiff-fr.UTF-8.1: vimdiff-fr.1
434 iconv -f latin1 -t utf-8 $< >$@
435
436vimtutor-fr.UTF-8.1: vimtutor-fr.1
437 iconv -f latin1 -t utf-8 $< >$@
438
439xxd-fr.UTF-8.1: xxd-fr.1
440 iconv -f latin1 -t utf-8 $< >$@
441
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000442vim-it.UTF-8.1: vim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000443 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000444
445evim-it.UTF-8.1: evim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000446 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000447
448vimdiff-it.UTF-8.1: vimdiff-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000449 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000450
451vimtutor-it.UTF-8.1: vimtutor-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000452 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000453
454xxd-it.UTF-8.1: xxd-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000455 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000456
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000457vim-pl.UTF-8.1: vim-pl.1
458 iconv -f latin2 -t utf-8 $< >$@
459
460evim-pl.UTF-8.1: evim-pl.1
461 iconv -f latin2 -t utf-8 $< >$@
462
463vimdiff-pl.UTF-8.1: vimdiff-pl.1
464 iconv -f latin2 -t utf-8 $< >$@
465
466vimtutor-pl.UTF-8.1: vimtutor-pl.1
467 iconv -f latin2 -t utf-8 $< >$@
468
469xxd-pl.UTF-8.1: xxd-pl.1
470 iconv -f latin2 -t utf-8 $< >$@
471
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000472vim-ru.UTF-8.1: vim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000473 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000474
475evim-ru.UTF-8.1: evim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000476 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000477
478vimdiff-ru.UTF-8.1: vimdiff-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000479 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000480
481vimtutor-ru.UTF-8.1: vimtutor-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000482 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000483
484xxd-ru.UTF-8.1: xxd-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000485 iconv -f KOI8-R -t utf-8 $< >$@