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