blob: 3a289d7b04226c860401bdf76952586c089ca0ca [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 \
40 howto.txt \
41 if_cscop.txt \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +000042 if_mzsch.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000043 if_ole.txt \
44 if_perl.txt \
45 if_pyth.txt \
46 if_ruby.txt \
47 if_sniff.txt \
48 if_tcl.txt \
49 indent.txt \
50 index.txt \
51 insert.txt \
52 intro.txt \
53 map.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 mbyte.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000055 message.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000056 mlang.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000057 motion.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000058 netbeans.txt \
59 options.txt \
60 os_390.txt \
61 os_amiga.txt \
62 os_beos.txt \
63 os_dos.txt \
64 os_mac.txt \
65 os_mint.txt \
66 os_msdos.txt \
67 os_os2.txt \
68 os_qnx.txt \
69 os_risc.txt \
70 os_unix.txt \
71 os_vms.txt \
72 os_win32.txt \
73 pattern.txt \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +000074 pi_getscript.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000075 pi_gzip.txt \
76 pi_netrw.txt \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000077 pi_paren.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 pi_spec.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +000079 pi_tar.txt \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +000080 pi_vimball.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +000081 pi_zip.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +000082 print.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 quickfix.txt \
84 quickref.txt \
85 quotes.txt \
86 recover.txt \
87 remote.txt \
88 repeat.txt \
89 rileft.txt \
90 russian.txt \
91 scroll.txt \
92 sign.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +000093 spell.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000094 sponsor.txt \
95 starting.txt \
96 syntax.txt \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +000097 tabpage.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000098 tagsrch.txt \
99 term.txt \
100 tips.txt \
101 todo.txt \
102 uganda.txt \
103 undo.txt \
104 usr_01.txt \
105 usr_02.txt \
106 usr_03.txt \
107 usr_04.txt \
108 usr_05.txt \
109 usr_06.txt \
110 usr_07.txt \
111 usr_08.txt \
112 usr_09.txt \
113 usr_10.txt \
114 usr_11.txt \
115 usr_12.txt \
116 usr_20.txt \
117 usr_21.txt \
118 usr_22.txt \
119 usr_23.txt \
120 usr_24.txt \
121 usr_25.txt \
122 usr_26.txt \
123 usr_27.txt \
124 usr_28.txt \
125 usr_29.txt \
126 usr_30.txt \
127 usr_31.txt \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000128 usr_32.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000129 usr_40.txt \
130 usr_41.txt \
131 usr_42.txt \
132 usr_43.txt \
133 usr_44.txt \
134 usr_45.txt \
135 usr_90.txt \
136 usr_toc.txt \
137 various.txt \
138 version4.txt \
139 version5.txt \
140 version6.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000141 version7.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142 vi_diff.txt \
143 visual.txt \
144 windows.txt \
145 workshop.txt
146
147HTMLS = \
148 arabic.html \
149 autocmd.html \
150 change.html \
151 cmdline.html \
Bram Moolenaare344bea2005-09-01 20:46:49 +0000152 debug.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000153 debugger.html \
154 develop.html \
155 diff.html \
156 digraph.html \
157 editing.html \
158 eval.html \
159 farsi.html \
160 filetype.html \
161 fold.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000162 ft_ada.html \
163 ft_sql.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164 gui.html \
165 gui_w16.html \
166 gui_w32.html \
167 gui_x11.html \
168 hangulin.html \
169 hebrew.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170 howto.html \
171 if_cscop.html \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000172 if_mzsch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173 if_ole.html \
174 if_perl.html \
175 if_pyth.html \
176 if_ruby.html \
177 if_sniff.html \
178 if_tcl.html \
179 indent.html \
180 index.html \
181 insert.html \
182 intro.html \
183 map.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184 mbyte.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000185 message.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186 mlang.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000187 motion.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188 netbeans.html \
189 options.html \
190 os_390.html \
191 os_amiga.html \
192 os_beos.html \
193 os_dos.html \
194 os_mac.html \
195 os_mint.html \
196 os_msdos.html \
197 os_os2.html \
198 os_qnx.html \
199 os_risc.html \
200 os_unix.html \
201 os_vms.html \
202 os_win32.html \
203 pattern.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000204 pi_getscript.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205 pi_gzip.html \
206 pi_netrw.html \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000207 pi_paren.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208 pi_spec.html \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000209 pi_tar.html \
210 pi_vimball.html \
211 pi_zip.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000212 print.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213 quickfix.html \
214 quickref.html \
215 quotes.html \
216 recover.html \
217 remote.html \
218 repeat.html \
219 rileft.html \
220 russian.html \
221 scroll.html \
222 sign.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000223 spell.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224 sponsor.html \
225 starting.html \
226 syntax.html \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000227 tabpage.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000228 tags.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000229 tagsrch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230 term.html \
231 tips.html \
232 todo.html \
233 uganda.html \
234 undo.html \
235 usr_01.html \
236 usr_02.html \
237 usr_03.html \
238 usr_04.html \
239 usr_05.html \
240 usr_06.html \
241 usr_07.html \
242 usr_08.html \
243 usr_09.html \
244 usr_10.html \
245 usr_11.html \
246 usr_12.html \
247 usr_20.html \
248 usr_21.html \
249 usr_22.html \
250 usr_23.html \
251 usr_24.html \
252 usr_25.html \
253 usr_26.html \
254 usr_27.html \
255 usr_28.html \
256 usr_29.html \
257 usr_30.html \
258 usr_31.html \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000259 usr_32.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 usr_40.html \
261 usr_41.html \
262 usr_42.html \
263 usr_43.html \
264 usr_44.html \
265 usr_45.html \
266 usr_90.html \
267 usr_toc.html \
268 various.html \
269 version4.html \
270 version5.html \
271 version6.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000272 version7.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000273 vi_diff.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000274 vimindex.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275 visual.html \
276 windows.html \
277 workshop.html
278
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000279CONVERTED = \
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000280 vim-fr.UTF-8.1 \
281 evim-fr.UTF-8.1 \
282 vimdiff-fr.UTF-8.1 \
283 vimtutor-fr.UTF-8.1 \
284 xxd-fr.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000285 vim-it.UTF-8.1 \
286 evim-it.UTF-8.1 \
287 vimdiff-it.UTF-8.1 \
288 vimtutor-it.UTF-8.1 \
289 xxd-it.UTF-8.1 \
290 vim-ru.UTF-8.1 \
291 evim-ru.UTF-8.1 \
292 vimdiff-ru.UTF-8.1 \
293 vimtutor-ru.UTF-8.1 \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000294 xxd-ru.UTF-8.1
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000295
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296.SUFFIXES:
297.SUFFIXES: .c .o .txt .html
298
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000299all: tags vim.man vimdiff.man vimtutor.man xxd.man $(CONVERTED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000300
301# Use Vim to generate the tags file. Can only be used when Vim has been
302# compiled and installed. Supports multiple languages.
303vimtags: $(DOCS)
Bram Moolenaar426e5c92008-01-11 20:02:02 +0000304 $(VIMEXE) -u NONE -esX -c "helptags ++t ." -c quit
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305
306# Use "doctags" to generate the tags file. Only works for English!
307tags: doctags $(DOCS)
308 ./doctags $(DOCS) | LANG=C LC_ALL=C sort >tags
309 uniq -d -2 tags
310
311doctags: doctags.c
312 $(CC) doctags.c -o doctags
313
314vim.man: vim.1
315 nroff -man vim.1 | sed -e s/.//g > vim.man
316
317vimdiff.man: vimdiff.1
318 nroff -man vimdiff.1 | sed -e s/.//g > vimdiff.man
319
320vimtutor.man: vimtutor.1
321 nroff -man vimtutor.1 | sed -e s/.//g > vimtutor.man
322
323xxd.man: xxd.1
324 nroff -man xxd.1 | sed -e s/.//g > xxd.man
325
326uganda.nsis.txt: uganda.txt
327 sed -e 's/[ ]*\*[-a-zA-Z0-9.]*\*//g' -e 's/vim:tw=78://' \
328 uganda.txt | uniq >uganda.nsis.txt
329
330# Awk version of .txt to .html conversion.
331html: noerrors tags tags.ref $(HTMLS)
332 @if test -f errors.log; then more errors.log; fi
333
334noerrors:
335 -rm -f errors.log
336
337.txt.html:
338 $(AWK) -f makehtml.awk $< >$@
339
Bram Moolenaar371d5402006-03-20 21:47:49 +0000340# index.html is the starting point for HTML, but for the help files it is
341# help.txt. Therefore use vimindex.html for index.txt.
342index.html: help.txt
343 $(AWK) -f makehtml.awk help.txt >index.html
344
345vimindex.html: index.txt
346 $(AWK) -f makehtml.awk index.txt >vimindex.html
347
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348tags.ref tags.html: tags
349 $(AWK) -f maketags.awk tags >tags.html
350
351# Perl version of .txt to .html conversion.
352# There can't be two rules to produce a .html from a .txt file.
353# Just run over all .txt files each time one changes. It's fast anyway.
354perlhtml: tags $(DOCS)
355 ./vim2html.pl tags $(DOCS)
356
357clean:
358 -rm doctags *.html tags.ref
359
360# These files are in the extra archive, skip if not present
361
362arabic.txt:
363 touch arabic.txt
364
365farsi.txt:
366 touch farsi.txt
367
368hebrew.txt:
369 touch hebrew.txt
370
371russian.txt:
372 touch russian.txt
373
374gui_w16.txt:
375 touch gui_w16.txt
376
377gui_w32.txt:
378 touch gui_w32.txt
379
380if_ole.txt:
381 touch if_ole.txt
382
383os_390.txt:
384 touch os_390.txt
385
386os_amiga.txt:
387 touch os_amiga.txt
388
389os_beos.txt:
390 touch os_beos.txt
391
392os_dos.txt:
393 touch os_dos.txt
394
395os_mac.txt:
396 touch os_mac.txt
397
398os_mint.txt:
399 touch os_mint.txt
400
401os_msdos.txt:
402 touch os_msdos.txt
403
404os_os2.txt:
405 touch os_os2.txt
406
407os_qnx.txt:
408 touch os_qnx.txt
409
410os_risc.txt:
411 touch os_risc.txt
412
413os_win32.txt:
414 touch os_win32.txt
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000415
Bram Moolenaarb475fb92006-03-02 22:40:52 +0000416# Note that $< works with GNU make while $> works for BSD make.
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000417# Is there a solution that works for both??
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000418vim-fr.UTF-8.1: vim-fr.1
419 iconv -f latin1 -t utf-8 $< >$@
420
421evim-fr.UTF-8.1: evim-fr.1
422 iconv -f latin1 -t utf-8 $< >$@
423
424vimdiff-fr.UTF-8.1: vimdiff-fr.1
425 iconv -f latin1 -t utf-8 $< >$@
426
427vimtutor-fr.UTF-8.1: vimtutor-fr.1
428 iconv -f latin1 -t utf-8 $< >$@
429
430xxd-fr.UTF-8.1: xxd-fr.1
431 iconv -f latin1 -t utf-8 $< >$@
432
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000433vim-it.UTF-8.1: vim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000434 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000435
436evim-it.UTF-8.1: evim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000437 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000438
439vimdiff-it.UTF-8.1: vimdiff-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000440 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000441
442vimtutor-it.UTF-8.1: vimtutor-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000443 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000444
445xxd-it.UTF-8.1: xxd-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000446 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000447
448vim-ru.UTF-8.1: vim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000449 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000450
451evim-ru.UTF-8.1: evim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000452 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000453
454vimdiff-ru.UTF-8.1: vimdiff-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000455 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000456
457vimtutor-ru.UTF-8.1: vimtutor-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000458 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000459
460xxd-ru.UTF-8.1: xxd-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000461 iconv -f KOI8-R -t utf-8 $< >$@