blob: 706894325117710bded56503be366c31dca815d8 [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 Moolenaarb2c03502010-07-02 20:20:09 +0200171 helphelp.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172 howto.html \
173 if_cscop.html \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000174 if_mzsch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175 if_ole.html \
176 if_perl.html \
177 if_pyth.html \
178 if_ruby.html \
179 if_sniff.html \
180 if_tcl.html \
181 indent.html \
182 index.html \
183 insert.html \
184 intro.html \
185 map.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186 mbyte.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000187 message.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188 mlang.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000189 motion.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000190 netbeans.html \
191 options.html \
192 os_390.html \
193 os_amiga.html \
194 os_beos.html \
195 os_dos.html \
196 os_mac.html \
197 os_mint.html \
198 os_msdos.html \
199 os_os2.html \
200 os_qnx.html \
201 os_risc.html \
202 os_unix.html \
203 os_vms.html \
204 os_win32.html \
205 pattern.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000206 pi_getscript.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207 pi_gzip.html \
208 pi_netrw.html \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000209 pi_paren.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210 pi_spec.html \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000211 pi_tar.html \
212 pi_vimball.html \
213 pi_zip.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000214 print.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215 quickfix.html \
216 quickref.html \
217 quotes.html \
218 recover.html \
219 remote.html \
220 repeat.html \
221 rileft.html \
222 russian.html \
223 scroll.html \
224 sign.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000225 spell.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226 sponsor.html \
227 starting.html \
228 syntax.html \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000229 tabpage.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230 tags.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000231 tagsrch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232 term.html \
233 tips.html \
234 todo.html \
235 uganda.html \
236 undo.html \
237 usr_01.html \
238 usr_02.html \
239 usr_03.html \
240 usr_04.html \
241 usr_05.html \
242 usr_06.html \
243 usr_07.html \
244 usr_08.html \
245 usr_09.html \
246 usr_10.html \
247 usr_11.html \
248 usr_12.html \
249 usr_20.html \
250 usr_21.html \
251 usr_22.html \
252 usr_23.html \
253 usr_24.html \
254 usr_25.html \
255 usr_26.html \
256 usr_27.html \
257 usr_28.html \
258 usr_29.html \
259 usr_30.html \
260 usr_31.html \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000261 usr_32.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262 usr_40.html \
263 usr_41.html \
264 usr_42.html \
265 usr_43.html \
266 usr_44.html \
267 usr_45.html \
268 usr_90.html \
269 usr_toc.html \
270 various.html \
271 version4.html \
272 version5.html \
273 version6.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000274 version7.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275 vi_diff.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000276 vimindex.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277 visual.html \
278 windows.html \
279 workshop.html
280
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000281CONVERTED = \
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000282 vim-fr.UTF-8.1 \
283 evim-fr.UTF-8.1 \
284 vimdiff-fr.UTF-8.1 \
285 vimtutor-fr.UTF-8.1 \
286 xxd-fr.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000287 vim-it.UTF-8.1 \
288 evim-it.UTF-8.1 \
289 vimdiff-it.UTF-8.1 \
290 vimtutor-it.UTF-8.1 \
291 xxd-it.UTF-8.1 \
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000292 vim-pl.UTF-8.1 \
293 evim-pl.UTF-8.1 \
294 vimdiff-pl.UTF-8.1 \
295 vimtutor-pl.UTF-8.1 \
296 xxd-pl.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000297 vim-ru.UTF-8.1 \
298 evim-ru.UTF-8.1 \
299 vimdiff-ru.UTF-8.1 \
300 vimtutor-ru.UTF-8.1 \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000301 xxd-ru.UTF-8.1
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000302
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303.SUFFIXES:
304.SUFFIXES: .c .o .txt .html
305
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000306all: tags vim.man evim.man vimdiff.man vimtutor.man xxd.man $(CONVERTED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307
308# Use Vim to generate the tags file. Can only be used when Vim has been
309# compiled and installed. Supports multiple languages.
310vimtags: $(DOCS)
Bram Moolenaar426e5c92008-01-11 20:02:02 +0000311 $(VIMEXE) -u NONE -esX -c "helptags ++t ." -c quit
Bram Moolenaar071d4272004-06-13 20:20:40 +0000312
313# Use "doctags" to generate the tags file. Only works for English!
314tags: doctags $(DOCS)
315 ./doctags $(DOCS) | LANG=C LC_ALL=C sort >tags
316 uniq -d -2 tags
317
318doctags: doctags.c
319 $(CC) doctags.c -o doctags
320
321vim.man: vim.1
322 nroff -man vim.1 | sed -e s/.//g > vim.man
323
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000324evim.man: evim.1
325 nroff -man evim.1 | sed -e s/.//g > evim.man
326
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327vimdiff.man: vimdiff.1
328 nroff -man vimdiff.1 | sed -e s/.//g > vimdiff.man
329
330vimtutor.man: vimtutor.1
331 nroff -man vimtutor.1 | sed -e s/.//g > vimtutor.man
332
333xxd.man: xxd.1
334 nroff -man xxd.1 | sed -e s/.//g > xxd.man
335
336uganda.nsis.txt: uganda.txt
337 sed -e 's/[ ]*\*[-a-zA-Z0-9.]*\*//g' -e 's/vim:tw=78://' \
338 uganda.txt | uniq >uganda.nsis.txt
339
340# Awk version of .txt to .html conversion.
341html: noerrors tags tags.ref $(HTMLS)
342 @if test -f errors.log; then more errors.log; fi
343
344noerrors:
345 -rm -f errors.log
346
347.txt.html:
348 $(AWK) -f makehtml.awk $< >$@
349
Bram Moolenaar371d5402006-03-20 21:47:49 +0000350# index.html is the starting point for HTML, but for the help files it is
351# help.txt. Therefore use vimindex.html for index.txt.
352index.html: help.txt
353 $(AWK) -f makehtml.awk help.txt >index.html
354
355vimindex.html: index.txt
356 $(AWK) -f makehtml.awk index.txt >vimindex.html
357
Bram Moolenaar071d4272004-06-13 20:20:40 +0000358tags.ref tags.html: tags
359 $(AWK) -f maketags.awk tags >tags.html
360
361# Perl version of .txt to .html conversion.
362# There can't be two rules to produce a .html from a .txt file.
363# Just run over all .txt files each time one changes. It's fast anyway.
364perlhtml: tags $(DOCS)
365 ./vim2html.pl tags $(DOCS)
366
367clean:
368 -rm doctags *.html tags.ref
369
370# These files are in the extra archive, skip if not present
371
372arabic.txt:
373 touch arabic.txt
374
375farsi.txt:
376 touch farsi.txt
377
378hebrew.txt:
379 touch hebrew.txt
380
381russian.txt:
382 touch russian.txt
383
384gui_w16.txt:
385 touch gui_w16.txt
386
387gui_w32.txt:
388 touch gui_w32.txt
389
390if_ole.txt:
391 touch if_ole.txt
392
393os_390.txt:
394 touch os_390.txt
395
396os_amiga.txt:
397 touch os_amiga.txt
398
399os_beos.txt:
400 touch os_beos.txt
401
402os_dos.txt:
403 touch os_dos.txt
404
405os_mac.txt:
406 touch os_mac.txt
407
408os_mint.txt:
409 touch os_mint.txt
410
411os_msdos.txt:
412 touch os_msdos.txt
413
414os_os2.txt:
415 touch os_os2.txt
416
417os_qnx.txt:
418 touch os_qnx.txt
419
420os_risc.txt:
421 touch os_risc.txt
422
423os_win32.txt:
424 touch os_win32.txt
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000425
Bram Moolenaarb475fb92006-03-02 22:40:52 +0000426# Note that $< works with GNU make while $> works for BSD make.
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000427# Is there a solution that works for both??
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000428vim-fr.UTF-8.1: vim-fr.1
429 iconv -f latin1 -t utf-8 $< >$@
430
431evim-fr.UTF-8.1: evim-fr.1
432 iconv -f latin1 -t utf-8 $< >$@
433
434vimdiff-fr.UTF-8.1: vimdiff-fr.1
435 iconv -f latin1 -t utf-8 $< >$@
436
437vimtutor-fr.UTF-8.1: vimtutor-fr.1
438 iconv -f latin1 -t utf-8 $< >$@
439
440xxd-fr.UTF-8.1: xxd-fr.1
441 iconv -f latin1 -t utf-8 $< >$@
442
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000443vim-it.UTF-8.1: vim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000444 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000445
446evim-it.UTF-8.1: evim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000447 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000448
449vimdiff-it.UTF-8.1: vimdiff-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000450 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000451
452vimtutor-it.UTF-8.1: vimtutor-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000453 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000454
455xxd-it.UTF-8.1: xxd-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000456 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000457
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000458vim-pl.UTF-8.1: vim-pl.1
459 iconv -f latin2 -t utf-8 $< >$@
460
461evim-pl.UTF-8.1: evim-pl.1
462 iconv -f latin2 -t utf-8 $< >$@
463
464vimdiff-pl.UTF-8.1: vimdiff-pl.1
465 iconv -f latin2 -t utf-8 $< >$@
466
467vimtutor-pl.UTF-8.1: vimtutor-pl.1
468 iconv -f latin2 -t utf-8 $< >$@
469
470xxd-pl.UTF-8.1: xxd-pl.1
471 iconv -f latin2 -t utf-8 $< >$@
472
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000473vim-ru.UTF-8.1: vim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000474 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000475
476evim-ru.UTF-8.1: evim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000477 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000478
479vimdiff-ru.UTF-8.1: vimdiff-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000480 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000481
482vimtutor-ru.UTF-8.1: vimtutor-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000483 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000484
485xxd-ru.UTF-8.1: xxd-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000486 iconv -f KOI8-R -t utf-8 $< >$@