xref: /vim-8.2.3635/runtime/doc/Makefile (revision 73fef330)
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	channel.txt \
21	cmdline.txt \
22	debug.txt \
23	debugger.txt \
24	develop.txt \
25	diff.txt \
26	digraph.txt \
27	editing.txt \
28	eval.txt \
29	farsi.txt \
30	filetype.txt \
31	fold.txt \
32	ft_ada.txt \
33	ft_rust.txt \
34	ft_sql.txt \
35	gui.txt \
36	gui_w32.txt \
37	gui_x11.txt \
38	hangulin.txt \
39	hebrew.txt \
40	help.txt \
41	helphelp.txt \
42	howto.txt \
43	if_cscop.txt \
44	if_lua.txt \
45	if_mzsch.txt \
46	if_ole.txt \
47	if_perl.txt \
48	if_pyth.txt \
49	if_ruby.txt \
50	if_sniff.txt \
51	if_tcl.txt \
52	indent.txt \
53	index.txt \
54	insert.txt \
55	intro.txt \
56	map.txt \
57	mbyte.txt \
58	message.txt \
59	mlang.txt \
60	motion.txt \
61	netbeans.txt \
62	options.txt \
63	os_390.txt \
64	os_amiga.txt \
65	os_beos.txt \
66	os_dos.txt \
67	os_haiku.txt \
68	os_mac.txt \
69	os_mint.txt \
70	os_msdos.txt \
71	os_os2.txt \
72	os_qnx.txt \
73	os_risc.txt \
74	os_unix.txt \
75	os_vms.txt \
76	os_win32.txt \
77	pattern.txt \
78	pi_getscript.txt \
79	pi_gzip.txt \
80	pi_logipat.txt \
81	pi_netrw.txt \
82	pi_paren.txt \
83	pi_spec.txt \
84	pi_tar.txt \
85	pi_vimball.txt \
86	pi_zip.txt \
87	popup.txt \
88	print.txt \
89	quickfix.txt \
90	quickref.txt \
91	quotes.txt \
92	recover.txt \
93	remote.txt \
94	repeat.txt \
95	rileft.txt \
96	russian.txt \
97	scroll.txt \
98	sign.txt \
99	spell.txt \
100	sponsor.txt \
101	starting.txt \
102	syntax.txt \
103	tabpage.txt \
104	tagsrch.txt \
105	term.txt \
106	terminal.txt \
107	testing.txt \
108	textprop.txt \
109	tips.txt \
110	todo.txt \
111	uganda.txt \
112	undo.txt \
113	usr_01.txt \
114	usr_02.txt \
115	usr_03.txt \
116	usr_04.txt \
117	usr_05.txt \
118	usr_06.txt \
119	usr_07.txt \
120	usr_08.txt \
121	usr_09.txt \
122	usr_10.txt \
123	usr_11.txt \
124	usr_12.txt \
125	usr_20.txt \
126	usr_21.txt \
127	usr_22.txt \
128	usr_23.txt \
129	usr_24.txt \
130	usr_25.txt \
131	usr_26.txt \
132	usr_27.txt \
133	usr_28.txt \
134	usr_29.txt \
135	usr_30.txt \
136	usr_31.txt \
137	usr_32.txt \
138	usr_40.txt \
139	usr_41.txt \
140	usr_42.txt \
141	usr_43.txt \
142	usr_44.txt \
143	usr_45.txt \
144	usr_46.txt \
145	usr_90.txt \
146	usr_toc.txt \
147	various.txt \
148	version4.txt \
149	version5.txt \
150	version6.txt \
151	version7.txt \
152	version8.txt \
153	vi_diff.txt \
154	vim9.txt \
155	visual.txt \
156	windows.txt \
157	workshop.txt
158
159HTMLS = \
160	arabic.html \
161	autocmd.html \
162	change.html \
163	channel.html \
164	cmdline.html \
165	debug.html \
166	debugger.html \
167	develop.html \
168	diff.html \
169	digraph.html \
170	editing.html \
171	eval.html \
172	farsi.html \
173	filetype.html \
174	fold.html \
175	ft_ada.html \
176	ft_rust.html \
177	ft_sql.html \
178	gui.html \
179	gui_w32.html \
180	gui_x11.html \
181	hangulin.html \
182	hebrew.html \
183	helphelp.html \
184	howto.html \
185	if_cscop.html \
186	if_lua.html \
187	if_mzsch.html \
188	if_ole.html \
189	if_perl.html \
190	if_pyth.html \
191	if_ruby.html \
192	if_sniff.html \
193	if_tcl.html \
194	indent.html \
195	index.html \
196	insert.html \
197	intro.html \
198	map.html \
199	mbyte.html \
200	message.html \
201	mlang.html \
202	motion.html \
203	netbeans.html \
204	options.html \
205	os_390.html \
206	os_amiga.html \
207	os_beos.html \
208	os_dos.html \
209	os_haiku.html \
210	os_mac.html \
211	os_mint.html \
212	os_msdos.html \
213	os_os2.html \
214	os_qnx.html \
215	os_risc.html \
216	os_unix.html \
217	os_vms.html \
218	os_win32.html \
219	pattern.html \
220	pi_getscript.html \
221	pi_gzip.html \
222	pi_logipat.html \
223	pi_netrw.html \
224	pi_paren.html \
225	pi_spec.html \
226	pi_tar.html \
227	pi_vimball.html \
228	pi_zip.html \
229	popup.html \
230	print.html \
231	quickfix.html \
232	quickref.html \
233	quotes.html \
234	recover.html \
235	remote.html \
236	repeat.html \
237	rileft.html \
238	russian.html \
239	scroll.html \
240	sign.html \
241	spell.html \
242	sponsor.html \
243	starting.html \
244	syntax.html \
245	tabpage.html \
246	tagsrch.html \
247	term.html \
248	terminal.html \
249	testing.html \
250	textprop.html \
251	tips.html \
252	todo.html \
253	uganda.html \
254	undo.html \
255	usr_01.html \
256	usr_02.html \
257	usr_03.html \
258	usr_04.html \
259	usr_05.html \
260	usr_06.html \
261	usr_07.html \
262	usr_08.html \
263	usr_09.html \
264	usr_10.html \
265	usr_11.html \
266	usr_12.html \
267	usr_20.html \
268	usr_21.html \
269	usr_22.html \
270	usr_23.html \
271	usr_24.html \
272	usr_25.html \
273	usr_26.html \
274	usr_27.html \
275	usr_28.html \
276	usr_29.html \
277	usr_30.html \
278	usr_31.html \
279	usr_32.html \
280	usr_40.html \
281	usr_41.html \
282	usr_42.html \
283	usr_43.html \
284	usr_44.html \
285	usr_45.html \
286	usr_46.html \
287	usr_90.html \
288	usr_toc.html \
289	various.html \
290	version4.html \
291	version5.html \
292	version6.html \
293	version7.html \
294	version8.html \
295	vi_diff.html \
296	vimindex.html \
297	vim9.html \
298	visual.html \
299	windows.html \
300	workshop.html
301
302CONVERTED = \
303	vim-fr.UTF-8.1 \
304	evim-fr.UTF-8.1 \
305	vimdiff-fr.UTF-8.1 \
306	vimtutor-fr.UTF-8.1 \
307	xxd-fr.UTF-8.1 \
308	vim-it.UTF-8.1 \
309	evim-it.UTF-8.1 \
310	vimdiff-it.UTF-8.1 \
311	vimtutor-it.UTF-8.1 \
312	xxd-it.UTF-8.1 \
313	vim-pl.UTF-8.1 \
314	evim-pl.UTF-8.1 \
315	vimdiff-pl.UTF-8.1 \
316	vimtutor-pl.UTF-8.1 \
317	xxd-pl.UTF-8.1 \
318	vim-ru.UTF-8.1 \
319	evim-ru.UTF-8.1 \
320	vimdiff-ru.UTF-8.1 \
321	vimtutor-ru.UTF-8.1 \
322	xxd-ru.UTF-8.1 \
323	vim-tr.UTF-8.1 \
324	evim-tr.UTF-8.1 \
325	vimdiff-tr.UTF-8.1 \
326	vimtutor-tr.UTF-8.1
327
328.SUFFIXES:
329.SUFFIXES: .c .o .txt .html
330
331all: tags vim.man evim.man vimdiff.man vimtutor.man xxd.man $(CONVERTED)
332
333# Use Vim to generate the tags file.  Can only be used when Vim has been
334# compiled and installed.  Supports multiple languages.
335vimtags: $(DOCS)
336	@$(VIMEXE) --clean -esX -V1 -u doctags.vim
337
338# Use "doctags" to generate the tags file.  Only works for English!
339tags: doctags $(DOCS)
340	./doctags $(DOCS) | LANG=C LC_ALL=C sort >tags
341	uniq -d -2 tags
342
343doctags: doctags.c
344	$(CC) doctags.c -o doctags
345
346vim.man: vim.1
347	nroff -man vim.1 | sed -e s/.//g > vim.man
348
349evim.man: evim.1
350	nroff -man evim.1 | sed -e s/.//g > evim.man
351
352vimdiff.man: vimdiff.1
353	nroff -man vimdiff.1 | sed -e s/.//g > vimdiff.man
354
355vimtutor.man: vimtutor.1
356	nroff -man vimtutor.1 | sed -e s/.//g > vimtutor.man
357
358xxd.man: xxd.1
359	nroff -man xxd.1 | sed -e s/.//g > xxd.man
360
361uganda.nsis.txt: uganda.txt
362	sed -e 's/[ 	]*\*[-a-zA-Z0-9.]*\*//g' -e 's/vim:tw=78:.*//' \
363		uganda.txt | uniq >uganda.nsis.txt
364
365# Awk version of .txt to .html conversion.
366html: noerrors tags $(HTMLS)
367	@if test -f errors.log; then more errors.log; fi
368
369noerrors:
370	-rm -f errors.log
371
372$(HTMLS): tags.ref
373
374.txt.html:
375	$(AWK) -f makehtml.awk $< >$@
376
377# index.html is the starting point for HTML, but for the help files it is
378# help.txt.  Therefore use vimindex.html for index.txt.
379index.html: help.txt
380	$(AWK) -f makehtml.awk help.txt >index.html
381
382vimindex.html: index.txt
383	$(AWK) -f makehtml.awk index.txt >vimindex.html
384
385tags.ref tags.html: tags
386	$(AWK) -f maketags.awk tags >tags.html
387
388# Perl version of .txt to .html conversion.
389# There can't be two rules to produce a .html from a .txt file.
390# Just run over all .txt files each time one changes.  It's fast anyway.
391perlhtml: tags $(DOCS)
392	./vim2html.pl tags $(DOCS)
393
394# Check URLs in the help with "curl".
395test_urls:
396	vim -S test_urls.vim
397
398clean:
399	-rm doctags *.html tags.ref
400
401# These files are in the extra archive, skip if not present
402
403arabic.txt:
404	touch arabic.txt
405
406farsi.txt:
407	touch farsi.txt
408
409hebrew.txt:
410	touch hebrew.txt
411
412russian.txt:
413	touch russian.txt
414
415gui_w32.txt:
416	touch gui_w32.txt
417
418if_ole.txt:
419	touch if_ole.txt
420
421os_390.txt:
422	touch os_390.txt
423
424os_amiga.txt:
425	touch os_amiga.txt
426
427os_beos.txt:
428	touch os_beos.txt
429
430os_dos.txt:
431	touch os_dos.txt
432
433os_haiku.txt:
434	touch os_haiku.txt
435
436os_mac.txt:
437	touch os_mac.txt
438
439os_mint.txt:
440	touch os_mint.txt
441
442os_msdos.txt:
443	touch os_msdos.txt
444
445os_os2.txt:
446	touch os_os2.txt
447
448os_qnx.txt:
449	touch os_qnx.txt
450
451os_risc.txt:
452	touch os_risc.txt
453
454os_win32.txt:
455	touch os_win32.txt
456
457# Note that $< works with GNU make while $> works for BSD make.
458# Is there a solution that works for both??
459vim-fr.UTF-8.1: vim-fr.1
460	iconv -f latin1 -t utf-8 $< >$@
461
462evim-fr.UTF-8.1: evim-fr.1
463	iconv -f latin1 -t utf-8 $< >$@
464
465vimdiff-fr.UTF-8.1: vimdiff-fr.1
466	iconv -f latin1 -t utf-8 $< >$@
467
468vimtutor-fr.UTF-8.1: vimtutor-fr.1
469	iconv -f latin1 -t utf-8 $< >$@
470
471xxd-fr.UTF-8.1: xxd-fr.1
472	iconv -f latin1 -t utf-8 $< >$@
473
474vim-it.UTF-8.1: vim-it.1
475	iconv -f latin1 -t utf-8 $< >$@
476
477evim-it.UTF-8.1: evim-it.1
478	iconv -f latin1 -t utf-8 $< >$@
479
480vimdiff-it.UTF-8.1: vimdiff-it.1
481	iconv -f latin1 -t utf-8 $< >$@
482
483vimtutor-it.UTF-8.1: vimtutor-it.1
484	iconv -f latin1 -t utf-8 $< >$@
485
486xxd-it.UTF-8.1: xxd-it.1
487	iconv -f latin1 -t utf-8 $< >$@
488
489vim-pl.UTF-8.1: vim-pl.1
490	iconv -f latin2 -t utf-8 $< >$@
491
492evim-pl.UTF-8.1: evim-pl.1
493	iconv -f latin2 -t utf-8 $< >$@
494
495vimdiff-pl.UTF-8.1: vimdiff-pl.1
496	iconv -f latin2 -t utf-8 $< >$@
497
498vimtutor-pl.UTF-8.1: vimtutor-pl.1
499	iconv -f latin2 -t utf-8 $< >$@
500
501xxd-pl.UTF-8.1: xxd-pl.1
502	iconv -f latin2 -t utf-8 $< >$@
503
504vim-ru.UTF-8.1: vim-ru.1
505	iconv -f KOI8-R -t utf-8 $< >$@
506
507evim-ru.UTF-8.1: evim-ru.1
508	iconv -f KOI8-R -t utf-8 $< >$@
509
510vimdiff-ru.UTF-8.1: vimdiff-ru.1
511	iconv -f KOI8-R -t utf-8 $< >$@
512
513vimtutor-ru.UTF-8.1: vimtutor-ru.1
514	iconv -f KOI8-R -t utf-8 $< >$@
515
516xxd-ru.UTF-8.1: xxd-ru.1
517	iconv -f KOI8-R -t utf-8 $< >$@
518
519vim-tr.UTF-8.1: vim-tr.1
520	iconv -f latin5 -t utf-8 $< >$@
521
522evim-tr.UTF-8.1: evim-tr.1
523	iconv -f latin5 -t utf-8 $< >$@
524
525vimdiff-tr.UTF-8.1: vimdiff-tr.1
526	iconv -f latin5 -t utf-8 $< >$@
527
528vimtutor-tr.UTF-8.1: vimtutor-tr.1
529	iconv -f latin5 -t utf-8 $< >$@
530