Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_vim / 60aad974be620cfd3e4f76e3cd29a968289bd4f7 / . / runtime / doc / Makefile
blob: 3505c037debecfd8e0f75c1cd4445c09dad1a76c [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]1#
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 +0000[diff] [blame]21 debug.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000[diff] [blame]22 debugger.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]23 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 +0000[diff] [blame]31 ft_ada.txt \
32 ft_sql.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]33 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 +0200[diff] [blame]40 helphelp.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]41 howto.txt \
42 if_cscop.txt \
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200[diff] [blame]43 if_lua.txt \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000[diff] [blame]44 if_mzsch.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]45 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 +0000[diff] [blame]56 mbyte.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000[diff] [blame]57 message.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]58 mlang.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000[diff] [blame]59 motion.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]60 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 +0000[diff] [blame]76 pi_getscript.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]77 pi_gzip.txt \
78 pi_netrw.txt \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000[diff] [blame]79 pi_paren.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]80 pi_spec.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +0000[diff] [blame]81 pi_tar.txt \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000[diff] [blame]82 pi_vimball.txt \
Bram Moolenaara3957102005-11-28 22:56:19 +0000[diff] [blame]83 pi_zip.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000[diff] [blame]84 print.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]85 quickfix.txt \
86 quickref.txt \
87 quotes.txt \
88 recover.txt \
89 remote.txt \
90 repeat.txt \
91 rileft.txt \
92 russian.txt \
93 scroll.txt \
94 sign.txt \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000[diff] [blame]95 spell.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]96 sponsor.txt \
97 starting.txt \
98 syntax.txt \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000[diff] [blame]99 tabpage.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]100 tagsrch.txt \
101 term.txt \
102 tips.txt \
103 todo.txt \
104 uganda.txt \
105 undo.txt \
106 usr_01.txt \
107 usr_02.txt \
108 usr_03.txt \
109 usr_04.txt \
110 usr_05.txt \
111 usr_06.txt \
112 usr_07.txt \
113 usr_08.txt \
114 usr_09.txt \
115 usr_10.txt \
116 usr_11.txt \
117 usr_12.txt \
118 usr_20.txt \
119 usr_21.txt \
120 usr_22.txt \
121 usr_23.txt \
122 usr_24.txt \
123 usr_25.txt \
124 usr_26.txt \
125 usr_27.txt \
126 usr_28.txt \
127 usr_29.txt \
128 usr_30.txt \
129 usr_31.txt \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000[diff] [blame]130 usr_32.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]131 usr_40.txt \
132 usr_41.txt \
133 usr_42.txt \
134 usr_43.txt \
135 usr_44.txt \
136 usr_45.txt \
137 usr_90.txt \
138 usr_toc.txt \
139 various.txt \
140 version4.txt \
141 version5.txt \
142 version6.txt \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000[diff] [blame]143 version7.txt \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]144 vi_diff.txt \
145 visual.txt \
146 windows.txt \
147 workshop.txt
148
149HTMLS = \
150 arabic.html \
151 autocmd.html \
152 change.html \
153 cmdline.html \
Bram Moolenaare344bea2005-09-01 20:46:49 +0000[diff] [blame]154 debug.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]155 debugger.html \
156 develop.html \
157 diff.html \
158 digraph.html \
159 editing.html \
160 eval.html \
161 farsi.html \
162 filetype.html \
163 fold.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000[diff] [blame]164 ft_ada.html \
165 ft_sql.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]166 gui.html \
167 gui_w16.html \
168 gui_w32.html \
169 gui_x11.html \
170 hangulin.html \
171 hebrew.html \
Bram Moolenaarb2c03502010-07-02 20:20:09 +0200[diff] [blame]172 helphelp.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]173 howto.html \
174 if_cscop.html \
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200[diff] [blame]175 if_lua.html \
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000[diff] [blame]176 if_mzsch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]177 if_ole.html \
178 if_perl.html \
179 if_pyth.html \
180 if_ruby.html \
181 if_sniff.html \
182 if_tcl.html \
183 indent.html \
184 index.html \
185 insert.html \
186 intro.html \
187 map.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]188 mbyte.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000[diff] [blame]189 message.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]190 mlang.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000[diff] [blame]191 motion.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]192 netbeans.html \
193 options.html \
194 os_390.html \
195 os_amiga.html \
196 os_beos.html \
197 os_dos.html \
198 os_mac.html \
199 os_mint.html \
200 os_msdos.html \
201 os_os2.html \
202 os_qnx.html \
203 os_risc.html \
204 os_unix.html \
205 os_vms.html \
206 os_win32.html \
207 pattern.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000[diff] [blame]208 pi_getscript.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]209 pi_gzip.html \
210 pi_netrw.html \
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000[diff] [blame]211 pi_paren.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]212 pi_spec.html \
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000[diff] [blame]213 pi_tar.html \
214 pi_vimball.html \
215 pi_zip.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000[diff] [blame]216 print.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]217 quickfix.html \
218 quickref.html \
219 quotes.html \
220 recover.html \
221 remote.html \
222 repeat.html \
223 rileft.html \
224 russian.html \
225 scroll.html \
226 sign.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000[diff] [blame]227 spell.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]228 sponsor.html \
229 starting.html \
230 syntax.html \
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000[diff] [blame]231 tabpage.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]232 tags.html \
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000[diff] [blame]233 tagsrch.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]234 term.html \
235 tips.html \
236 todo.html \
237 uganda.html \
238 undo.html \
239 usr_01.html \
240 usr_02.html \
241 usr_03.html \
242 usr_04.html \
243 usr_05.html \
244 usr_06.html \
245 usr_07.html \
246 usr_08.html \
247 usr_09.html \
248 usr_10.html \
249 usr_11.html \
250 usr_12.html \
251 usr_20.html \
252 usr_21.html \
253 usr_22.html \
254 usr_23.html \
255 usr_24.html \
256 usr_25.html \
257 usr_26.html \
258 usr_27.html \
259 usr_28.html \
260 usr_29.html \
261 usr_30.html \
262 usr_31.html \
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000[diff] [blame]263 usr_32.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]264 usr_40.html \
265 usr_41.html \
266 usr_42.html \
267 usr_43.html \
268 usr_44.html \
269 usr_45.html \
270 usr_90.html \
271 usr_toc.html \
272 various.html \
273 version4.html \
274 version5.html \
275 version6.html \
Bram Moolenaar8299df92004-07-10 09:47:34 +0000[diff] [blame]276 version7.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]277 vi_diff.html \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000[diff] [blame]278 vimindex.html \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]279 visual.html \
280 windows.html \
281 workshop.html
282
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]283CONVERTED = \
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]284 vim-fr.UTF-8.1 \
285 evim-fr.UTF-8.1 \
286 vimdiff-fr.UTF-8.1 \
287 vimtutor-fr.UTF-8.1 \
288 xxd-fr.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]289 vim-it.UTF-8.1 \
290 evim-it.UTF-8.1 \
291 vimdiff-it.UTF-8.1 \
292 vimtutor-it.UTF-8.1 \
293 xxd-it.UTF-8.1 \
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000[diff] [blame]294 vim-pl.UTF-8.1 \
295 evim-pl.UTF-8.1 \
296 vimdiff-pl.UTF-8.1 \
297 vimtutor-pl.UTF-8.1 \
298 xxd-pl.UTF-8.1 \
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]299 vim-ru.UTF-8.1 \
300 evim-ru.UTF-8.1 \
301 vimdiff-ru.UTF-8.1 \
302 vimtutor-ru.UTF-8.1 \
Bram Moolenaara7241f52008-06-24 20:39:31 +0000[diff] [blame]303 xxd-ru.UTF-8.1
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]304
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]305.SUFFIXES:
306.SUFFIXES: .c .o .txt .html
307
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000[diff] [blame]308all: tags vim.man evim.man vimdiff.man vimtutor.man xxd.man $(CONVERTED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]309
310# Use Vim to generate the tags file. Can only be used when Vim has been
311# compiled and installed. Supports multiple languages.
312vimtags: $(DOCS)
Bram Moolenaar426e5c92008-01-11 20:02:02 +0000[diff] [blame]313 $(VIMEXE) -u NONE -esX -c "helptags ++t ." -c quit
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]314
315# Use "doctags" to generate the tags file. Only works for English!
316tags: doctags $(DOCS)
317 ./doctags $(DOCS) | LANG=C LC_ALL=C sort >tags
318 uniq -d -2 tags
319
320doctags: doctags.c
321 $(CC) doctags.c -o doctags
322
323vim.man: vim.1
324 nroff -man vim.1 | sed -e s/.//g > vim.man
325
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000[diff] [blame]326evim.man: evim.1
327 nroff -man evim.1 | sed -e s/.//g > evim.man
328
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]329vimdiff.man: vimdiff.1
330 nroff -man vimdiff.1 | sed -e s/.//g > vimdiff.man
331
332vimtutor.man: vimtutor.1
333 nroff -man vimtutor.1 | sed -e s/.//g > vimtutor.man
334
335xxd.man: xxd.1
336 nroff -man xxd.1 | sed -e s/.//g > xxd.man
337
338uganda.nsis.txt: uganda.txt
339 sed -e 's/[ ]*\*[-a-zA-Z0-9.]*\*//g' -e 's/vim:tw=78://' \
340 uganda.txt | uniq >uganda.nsis.txt
341
342# Awk version of .txt to .html conversion.
343html: noerrors tags tags.ref $(HTMLS)
344 @if test -f errors.log; then more errors.log; fi
345
346noerrors:
347 -rm -f errors.log
348
349.txt.html:
350 $(AWK) -f makehtml.awk $< >$@
351
Bram Moolenaar371d5402006-03-20 21:47:49 +0000[diff] [blame]352# index.html is the starting point for HTML, but for the help files it is
353# help.txt. Therefore use vimindex.html for index.txt.
354index.html: help.txt
355 $(AWK) -f makehtml.awk help.txt >index.html
356
357vimindex.html: index.txt
358 $(AWK) -f makehtml.awk index.txt >vimindex.html
359
Bram Moolenaar071d4272004-06-13 20:20:40 +0000[diff] [blame]360tags.ref tags.html: tags
361 $(AWK) -f maketags.awk tags >tags.html
362
363# Perl version of .txt to .html conversion.
364# There can't be two rules to produce a .html from a .txt file.
365# Just run over all .txt files each time one changes. It's fast anyway.
366perlhtml: tags $(DOCS)
367 ./vim2html.pl tags $(DOCS)
368
369clean:
370 -rm doctags *.html tags.ref
371
372# These files are in the extra archive, skip if not present
373
374arabic.txt:
375 touch arabic.txt
376
377farsi.txt:
378 touch farsi.txt
379
380hebrew.txt:
381 touch hebrew.txt
382
383russian.txt:
384 touch russian.txt
385
386gui_w16.txt:
387 touch gui_w16.txt
388
389gui_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 +0000[diff] [blame]427
Bram Moolenaarb475fb92006-03-02 22:40:52 +0000[diff] [blame]428# Note that $< works with GNU make while $> works for BSD make.
Bram Moolenaar3991dab2006-03-27 17:01:56 +0000[diff] [blame]429# Is there a solution that works for both??
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]430vim-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 +0000[diff] [blame]445vim-it.UTF-8.1: vim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]446 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]447
448evim-it.UTF-8.1: evim-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]449 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]450
451vimdiff-it.UTF-8.1: vimdiff-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]452 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]453
454vimtutor-it.UTF-8.1: vimtutor-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]455 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]456
457xxd-it.UTF-8.1: xxd-it.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]458 iconv -f latin1 -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]459
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000[diff] [blame]460vim-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 +0000[diff] [blame]475vim-ru.UTF-8.1: vim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]476 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]477
478evim-ru.UTF-8.1: evim-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]479 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]480
481vimdiff-ru.UTF-8.1: vimdiff-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]482 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]483
484vimtutor-ru.UTF-8.1: vimtutor-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]485 iconv -f KOI8-R -t utf-8 $< >$@
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000[diff] [blame]486
487xxd-ru.UTF-8.1: xxd-ru.1
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000[diff] [blame]488 iconv -f KOI8-R -t utf-8 $< >$@