xref: /vim-8.2.3635/runtime/doc/Makefile (revision dfccaf0f)
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_expl.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	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_expl.html \
193	pi_gzip.html \
194	pi_netrw.html \
195	pi_spec.html \
196	print.html \
197	quickfix.html \
198	quickref.html \
199	quotes.html \
200	recover.html \
201	remote.html \
202	repeat.html \
203	rileft.html \
204	russian.html \
205	scroll.html \
206	sign.html \
207	sponsor.html \
208	starting.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
259.SUFFIXES:
260.SUFFIXES: .c .o .txt .html
261
262all: tags vim.man vimdiff.man vimtutor.man xxd.man
263
264# Use Vim to generate the tags file.  Can only be used when Vim has been
265# compiled and installed.  Supports multiple languages.
266vimtags: $(DOCS)
267	$(VIMEXE) -u NONE -esX -c "helptags ." -c quit
268
269# Use "doctags" to generate the tags file.  Only works for English!
270tags: doctags $(DOCS)
271	./doctags $(DOCS) | LANG=C LC_ALL=C sort >tags
272	uniq -d -2 tags
273
274doctags: doctags.c
275	$(CC) doctags.c -o doctags
276
277vim.man: vim.1
278	nroff -man vim.1 | sed -e s/.//g > vim.man
279
280vimdiff.man: vimdiff.1
281	nroff -man vimdiff.1 | sed -e s/.//g > vimdiff.man
282
283vimtutor.man: vimtutor.1
284	nroff -man vimtutor.1 | sed -e s/.//g > vimtutor.man
285
286xxd.man: xxd.1
287	nroff -man xxd.1 | sed -e s/.//g > xxd.man
288
289uganda.nsis.txt: uganda.txt
290	sed -e 's/[ 	]*\*[-a-zA-Z0-9.]*\*//g' -e 's/vim:tw=78://' \
291		uganda.txt | uniq >uganda.nsis.txt
292
293# Awk version of .txt to .html conversion.
294html: noerrors tags tags.ref $(HTMLS)
295	@if test -f errors.log; then more errors.log; fi
296
297noerrors:
298	-rm -f errors.log
299
300.txt.html:
301	$(AWK) -f makehtml.awk $< >$@
302
303tags.ref tags.html: tags
304	$(AWK) -f maketags.awk tags >tags.html
305
306# Perl version of .txt to .html conversion.
307# There can't be two rules to produce a .html from a .txt file.
308# Just run over all .txt files each time one changes.  It's fast anyway.
309perlhtml: tags $(DOCS)
310	./vim2html.pl tags $(DOCS)
311
312clean:
313	-rm doctags *.html tags.ref
314
315# These files are in the extra archive, skip if not present
316
317arabic.txt:
318	touch arabic.txt
319
320farsi.txt:
321	touch farsi.txt
322
323hebrew.txt:
324	touch hebrew.txt
325
326russian.txt:
327	touch russian.txt
328
329gui_w16.txt:
330	touch gui_w16.txt
331
332gui_w32.txt:
333	touch gui_w32.txt
334
335if_ole.txt:
336	touch if_ole.txt
337
338os_390.txt:
339	touch os_390.txt
340
341os_amiga.txt:
342	touch os_amiga.txt
343
344os_beos.txt:
345	touch os_beos.txt
346
347os_dos.txt:
348	touch os_dos.txt
349
350os_mac.txt:
351	touch os_mac.txt
352
353os_mint.txt:
354	touch os_mint.txt
355
356os_msdos.txt:
357	touch os_msdos.txt
358
359os_os2.txt:
360	touch os_os2.txt
361
362os_qnx.txt:
363	touch os_qnx.txt
364
365os_risc.txt:
366	touch os_risc.txt
367
368os_win32.txt:
369	touch os_win32.txt
370