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