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