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