blob: 7dbb2bae1a3c0107f4686d0d33f015e987687585 [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 \
Bram Moolenaar3b5f9292016-01-28 22:37:01 +010020 channel.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000021 cmdline.txt \
Bram Moolenaare344bea2005-09-01 20:46:49 +000022 debug.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000023 debugger.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000024 develop.txt \
25 diff.txt \
26 digraph.txt \
27 editing.txt \
28 eval.txt \
29 farsi.txt \
30 filetype.txt \
31 fold.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000032 ft_ada.txt \
Bram Moolenaar3c2881d2017-03-21 19:18:29 +010033 ft_rust.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000034 ft_sql.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000035 gui.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000036 gui_w32.txt \
37 gui_x11.txt \
38 hangulin.txt \
39 hebrew.txt \
40 help.txt \
Bram Moolenaar91604412010-06-03 20:25:18 +020041 helphelp.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 howto.txt \
43 if_cscop.txt \
Bram Moolenaar0ba04292010-07-14 23:23:17 +020044 if_lua.txt \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +000045 if_mzsch.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000046 if_ole.txt \
47 if_perl.txt \
48 if_pyth.txt \
49 if_ruby.txt \
50 if_sniff.txt \
51 if_tcl.txt \
52 indent.txt \
53 index.txt \
54 insert.txt \
55 intro.txt \
56 map.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000057 mbyte.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000058 message.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 mlang.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000060 motion.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000061 netbeans.txt \
62 options.txt \
63 os_390.txt \
64 os_amiga.txt \
65 os_beos.txt \
66 os_dos.txt \
67 os_mac.txt \
68 os_mint.txt \
69 os_msdos.txt \
70 os_os2.txt \
71 os_qnx.txt \
72 os_risc.txt \
73 os_unix.txt \
74 os_vms.txt \
75 os_win32.txt \
76 pattern.txt \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +000077 pi_getscript.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 pi_gzip.txt \
Bram Moolenaare2db6c92015-06-19 18:48:41 +020079 pi_logipat.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000080 pi_netrw.txt \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000081 pi_paren.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000082 pi_spec.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +000083 pi_tar.txt \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +000084 pi_vimball.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +000085 pi_zip.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +000086 print.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 quickfix.txt \
88 quickref.txt \
89 quotes.txt \
90 recover.txt \
91 remote.txt \
92 repeat.txt \
93 rileft.txt \
94 russian.txt \
95 scroll.txt \
96 sign.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000097 spell.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000098 sponsor.txt \
99 starting.txt \
100 syntax.txt \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000101 tabpage.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102 tagsrch.txt \
103 term.txt \
Bram Moolenaare4f25e42017-07-07 11:54:15 +0200104 terminal.txt \
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100105 textprop.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 tips.txt \
107 todo.txt \
108 uganda.txt \
109 undo.txt \
110 usr_01.txt \
111 usr_02.txt \
112 usr_03.txt \
113 usr_04.txt \
114 usr_05.txt \
115 usr_06.txt \
116 usr_07.txt \
117 usr_08.txt \
118 usr_09.txt \
119 usr_10.txt \
120 usr_11.txt \
121 usr_12.txt \
122 usr_20.txt \
123 usr_21.txt \
124 usr_22.txt \
125 usr_23.txt \
126 usr_24.txt \
127 usr_25.txt \
128 usr_26.txt \
129 usr_27.txt \
130 usr_28.txt \
131 usr_29.txt \
132 usr_30.txt \
133 usr_31.txt \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000134 usr_32.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135 usr_40.txt \
136 usr_41.txt \
137 usr_42.txt \
138 usr_43.txt \
139 usr_44.txt \
140 usr_45.txt \
141 usr_90.txt \
142 usr_toc.txt \
143 various.txt \
144 version4.txt \
145 version5.txt \
146 version6.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000147 version7.txt \
Bram Moolenaar03413f42016-04-12 21:07:15 +0200148 version8.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149 vi_diff.txt \
150 visual.txt \
151 windows.txt \
152 workshop.txt
153
154HTMLS = \
155 arabic.html \
156 autocmd.html \
157 change.html \
Bram Moolenaar3b5f9292016-01-28 22:37:01 +0100158 channel.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 cmdline.html \
Bram Moolenaare344bea2005-09-01 20:46:49 +0000160 debug.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161 debugger.html \
162 develop.html \
163 diff.html \
164 digraph.html \
165 editing.html \
166 eval.html \
167 farsi.html \
168 filetype.html \
169 fold.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000170 ft_ada.html \
Bram Moolenaar3c2881d2017-03-21 19:18:29 +0100171 ft_rust.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000172 ft_sql.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173 gui.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 gui_w32.html \
175 gui_x11.html \
176 hangulin.html \
177 hebrew.html \
Bram Moolenaarb2c03502010-07-02 20:20:09 +0200178 helphelp.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179 howto.html \
180 if_cscop.html \
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200181 if_lua.html \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000182 if_mzsch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183 if_ole.html \
184 if_perl.html \
185 if_pyth.html \
186 if_ruby.html \
187 if_sniff.html \
188 if_tcl.html \
189 indent.html \
190 index.html \
191 insert.html \
192 intro.html \
193 map.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194 mbyte.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000195 message.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196 mlang.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000197 motion.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198 netbeans.html \
199 options.html \
200 os_390.html \
201 os_amiga.html \
202 os_beos.html \
203 os_dos.html \
204 os_mac.html \
205 os_mint.html \
206 os_msdos.html \
207 os_os2.html \
208 os_qnx.html \
209 os_risc.html \
210 os_unix.html \
211 os_vms.html \
212 os_win32.html \
213 pattern.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000214 pi_getscript.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215 pi_gzip.html \
Bram Moolenaare2db6c92015-06-19 18:48:41 +0200216 pi_logipat.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217 pi_netrw.html \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000218 pi_paren.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219 pi_spec.html \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000220 pi_tar.html \
221 pi_vimball.html \
222 pi_zip.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000223 print.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224 quickfix.html \
225 quickref.html \
226 quotes.html \
227 recover.html \
228 remote.html \
229 repeat.html \
230 rileft.html \
231 russian.html \
232 scroll.html \
233 sign.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000234 spell.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235 sponsor.html \
236 starting.html \
237 syntax.html \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000238 tabpage.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000239 tagsrch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240 term.html \
Bram Moolenaare4f25e42017-07-07 11:54:15 +0200241 terminal.html \
Bram Moolenaar98aefe72018-12-13 22:20:09 +0100242 textprop.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000243 tips.html \
244 todo.html \
245 uganda.html \
246 undo.html \
247 usr_01.html \
248 usr_02.html \
249 usr_03.html \
250 usr_04.html \
251 usr_05.html \
252 usr_06.html \
253 usr_07.html \
254 usr_08.html \
255 usr_09.html \
256 usr_10.html \
257 usr_11.html \
258 usr_12.html \
259 usr_20.html \
260 usr_21.html \
261 usr_22.html \
262 usr_23.html \
263 usr_24.html \
264 usr_25.html \
265 usr_26.html \
266 usr_27.html \
267 usr_28.html \
268 usr_29.html \
269 usr_30.html \
270 usr_31.html \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000271 usr_32.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272 usr_40.html \
273 usr_41.html \
274 usr_42.html \
275 usr_43.html \
276 usr_44.html \
277 usr_45.html \
278 usr_90.html \
279 usr_toc.html \
280 various.html \
281 version4.html \
282 version5.html \
283 version6.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000284 version7.html \
Bram Moolenaar03413f42016-04-12 21:07:15 +0200285 version8.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000286 vi_diff.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000287 vimindex.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288 visual.html \
289 windows.html \
290 workshop.html
291
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000292CONVERTED = \
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000293 vim-fr.UTF-8.1 \
294 evim-fr.UTF-8.1 \
295 vimdiff-fr.UTF-8.1 \
296 vimtutor-fr.UTF-8.1 \
297 xxd-fr.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000298 vim-it.UTF-8.1 \
299 evim-it.UTF-8.1 \
300 vimdiff-it.UTF-8.1 \
301 vimtutor-it.UTF-8.1 \
302 xxd-it.UTF-8.1 \
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000303 vim-pl.UTF-8.1 \
304 evim-pl.UTF-8.1 \
305 vimdiff-pl.UTF-8.1 \
306 vimtutor-pl.UTF-8.1 \
307 xxd-pl.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000308 vim-ru.UTF-8.1 \
309 evim-ru.UTF-8.1 \
310 vimdiff-ru.UTF-8.1 \
311 vimtutor-ru.UTF-8.1 \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000312 xxd-ru.UTF-8.1
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000313
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314.SUFFIXES:
315.SUFFIXES: .c .o .txt .html
316
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000317all: tags vim.man evim.man vimdiff.man vimtutor.man xxd.man $(CONVERTED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318
319# Use Vim to generate the tags file. Can only be used when Vim has been
320# compiled and installed. Supports multiple languages.
321vimtags: $(DOCS)
Bram Moolenaar426e5c92008-01-11 20:02:02 +0000322 $(VIMEXE) -u NONE -esX -c "helptags ++t ." -c quit
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324# Use "doctags" to generate the tags file. Only works for English!
325tags: doctags $(DOCS)
326 ./doctags $(DOCS) | LANG=C LC_ALL=C sort >tags
327 uniq -d -2 tags
328
329doctags: doctags.c
330 $(CC) doctags.c -o doctags
331
332vim.man: vim.1
333 nroff -man vim.1 | sed -e s/.//g > vim.man
334
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000335evim.man: evim.1
336 nroff -man evim.1 | sed -e s/.//g > evim.man
337
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338vimdiff.man: vimdiff.1
339 nroff -man vimdiff.1 | sed -e s/.//g > vimdiff.man
340
341vimtutor.man: vimtutor.1
342 nroff -man vimtutor.1 | sed -e s/.//g > vimtutor.man
343
344xxd.man: xxd.1
345 nroff -man xxd.1 | sed -e s/.//g > xxd.man
346
347uganda.nsis.txt: uganda.txt
Bram Moolenaar7cb769a2017-11-16 17:36:02 +0100348 sed -e 's/[ ]*\*[-a-zA-Z0-9.]*\*//g' -e 's/vim:tw=78:.*//' \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349 uganda.txt | uniq >uganda.nsis.txt
350
351# Awk version of .txt to .html conversion.
Bram Moolenaarcdda8fe2010-07-21 20:40:27 +0200352html: noerrors tags $(HTMLS)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353 @if test -f errors.log; then more errors.log; fi
354
355noerrors:
356 -rm -f errors.log
357
Bram Moolenaarcdda8fe2010-07-21 20:40:27 +0200358$(HTMLS): tags.ref
359
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360.txt.html:
361 $(AWK) -f makehtml.awk $< >$@
362
Bram Moolenaar371d5402006-03-20 21:47:49 +0000363# index.html is the starting point for HTML, but for the help files it is
364# help.txt. Therefore use vimindex.html for index.txt.
365index.html: help.txt
366 $(AWK) -f makehtml.awk help.txt >index.html
367
368vimindex.html: index.txt
369 $(AWK) -f makehtml.awk index.txt >vimindex.html
370
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371tags.ref tags.html: tags
372 $(AWK) -f maketags.awk tags >tags.html
373
374# Perl version of .txt to .html conversion.
375# There can't be two rules to produce a .html from a .txt file.
376# Just run over all .txt files each time one changes. It's fast anyway.
377perlhtml: tags $(DOCS)
378 ./vim2html.pl tags $(DOCS)
379
Bram Moolenaar2f058492017-11-30 20:27:52 +0100380# Check URLs in the help with "curl".
381test_urls:
382 vim -S test_urls.vim
383
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384clean:
385 -rm doctags *.html tags.ref
386
387# These files are in the extra archive, skip if not present
388
389arabic.txt:
390 touch arabic.txt
391
392farsi.txt:
393 touch farsi.txt
394
395hebrew.txt:
396 touch hebrew.txt
397
398russian.txt:
399 touch russian.txt
400
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401gui_w32.txt:
402 touch gui_w32.txt
403
404if_ole.txt:
405 touch if_ole.txt
406
407os_390.txt:
408 touch os_390.txt
409
410os_amiga.txt:
411 touch os_amiga.txt
412
413os_beos.txt:
414 touch os_beos.txt
415
416os_dos.txt:
417 touch os_dos.txt
418
419os_mac.txt:
420 touch os_mac.txt
421
422os_mint.txt:
423 touch os_mint.txt
424
425os_msdos.txt:
426 touch os_msdos.txt
427
428os_os2.txt:
429 touch os_os2.txt
430
431os_qnx.txt:
432 touch os_qnx.txt
433
434os_risc.txt:
435 touch os_risc.txt
436
437os_win32.txt:
438 touch os_win32.txt
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000439
Bram Moolenaarb475fb92006-03-02 22:40:52 +0000440# Note that $< works with GNU make while $> works for BSD make.
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000441# Is there a solution that works for both??
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000442vim-fr.UTF-8.1: vim-fr.1
443 iconv -f latin1 -t utf-8 $< >$@
444
445evim-fr.UTF-8.1: evim-fr.1
446 iconv -f latin1 -t utf-8 $< >$@
447
448vimdiff-fr.UTF-8.1: vimdiff-fr.1
449 iconv -f latin1 -t utf-8 $< >$@
450
451vimtutor-fr.UTF-8.1: vimtutor-fr.1
452 iconv -f latin1 -t utf-8 $< >$@
453
454xxd-fr.UTF-8.1: xxd-fr.1
455 iconv -f latin1 -t utf-8 $< >$@
456
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000457vim-it.UTF-8.1: vim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000458 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000459
460evim-it.UTF-8.1: evim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000461 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000462
463vimdiff-it.UTF-8.1: vimdiff-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000464 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000465
466vimtutor-it.UTF-8.1: vimtutor-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000467 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000468
469xxd-it.UTF-8.1: xxd-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000470 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000471
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000472vim-pl.UTF-8.1: vim-pl.1
473 iconv -f latin2 -t utf-8 $< >$@
474
475evim-pl.UTF-8.1: evim-pl.1
476 iconv -f latin2 -t utf-8 $< >$@
477
478vimdiff-pl.UTF-8.1: vimdiff-pl.1
479 iconv -f latin2 -t utf-8 $< >$@
480
481vimtutor-pl.UTF-8.1: vimtutor-pl.1
482 iconv -f latin2 -t utf-8 $< >$@
483
484xxd-pl.UTF-8.1: xxd-pl.1
485 iconv -f latin2 -t utf-8 $< >$@
486
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000487vim-ru.UTF-8.1: vim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000488 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000489
490evim-ru.UTF-8.1: evim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000491 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000492
493vimdiff-ru.UTF-8.1: vimdiff-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000494 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000495
496vimtutor-ru.UTF-8.1: vimtutor-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000497 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000498
499xxd-ru.UTF-8.1: xxd-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000500 iconv -f KOI8-R -t utf-8 $< >$@