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