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