blob: d36f2ce069e07832669ddad1af6e366b8c8d2f28 [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 \
33 ft_sql.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000034 gui.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000035 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 Moolenaar0ba04292010-07-14 23:23:17 +020043 if_lua.txt \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +000044 if_mzsch.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000045 if_ole.txt \
46 if_perl.txt \
47 if_pyth.txt \
48 if_ruby.txt \
49 if_sniff.txt \
50 if_tcl.txt \
51 indent.txt \
52 index.txt \
53 insert.txt \
54 intro.txt \
55 map.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000056 mbyte.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000057 message.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000058 mlang.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000059 motion.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000060 netbeans.txt \
61 options.txt \
62 os_390.txt \
63 os_amiga.txt \
64 os_beos.txt \
65 os_dos.txt \
66 os_mac.txt \
67 os_mint.txt \
68 os_msdos.txt \
69 os_os2.txt \
70 os_qnx.txt \
71 os_risc.txt \
72 os_unix.txt \
73 os_vms.txt \
74 os_win32.txt \
75 pattern.txt \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +000076 pi_getscript.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000077 pi_gzip.txt \
Bram Moolenaare2db6c92015-06-19 18:48:41 +020078 pi_logipat.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 pi_netrw.txt \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000080 pi_paren.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 pi_spec.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +000082 pi_tar.txt \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +000083 pi_vimball.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +000084 pi_zip.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +000085 print.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000086 quickfix.txt \
87 quickref.txt \
88 quotes.txt \
89 recover.txt \
90 remote.txt \
91 repeat.txt \
92 rileft.txt \
93 russian.txt \
94 scroll.txt \
95 sign.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000096 spell.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000097 sponsor.txt \
98 starting.txt \
99 syntax.txt \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000100 tabpage.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101 tagsrch.txt \
102 term.txt \
103 tips.txt \
104 todo.txt \
105 uganda.txt \
106 undo.txt \
107 usr_01.txt \
108 usr_02.txt \
109 usr_03.txt \
110 usr_04.txt \
111 usr_05.txt \
112 usr_06.txt \
113 usr_07.txt \
114 usr_08.txt \
115 usr_09.txt \
116 usr_10.txt \
117 usr_11.txt \
118 usr_12.txt \
119 usr_20.txt \
120 usr_21.txt \
121 usr_22.txt \
122 usr_23.txt \
123 usr_24.txt \
124 usr_25.txt \
125 usr_26.txt \
126 usr_27.txt \
127 usr_28.txt \
128 usr_29.txt \
129 usr_30.txt \
130 usr_31.txt \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000131 usr_32.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132 usr_40.txt \
133 usr_41.txt \
134 usr_42.txt \
135 usr_43.txt \
136 usr_44.txt \
137 usr_45.txt \
138 usr_90.txt \
139 usr_toc.txt \
140 various.txt \
141 version4.txt \
142 version5.txt \
143 version6.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000144 version7.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145 vi_diff.txt \
146 visual.txt \
147 windows.txt \
148 workshop.txt
149
150HTMLS = \
151 arabic.html \
152 autocmd.html \
153 change.html \
Bram Moolenaar3b5f9292016-01-28 22:37:01 +0100154 channel.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155 cmdline.html \
Bram Moolenaare344bea2005-09-01 20:46:49 +0000156 debug.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157 debugger.html \
158 develop.html \
159 diff.html \
160 digraph.html \
161 editing.html \
162 eval.html \
163 farsi.html \
164 filetype.html \
165 fold.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000166 ft_ada.html \
167 ft_sql.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168 gui.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169 gui_w32.html \
170 gui_x11.html \
171 hangulin.html \
172 hebrew.html \
Bram Moolenaarb2c03502010-07-02 20:20:09 +0200173 helphelp.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 howto.html \
175 if_cscop.html \
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200176 if_lua.html \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000177 if_mzsch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178 if_ole.html \
179 if_perl.html \
180 if_pyth.html \
181 if_ruby.html \
182 if_sniff.html \
183 if_tcl.html \
184 indent.html \
185 index.html \
186 insert.html \
187 intro.html \
188 map.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189 mbyte.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000190 message.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191 mlang.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000192 motion.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193 netbeans.html \
194 options.html \
195 os_390.html \
196 os_amiga.html \
197 os_beos.html \
198 os_dos.html \
199 os_mac.html \
200 os_mint.html \
201 os_msdos.html \
202 os_os2.html \
203 os_qnx.html \
204 os_risc.html \
205 os_unix.html \
206 os_vms.html \
207 os_win32.html \
208 pattern.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000209 pi_getscript.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210 pi_gzip.html \
Bram Moolenaare2db6c92015-06-19 18:48:41 +0200211 pi_logipat.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 pi_netrw.html \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000213 pi_paren.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214 pi_spec.html \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000215 pi_tar.html \
216 pi_vimball.html \
217 pi_zip.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000218 print.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219 quickfix.html \
220 quickref.html \
221 quotes.html \
222 recover.html \
223 remote.html \
224 repeat.html \
225 rileft.html \
226 russian.html \
227 scroll.html \
228 sign.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000229 spell.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230 sponsor.html \
231 starting.html \
232 syntax.html \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000233 tabpage.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000234 tagsrch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235 term.html \
236 tips.html \
237 todo.html \
238 uganda.html \
239 undo.html \
240 usr_01.html \
241 usr_02.html \
242 usr_03.html \
243 usr_04.html \
244 usr_05.html \
245 usr_06.html \
246 usr_07.html \
247 usr_08.html \
248 usr_09.html \
249 usr_10.html \
250 usr_11.html \
251 usr_12.html \
252 usr_20.html \
253 usr_21.html \
254 usr_22.html \
255 usr_23.html \
256 usr_24.html \
257 usr_25.html \
258 usr_26.html \
259 usr_27.html \
260 usr_28.html \
261 usr_29.html \
262 usr_30.html \
263 usr_31.html \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000264 usr_32.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265 usr_40.html \
266 usr_41.html \
267 usr_42.html \
268 usr_43.html \
269 usr_44.html \
270 usr_45.html \
271 usr_90.html \
272 usr_toc.html \
273 various.html \
274 version4.html \
275 version5.html \
276 version6.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000277 version7.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000278 vi_diff.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000279 vimindex.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 visual.html \
281 windows.html \
282 workshop.html
283
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000284CONVERTED = \
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000285 vim-fr.UTF-8.1 \
286 evim-fr.UTF-8.1 \
287 vimdiff-fr.UTF-8.1 \
288 vimtutor-fr.UTF-8.1 \
289 xxd-fr.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000290 vim-it.UTF-8.1 \
291 evim-it.UTF-8.1 \
292 vimdiff-it.UTF-8.1 \
293 vimtutor-it.UTF-8.1 \
294 xxd-it.UTF-8.1 \
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000295 vim-pl.UTF-8.1 \
296 evim-pl.UTF-8.1 \
297 vimdiff-pl.UTF-8.1 \
298 vimtutor-pl.UTF-8.1 \
299 xxd-pl.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000300 vim-ru.UTF-8.1 \
301 evim-ru.UTF-8.1 \
302 vimdiff-ru.UTF-8.1 \
303 vimtutor-ru.UTF-8.1 \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000304 xxd-ru.UTF-8.1
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000305
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306.SUFFIXES:
307.SUFFIXES: .c .o .txt .html
308
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000309all: tags vim.man evim.man vimdiff.man vimtutor.man xxd.man $(CONVERTED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
311# Use Vim to generate the tags file. Can only be used when Vim has been
312# compiled and installed. Supports multiple languages.
313vimtags: $(DOCS)
Bram Moolenaar426e5c92008-01-11 20:02:02 +0000314 $(VIMEXE) -u NONE -esX -c "helptags ++t ." -c quit
Bram Moolenaar071d4272004-06-13 20:20:40 +0000315
316# Use "doctags" to generate the tags file. Only works for English!
317tags: doctags $(DOCS)
318 ./doctags $(DOCS) | LANG=C LC_ALL=C sort >tags
319 uniq -d -2 tags
320
321doctags: doctags.c
322 $(CC) doctags.c -o doctags
323
324vim.man: vim.1
325 nroff -man vim.1 | sed -e s/.//g > vim.man
326
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000327evim.man: evim.1
328 nroff -man evim.1 | sed -e s/.//g > evim.man
329
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330vimdiff.man: vimdiff.1
331 nroff -man vimdiff.1 | sed -e s/.//g > vimdiff.man
332
333vimtutor.man: vimtutor.1
334 nroff -man vimtutor.1 | sed -e s/.//g > vimtutor.man
335
336xxd.man: xxd.1
337 nroff -man xxd.1 | sed -e s/.//g > xxd.man
338
339uganda.nsis.txt: uganda.txt
340 sed -e 's/[ ]*\*[-a-zA-Z0-9.]*\*//g' -e 's/vim:tw=78://' \
341 uganda.txt | uniq >uganda.nsis.txt
342
343# Awk version of .txt to .html conversion.
Bram Moolenaarcdda8fe2010-07-21 20:40:27 +0200344html: noerrors tags $(HTMLS)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345 @if test -f errors.log; then more errors.log; fi
346
347noerrors:
348 -rm -f errors.log
349
Bram Moolenaarcdda8fe2010-07-21 20:40:27 +0200350$(HTMLS): tags.ref
351
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352.txt.html:
353 $(AWK) -f makehtml.awk $< >$@
354
Bram Moolenaar371d5402006-03-20 21:47:49 +0000355# index.html is the starting point for HTML, but for the help files it is
356# help.txt. Therefore use vimindex.html for index.txt.
357index.html: help.txt
358 $(AWK) -f makehtml.awk help.txt >index.html
359
360vimindex.html: index.txt
361 $(AWK) -f makehtml.awk index.txt >vimindex.html
362
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363tags.ref tags.html: tags
364 $(AWK) -f maketags.awk tags >tags.html
365
366# Perl version of .txt to .html conversion.
367# There can't be two rules to produce a .html from a .txt file.
368# Just run over all .txt files each time one changes. It's fast anyway.
369perlhtml: tags $(DOCS)
370 ./vim2html.pl tags $(DOCS)
371
372clean:
373 -rm doctags *.html tags.ref
374
375# These files are in the extra archive, skip if not present
376
377arabic.txt:
378 touch arabic.txt
379
380farsi.txt:
381 touch farsi.txt
382
383hebrew.txt:
384 touch hebrew.txt
385
386russian.txt:
387 touch russian.txt
388
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389gui_w32.txt:
390 touch gui_w32.txt
391
392if_ole.txt:
393 touch if_ole.txt
394
395os_390.txt:
396 touch os_390.txt
397
398os_amiga.txt:
399 touch os_amiga.txt
400
401os_beos.txt:
402 touch os_beos.txt
403
404os_dos.txt:
405 touch os_dos.txt
406
407os_mac.txt:
408 touch os_mac.txt
409
410os_mint.txt:
411 touch os_mint.txt
412
413os_msdos.txt:
414 touch os_msdos.txt
415
416os_os2.txt:
417 touch os_os2.txt
418
419os_qnx.txt:
420 touch os_qnx.txt
421
422os_risc.txt:
423 touch os_risc.txt
424
425os_win32.txt:
426 touch os_win32.txt
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000427
Bram Moolenaarb475fb92006-03-02 22:40:52 +0000428# Note that $< works with GNU make while $> works for BSD make.
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000429# Is there a solution that works for both??
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000430vim-fr.UTF-8.1: vim-fr.1
431 iconv -f latin1 -t utf-8 $< >$@
432
433evim-fr.UTF-8.1: evim-fr.1
434 iconv -f latin1 -t utf-8 $< >$@
435
436vimdiff-fr.UTF-8.1: vimdiff-fr.1
437 iconv -f latin1 -t utf-8 $< >$@
438
439vimtutor-fr.UTF-8.1: vimtutor-fr.1
440 iconv -f latin1 -t utf-8 $< >$@
441
442xxd-fr.UTF-8.1: xxd-fr.1
443 iconv -f latin1 -t utf-8 $< >$@
444
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000445vim-it.UTF-8.1: vim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000446 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000447
448evim-it.UTF-8.1: evim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000449 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000450
451vimdiff-it.UTF-8.1: vimdiff-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000452 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000453
454vimtutor-it.UTF-8.1: vimtutor-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000455 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000456
457xxd-it.UTF-8.1: xxd-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000458 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000459
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000460vim-pl.UTF-8.1: vim-pl.1
461 iconv -f latin2 -t utf-8 $< >$@
462
463evim-pl.UTF-8.1: evim-pl.1
464 iconv -f latin2 -t utf-8 $< >$@
465
466vimdiff-pl.UTF-8.1: vimdiff-pl.1
467 iconv -f latin2 -t utf-8 $< >$@
468
469vimtutor-pl.UTF-8.1: vimtutor-pl.1
470 iconv -f latin2 -t utf-8 $< >$@
471
472xxd-pl.UTF-8.1: xxd-pl.1
473 iconv -f latin2 -t utf-8 $< >$@
474
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000475vim-ru.UTF-8.1: vim-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
478evim-ru.UTF-8.1: evim-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
481vimdiff-ru.UTF-8.1: vimdiff-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
484vimtutor-ru.UTF-8.1: vimtutor-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000485 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000486
487xxd-ru.UTF-8.1: xxd-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000488 iconv -f KOI8-R -t utf-8 $< >$@