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