blob: a337cb60fa6e5ef361807f95d0f312ee3c37922e [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 \
21 debugger.txt \
Bram Moolenaare344bea2005-09-01 20:46:49 +000022 debug.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 Moolenaareee697b2006-03-21 21:20:39 +000031 getscript.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000032 gui.txt \
33 gui_w16.txt \
34 gui_w32.txt \
35 gui_x11.txt \
36 hangulin.txt \
37 hebrew.txt \
38 help.txt \
39 howto.txt \
40 if_cscop.txt \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +000041 if_mzsch.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 if_ole.txt \
43 if_perl.txt \
44 if_pyth.txt \
45 if_ruby.txt \
46 if_sniff.txt \
47 if_tcl.txt \
48 indent.txt \
49 index.txt \
50 insert.txt \
51 intro.txt \
52 map.txt \
53 message.txt \
54 motion.txt \
55 mbyte.txt \
56 mlang.txt \
57 netbeans.txt \
58 options.txt \
59 os_390.txt \
60 os_amiga.txt \
61 os_beos.txt \
62 os_dos.txt \
63 os_mac.txt \
64 os_mint.txt \
65 os_msdos.txt \
66 os_os2.txt \
67 os_qnx.txt \
68 os_risc.txt \
69 os_unix.txt \
70 os_vms.txt \
71 os_win32.txt \
72 pattern.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 pi_gzip.txt \
74 pi_netrw.txt \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000075 pi_paren.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 pi_spec.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +000077 pi_tar.txt \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +000078 pi_vimball.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +000079 pi_zip.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +000080 print.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 quickfix.txt \
82 quickref.txt \
83 quotes.txt \
84 recover.txt \
85 remote.txt \
86 repeat.txt \
87 rileft.txt \
88 russian.txt \
89 scroll.txt \
90 sign.txt \
91 sponsor.txt \
92 starting.txt \
Bram Moolenaar2e4096b2005-03-20 22:25:45 +000093 spell.txt \
Bram Moolenaar0fd92892006-03-09 22:27:48 +000094 sql.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000095 syntax.txt \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +000096 tabpage.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +000097 tagsrch.txt \
98 term.txt \
99 tips.txt \
100 todo.txt \
101 uganda.txt \
102 undo.txt \
103 usr_01.txt \
104 usr_02.txt \
105 usr_03.txt \
106 usr_04.txt \
107 usr_05.txt \
108 usr_06.txt \
109 usr_07.txt \
110 usr_08.txt \
111 usr_09.txt \
112 usr_10.txt \
113 usr_11.txt \
114 usr_12.txt \
115 usr_20.txt \
116 usr_21.txt \
117 usr_22.txt \
118 usr_23.txt \
119 usr_24.txt \
120 usr_25.txt \
121 usr_26.txt \
122 usr_27.txt \
123 usr_28.txt \
124 usr_29.txt \
125 usr_30.txt \
126 usr_31.txt \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000127 usr_32.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128 usr_40.txt \
129 usr_41.txt \
130 usr_42.txt \
131 usr_43.txt \
132 usr_44.txt \
133 usr_45.txt \
134 usr_90.txt \
135 usr_toc.txt \
136 various.txt \
137 version4.txt \
138 version5.txt \
139 version6.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000140 version7.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141 vi_diff.txt \
142 visual.txt \
143 windows.txt \
144 workshop.txt
145
146HTMLS = \
147 arabic.html \
148 autocmd.html \
149 change.html \
150 cmdline.html \
Bram Moolenaare344bea2005-09-01 20:46:49 +0000151 debug.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152 debugger.html \
153 develop.html \
154 diff.html \
155 digraph.html \
156 editing.html \
157 eval.html \
158 farsi.html \
159 filetype.html \
160 fold.html \
Bram Moolenaareee697b2006-03-21 21:20:39 +0000161 getscript.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162 gui.html \
163 gui_w16.html \
164 gui_w32.html \
165 gui_x11.html \
166 hangulin.html \
167 hebrew.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168 howto.html \
169 if_cscop.html \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000170 if_mzsch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171 if_ole.html \
172 if_perl.html \
173 if_pyth.html \
174 if_ruby.html \
175 if_sniff.html \
176 if_tcl.html \
177 indent.html \
178 index.html \
Bram Moolenaar371d5402006-03-20 21:47:49 +0000179 vimindex.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180 insert.html \
181 intro.html \
182 map.html \
183 message.html \
184 motion.html \
185 mbyte.html \
186 mlang.html \
187 netbeans.html \
188 options.html \
189 os_390.html \
190 os_amiga.html \
191 os_beos.html \
192 os_dos.html \
193 os_mac.html \
194 os_mint.html \
195 os_msdos.html \
196 os_os2.html \
197 os_qnx.html \
198 os_risc.html \
199 os_unix.html \
200 os_vms.html \
201 os_win32.html \
202 pattern.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203 pi_gzip.html \
204 pi_netrw.html \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000205 pi_paren.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 pi_spec.html \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000207 pi_tar.html \
208 pi_vimball.html \
209 pi_zip.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000210 print.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 quickfix.html \
212 quickref.html \
213 quotes.html \
214 recover.html \
215 remote.html \
216 repeat.html \
217 rileft.html \
218 russian.html \
219 scroll.html \
220 sign.html \
221 sponsor.html \
222 starting.html \
Bram Moolenaar2e4096b2005-03-20 22:25:45 +0000223 spell.html \
Bram Moolenaar0fd92892006-03-09 22:27:48 +0000224 sql.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225 syntax.html \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000226 tabpage.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227 tagsrch.html \
228 tags.html \
229 term.html \
230 tips.html \
231 todo.html \
232 uganda.html \
233 undo.html \
234 usr_01.html \
235 usr_02.html \
236 usr_03.html \
237 usr_04.html \
238 usr_05.html \
239 usr_06.html \
240 usr_07.html \
241 usr_08.html \
242 usr_09.html \
243 usr_10.html \
244 usr_11.html \
245 usr_12.html \
246 usr_20.html \
247 usr_21.html \
248 usr_22.html \
249 usr_23.html \
250 usr_24.html \
251 usr_25.html \
252 usr_26.html \
253 usr_27.html \
254 usr_28.html \
255 usr_29.html \
256 usr_30.html \
257 usr_31.html \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000258 usr_32.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259 usr_40.html \
260 usr_41.html \
261 usr_42.html \
262 usr_43.html \
263 usr_44.html \
264 usr_45.html \
265 usr_90.html \
266 usr_toc.html \
267 various.html \
268 version4.html \
269 version5.html \
270 version6.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000271 version7.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272 vi_diff.html \
273 visual.html \
274 windows.html \
275 workshop.html
276
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000277CONVERTED = \
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000278 vim-fr.UTF-8.1 \
279 evim-fr.UTF-8.1 \
280 vimdiff-fr.UTF-8.1 \
281 vimtutor-fr.UTF-8.1 \
282 xxd-fr.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000283 vim-it.UTF-8.1 \
284 evim-it.UTF-8.1 \
285 vimdiff-it.UTF-8.1 \
286 vimtutor-it.UTF-8.1 \
287 xxd-it.UTF-8.1 \
288 vim-ru.UTF-8.1 \
289 evim-ru.UTF-8.1 \
290 vimdiff-ru.UTF-8.1 \
291 vimtutor-ru.UTF-8.1 \
292 xxd-ru.UTF-8.1 \
293
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294.SUFFIXES:
295.SUFFIXES: .c .o .txt .html
296
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000297all: tags vim.man vimdiff.man vimtutor.man xxd.man $(CONVERTED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298
299# Use Vim to generate the tags file. Can only be used when Vim has been
300# compiled and installed. Supports multiple languages.
301vimtags: $(DOCS)
302 $(VIMEXE) -u NONE -esX -c "helptags ." -c quit
303
304# Use "doctags" to generate the tags file. Only works for English!
305tags: doctags $(DOCS)
306 ./doctags $(DOCS) | LANG=C LC_ALL=C sort >tags
307 uniq -d -2 tags
308
309doctags: doctags.c
310 $(CC) doctags.c -o doctags
311
312vim.man: vim.1
313 nroff -man vim.1 | sed -e s/.//g > vim.man
314
315vimdiff.man: vimdiff.1
316 nroff -man vimdiff.1 | sed -e s/.//g > vimdiff.man
317
318vimtutor.man: vimtutor.1
319 nroff -man vimtutor.1 | sed -e s/.//g > vimtutor.man
320
321xxd.man: xxd.1
322 nroff -man xxd.1 | sed -e s/.//g > xxd.man
323
324uganda.nsis.txt: uganda.txt
325 sed -e 's/[ ]*\*[-a-zA-Z0-9.]*\*//g' -e 's/vim:tw=78://' \
326 uganda.txt | uniq >uganda.nsis.txt
327
328# Awk version of .txt to .html conversion.
329html: noerrors tags tags.ref $(HTMLS)
330 @if test -f errors.log; then more errors.log; fi
331
332noerrors:
333 -rm -f errors.log
334
335.txt.html:
336 $(AWK) -f makehtml.awk $< >$@
337
Bram Moolenaar371d5402006-03-20 21:47:49 +0000338# index.html is the starting point for HTML, but for the help files it is
339# help.txt. Therefore use vimindex.html for index.txt.
340index.html: help.txt
341 $(AWK) -f makehtml.awk help.txt >index.html
342
343vimindex.html: index.txt
344 $(AWK) -f makehtml.awk index.txt >vimindex.html
345
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346tags.ref tags.html: tags
347 $(AWK) -f maketags.awk tags >tags.html
348
349# Perl version of .txt to .html conversion.
350# There can't be two rules to produce a .html from a .txt file.
351# Just run over all .txt files each time one changes. It's fast anyway.
352perlhtml: tags $(DOCS)
353 ./vim2html.pl tags $(DOCS)
354
355clean:
356 -rm doctags *.html tags.ref
357
358# These files are in the extra archive, skip if not present
359
360arabic.txt:
361 touch arabic.txt
362
363farsi.txt:
364 touch farsi.txt
365
366hebrew.txt:
367 touch hebrew.txt
368
369russian.txt:
370 touch russian.txt
371
372gui_w16.txt:
373 touch gui_w16.txt
374
375gui_w32.txt:
376 touch gui_w32.txt
377
378if_ole.txt:
379 touch if_ole.txt
380
381os_390.txt:
382 touch os_390.txt
383
384os_amiga.txt:
385 touch os_amiga.txt
386
387os_beos.txt:
388 touch os_beos.txt
389
390os_dos.txt:
391 touch os_dos.txt
392
393os_mac.txt:
394 touch os_mac.txt
395
396os_mint.txt:
397 touch os_mint.txt
398
399os_msdos.txt:
400 touch os_msdos.txt
401
402os_os2.txt:
403 touch os_os2.txt
404
405os_qnx.txt:
406 touch os_qnx.txt
407
408os_risc.txt:
409 touch os_risc.txt
410
411os_win32.txt:
412 touch os_win32.txt
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000413
Bram Moolenaarb475fb92006-03-02 22:40:52 +0000414# Note that $< works with GNU make while $> works for BSD make.
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000415# Is there a solution that works for both??
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000416vim-fr.UTF-8.1: vim-fr.1
417 iconv -f latin1 -t utf-8 $< >$@
418
419evim-fr.UTF-8.1: evim-fr.1
420 iconv -f latin1 -t utf-8 $< >$@
421
422vimdiff-fr.UTF-8.1: vimdiff-fr.1
423 iconv -f latin1 -t utf-8 $< >$@
424
425vimtutor-fr.UTF-8.1: vimtutor-fr.1
426 iconv -f latin1 -t utf-8 $< >$@
427
428xxd-fr.UTF-8.1: xxd-fr.1
429 iconv -f latin1 -t utf-8 $< >$@
430
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000431vim-it.UTF-8.1: vim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000432 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000433
434evim-it.UTF-8.1: evim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000435 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000436
437vimdiff-it.UTF-8.1: vimdiff-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000438 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000439
440vimtutor-it.UTF-8.1: vimtutor-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000441 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000442
443xxd-it.UTF-8.1: xxd-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000444 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000445
446vim-ru.UTF-8.1: vim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000447 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000448
449evim-ru.UTF-8.1: evim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000450 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000451
452vimdiff-ru.UTF-8.1: vimdiff-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000453 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000454
455vimtutor-ru.UTF-8.1: vimtutor-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000456 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000457
458xxd-ru.UTF-8.1: xxd-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000459 iconv -f KOI8-R -t utf-8 $< >$@