VirtualBox

source: vbox/trunk/doc/manual/Makefile.kmk@ 86577

Last change on this file since 86577 was 86317, checked in by vboxsync, 4 years ago

bugref:9831. scm fixes
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 39.9 KB
Line 
1# $Id: Makefile.kmk 86317 2020-09-28 11:59:32Z vboxsync $
2## @file
3# Sub-Makefile for the VirtualBox User Manual, SDK reference and other manuals.
4#
5
6#
7# Copyright (C) 2006-2020 Oracle Corporation
8#
9# This file is part of VirtualBox Open Source Edition (OSE), as
10# available from http://www.virtualbox.org. This file is free software;
11# you can redistribute it and/or modify it under the terms of the GNU
12# General Public License (GPL) as published by the Free Software
13# Foundation, in version 2 as it comes in the "COPYING" file of the
14# VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15# hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16#
17
18#
19# This slightly messy makefile transforms the DocBook XML source for the
20# user manual into presentation output. We support two targets:
21#
22# -- UserManual.pdf, generated by LaTex
23#
24# -- VirtualBox.chm
25#
26# Both files end up in PATH_STAGE_BIN.
27#
28# Both targets indirectly depend on the XML files in this directory;
29# "indirectly" because we first copy them to PATH_TARGET and hack them
30# up a bit for variable substitution and such (see below).
31# The toolchains are roughly like this:
32#
33# -- PDF file via Apache FOP: pre-process the XML files in PATH_TARGET,
34# then create a .FO file (another XML format for "formatted objects")
35# via xsltproc, then feed the .FO file to Apache FOP to create the PDF.
36#
37# -- PDF file via LaTeX: pre-process the XML files in PATH_TARGET, then
38# run our custom "dblatex" perl script on UserManual.xml, which parses
39# the XML (using the Perl SAX parsers) and dumps a matching LaTeX file
40# to UserManual.tex. This is then regularly processed by pdflatex to
41# generate PDF.
42#
43# -- CHM file: again, pre-process the XML files in PATH_TARGET, then use
44# xsltproc to create a .HHP file for the Microsoft Help Compiler, then
45# feed that file to it.
46#
47
48SUB_DEPTH = ../..
49include $(KBUILD_PATH)/subheader.kmk
50
51ifndef VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED
52 include $(PATH_SUB_CURRENT)/Config.kmk
53endif
54
55
56#
57# Globals
58#
59
60# Error out if someone tries to override old globals.
61ifdef HTMLHELPOPTS
62 $(error HTMLHELPOPTS was renamed to VBOX_HTMLHELP_OPTS!)
63endif
64ifdef DOCBOOKPATH
65 $(error DOCBOOKPATH was renamed to VBOX_PATH_DOCBOOK!)
66endif
67ifdef DOCBOOKPATH
68 $(error DOCBOOKPATH was renamed to VBOX_PATH_DOCBOOK!)
69endif
70ifdef XML_CATALOG
71 $(error XML_CATALOG was renamed to VBOX_XML_CATALOG!)
72endif
73ifdef XML_CATALOG_DOCBOOK
74 $(error XML_CATALOG_DOCBOOK was renamed to VBOX_XML_CATALOG_DOCBOOK!)
75endif
76ifdef VBOXMANAGEPATH
77 $(error VBOXMANAGEPATH was renamed to VBOXMANAGEHELP_PATH!)
78endif
79ifdef PDFLATEX_INTERACTION
80 $(error PDFLATEX_INTERACTION was renamed to VBOX_PDFLATEX_INTERACTION!)
81endif
82ifdef PDFLATEX
83 $(error PDFLATEX was renamed to VBOX_PDFLATEX_CMD!)
84endif
85ifdef HHC
86 $(error HHC was renamed to VBOX_HHC!)
87endif
88
89
90
91VBOXMANAGEHELP_PATH ?= $(PATH_STAGE_BIN)/VBoxManageHelp$(SUFF_EXE)
92
93 # VBOX_PDFLATEX_INTERACTION = errorstopmode - Use this when you wants to figure out build failures
94 # without catting the log a million times.
95VBOX_PDFLATEX_INTERACTION ?= batchmode
96ifeq ($(KBUILD_HOST),win)
97 ifndef VBOX_PDFLATEX
98 VBOX_PDFLATEX := $(firstword $(rsort $(wildcard $(KBUILD_DEVTOOLS)/win.x86/miktex-portable/*/miktex/bin/pdflatex.exe)))
99 ifneq ($(VBOX_PDFLATEX),)
100 VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION)
101 endif
102 endif
103 ifndef VBOX_PDFLATEX
104 # Tell MiKTeX to automatically download packages if system wide install.
105 VBOX_PDFLATEX := pdflatex
106 VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION) --enable-installer
107 endif
108else
109 VBOX_PDFLATEX ?= pdflatex
110 VBOX_PDFLATEX_HALT = $(shell ( $(VBOX_PDFLATEX) -version | head -1 | grep 141592 > /dev/null ) && echo -halt-on-error )
111 VBOX_PDFLATEX_CMD = pdflatex $(VBOX_PDFLATEX_HALT) -interaction $(VBOX_PDFLATEX_INTERACTION)
112endif
113
114# Windows HTML Help Workshop compiler (stupid thing always returns an error!)
115VBOX_HHC = -$(EXEC_X86_WIN32) $(VBOX_PATH_HTML_HELP_WORKSHOP)/hhc.exe
116
117
118# Additional xsltproc options when generating
119VBOX_HTMLHELP_OPTS ?=
120
121# SDK related globals.
122VBOX_MANUAL_APIREF_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml
123VBOX_DOC_XIDL_SRC = $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
124VBOX_DOC_XIDL_SRC_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.xidl.tmp
125
126
127#
128# Targets
129#
130
131BLDDIRS += $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, $(VBOX_MANUAL_LANGUAGES))
132
133if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
134 if defined(VBOX_ONLY_SDK) || defined(VBOX_WITH_DOCS_SDKREF)
135 INSTALLS += VBox-docs-sdkref
136 endif
137
138 ifdef VBOX_WITH_DOCS_HTML
139 INSTALLS += VBox-docs-usermanual-html
140 VBOX_PATH_BIN_HTML = $(PATH_STAGE_BIN)/UserManual-html.zip
141 else # Do not build html.
142 VBOX_PATH_BIN_HTML =
143 endif
144
145 ifdef VBOX_WITH_DOCS_CHM
146 INSTALLS += VBox-docs-usermanual-chm
147 VBOX_PATH_BIN_CHM = $(PATH_STAGE_BIN)/VirtualBox.chm
148 else # Do not build chm.
149 VBOX_PATH_BIN_CHM =
150 endif
151
152 ifdef VBOX_WITH_DOCS_QHELP
153 INSTALLS += VBox-docs-usermanual-qhc
154 INSTALLS += VBox-docs-usermanual-qch
155 VBOX_PATH_BIN_QHELP = $(PATH_STAGE_BIN)/UserManual.qch
156 VBOX_PATH_BIN_QHELP += $(PATH_STAGE_BIN)/UserManual.qhc
157 else # Do not build chm.
158 VBOX_PATH_BIN_QHELP =
159 endif
160
161
162 ifndef VBOX_ONLY_SDK
163 VBOX_MANUAL_PACK += \
164 $(PATH_STAGE_BIN)/UserManual.pdf \
165 $(VBOX_PATH_BIN_HTML) \
166 $(VBOX_PATH_BIN_CHM) \
167 $(VBOX_PATH_BIN_QHELP)
168 INSTALLS += VBox-docs-usermanual
169
170 ifdef VBOX_WITH_DOCS_TRANSLATIONS
171 INSTALLS += VBox-docs-usermanual-l10n
172 VBOX_MANUAL_PACK += \
173 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
174 ifdef VBOX_WITH_DOCS_CHM
175 INSTALLS += VBox-docs-usermanual-l10n-chm
176 VBOX_MANUAL_PACK += \
177 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
178 endif
179 endif
180 endif # !VBOX_ONLY_SDK
181
182 ifdef VBOX_WITH_DOCS_ACCESSIBILITY
183 INSTALLS += VBox-docs-accessibility
184 INSTALLS += VBox-docs-accessibility-html
185 endif
186
187 ifdef VBOX_ONLY_DOCS
188 PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
189 endif
190
191 ifdef VBOX_WITH_DOCS_TRANSLATIONS
192 VBOX_MANUAL_LANGUAGES += $(VBOX_MANUAL_ADD_LANGUAGES)
193 endif
194
195$(foreach lang,$(VBOX_MANUAL_LANGUAGES), \
196 $(eval VBOX_MANUAL_XML_FILES_GENERATED_$$(lang) := \
197 $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
198 $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/overview_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
199 $$(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml \
200 $$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_man_VBoxHeadless.xml \
201 $$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_man_vboximg-mount.xml \
202 $$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_isomakercmd-man.xml))
203
204 VBOX_SDKREF_XML_FILES = \
205 SDKRef.xml
206
207 VBOX_ACCESSIBILITY_XML_FILES = \
208 Accessibility.xml
209
210 VBOX_QHCP_FILES = \
211 UserManual.qhcp
212
213 # Wildcard the images path for every supported language
214 $(foreach f,$(VBOX_MANUAL_LANGUAGES), \
215 $(eval VBOX_MANUAL_PNG_FILES_$$(f) := $$(patsubst $$(VBOX_PATH_MANUAL_SRC)/$$(f)/%,%,$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$$(f)/images/*.png))))
216
217 VBOX_MANUAL_TEX_UNICODE_FILES = \
218 $(wildcard $(VBOX_PATH_MANUAL_SRC)/texfiles/unicode/*)
219
220 VBOX_MANUAL_LATEX_FILES_TARGET = \
221 $(addprefix UserManual.,aux log out toc tex)
222
223 VBOX_SDKREF_LATEX_FILES_TARGET = \
224 $(addprefix SDKRef.,aux log out toc tex)
225
226 VBOX_ACCESSIBILITY_LATEX_FILES_TARGET = \
227 $(addprefix Accessibility.,aux log out toc tex)
228
229 BLDDIRS += \
230 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/,\
231 $(addsuffix /images, $(VBOX_MANUAL_LANGUAGES)) \
232 $(addsuffix /html-single, $(VBOX_MANUAL_LANGUAGES)) \
233 $(addsuffix /html-chunks, $(VBOX_MANUAL_LANGUAGES)) \
234 $(addsuffix /HTMLHelp, $(VBOX_MANUAL_LANGUAGES)) \
235 $(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_LANGUAGES)) \
236 )
237
238 # Explicit cleaning has some overlap with default cleaning rules, since this
239 # Makefile is using very complex conditionals for selectively creating
240 # specific files, and not everyone remembers to use the same with "kmk clean".
241 OTHER_CLEAN += \
242 $(VBOX_XML_CATALOG) \
243 $(VBOX_XML_CATALOG_DOCBOOK) \
244 $(VBOX_XML_CATALOG_MANUAL) \
245 $(VBOX_XML_ENTITIES) \
246 $(VBOX_XML_XREF_TO_TEXT) \
247 $(VBOX_XML_XREF_TO_TEXT).cat \
248 $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \
249 $(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
250 $(VBOX_MANUAL_XML_REFENTRY_FILES) \
251 $(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
252 man_VBoxHeadless.xml \
253 user_man_VBoxHeadless.xml \
254 man_vboximg-mount.xml \
255 user_man_vboximg-mount.xml \
256 isomakercmd-man.xml \
257 user_isomakercmd-man.xml \
258 $(VBOX_MANUAL_LATEX_FILES_TARGET) \
259 $(VBOX_MANUAL_PNG_FILES_$(lang)) \
260 $(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
261 $(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
262 html-single/UserManual.xhtml \
263 html-single/UserManual.qhp \
264 html-single/UserManual.qhcp \
265 html-single/UserManual.qhc \
266 html-single/UserManual.qch \
267 $(addprefix HTMLHelp/, index.html go01.html) \
268 $(addprefix html-chunks/, index.html go01.html) \
269 $(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
270 ,html-chunks/ch$(n).html \
271 html-chunks/re$(n).html \
272 HTMLHelp/ch$(n).html \
273 HTMLHelp/re$(n).html \
274 $(foreach d2,0 1 2 3 4 5 6 7 8 9,$(foreach d1,0 1 2 3 4 5 6 7 8 9,HTMLHelp/ch$(n)s$(d2)$(d1).html)) ) \
275 $(foreach n,a b c \
276 ,html-chunks/ap$(n).html \
277 HTMLHelp/ap$(n).html \
278 $(foreach s,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20,HTMLHelp/ap$(n)s$(s).html) ) \
279 $(foreach n,01 02 03 04 05 \
280 ,html-chunks/pr$(n).html \
281 HTMLHelp/pr$(n).html \
282 $(foreach s,01 02 03 04 05 06 07 08,HTMLHelp/pr$(n)s$(s).html) ) \
283 HTMLHelp/toc.hhc \
284 HTMLHelp/htmlhelp.hhp \
285 UserManual.pdf \
286 VirtualBox.chm \
287 ChangeLog.html \
288 validatemanual.run \
289 validateaccessibility.run \
290 validatesdkref.run \
291 )) \
292 $(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
293 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
294 $(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml \
295 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
296 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm) \
297 $(PATH_STAGE_BIN)/UserManual.pdf \
298 $(PATH_STAGE_BIN)/VirtualBox.chm \
299 \
300 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
301 $(VBOX_SDKREF_LATEX_FILES_TARGET) \
302 SDKRef.pdf \
303 ) \
304 $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf \
305 \
306 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
307 $(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET) \
308 html-single/Accessibility.html \
309 Accessibility.pdf \
310 ) \
311 $(PATH_STAGE_BIN)/Accessibility.html \
312 $(PATH_STAGE_BIN)/Accessibility.pdf \
313 \
314 $(VBOX_DOC_XIDL_SRC_TMP) \
315 $(VBOX_MANUAL_APIREF_TMP)
316
317endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
318
319#
320# target for installing UserManual.pdf
321#
322VBox-docs-usermanual_INST = $(INST_BIN)
323VBox-docs-usermanual_MODE = a+r,u+w
324VBox-docs-usermanual_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
325
326VBox-docs-usermanual-qhc_INST = $(INST_BIN)
327VBox-docs-usermanual-qhc_MODE = a+r,u+w
328VBox-docs-usermanual-qhc_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qhc
329
330VBox-docs-usermanual-qch_INST = $(INST_BIN)
331VBox-docs-usermanual-qch_MODE = a+r,u+w
332VBox-docs-usermanual-qch_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qch
333
334#
335# target for installing translated UserManual_*.pdf
336#
337VBox-docs-usermanual-l10n_INST = $(INST_BIN)
338VBox-docs-usermanual-l10n_MODE = a+r,u+w
339VBox-docs-usermanual-l10n_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
340
341#
342# target for installing the chunked HTML docs
343#
344VBox-docs-usermanual-html_INST = $(INST_BIN)
345VBox-docs-usermanual-html_MODE = a+r,u+w
346VBox-docs-usermanual-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip=>UserManual-html.zip
347
348#
349# target for installing VirtualBox.chm
350#
351VBox-docs-usermanual-chm_INST = $(INST_BIN)
352VBox-docs-usermanual-chm_MODE = a+r,u+w
353VBox-docs-usermanual-chm_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
354
355#
356# target for installing translated VirtualBox_*.chm
357#
358VBox-docs-usermanual-l10n-chm_INST = $(INST_BIN)
359VBox-docs-usermanual-l10n-chm_MODE = a+r,u+w
360VBox-docs-usermanual-l10n-chm_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/VirtualBox.chm=>VirtualBox_$(f).chm)
361
362#
363# target for installing SDKRef.pdf
364#
365VBox-docs-sdkref_INST = $(INST_SDK)docs/
366VBox-docs-sdkref_MODE = a+r,u+w
367VBox-docs-sdkref_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
368
369#
370# target for installing Accessibility.pdf
371#
372VBox-docs-accessibility_INST = $(INST_BIN)
373VBox-docs-accessibility_MODE = a+r,u+w
374VBox-docs-accessibility_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf
375
376#
377# target for installing Accessibility.html
378#
379VBox-docs-accessibility-html_INST = $(INST_BIN)
380VBox-docs-accessibility-html_MODE = a+r,u+w
381VBox-docs-accessibility-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
382
383if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
384
385##
386# Morph man pages into manual sections.
387# $(evalcall2 def_vbox_refentry_to_user_sect1)
388# @param 1 Language.
389# @param 2 the refentry xml base file name.
390# @param 3 the full refentry xml file path.
391define def_vbox_refentry_to_user_sect1
392$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/user_$(2): $(3) \
393 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl \
394 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
395 $$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
396 $$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(filter %.xml,$$^),$$@)
397 $$(QUIET)$$(RM) -f "$$@"
398 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $$<
399endef
400$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
401man_VBoxHeadless.xml \
402man_vboximg-mount.xml \
403, $(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),$(file),$(VBOX_PATH_MANUAL_SRC)/$(lang)/$(file))))
404$(foreach lang,$(VBOX_MANUAL_LANGUAGES) \
405,$(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),isomakercmd-man.xml,$(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
406
407
408# Generates the VBoxManage command overview include file (shared between
409# languages) from the refsynopsisdiv section of the man pages.
410$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)): \
411 $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-overview.xsl \
412 $$(patsubst overview_%,$$(VBOX_PATH_MANUAL_SRC)/en_US/%,$$(notdir $$@)) \
413 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
414 $(VBOX_XML_ENTITIES) | $$(dir $$@)
415 $(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
416 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" $< $(filter %.xml,$^)
417
418$(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml: $(VBOXMANAGEHELP_PATH) $(MAKEFILE_CURRENT) | $$(dir $$@)
419 $(call MSG_GENERATE,,$@,)
420 $(QUIET)$(RM) -f $@ [email protected]
421 $(QUIET)$(APPEND) -tn "$@" \
422 '<?xml version="1.0" encoding="UTF-8"?>' \
423 '<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">' \
424 '<sect1> <!-- this will be skipped via xpointer in the include. --> '
425 $(QUIET)$(REDIRECT) -wo [email protected] -E 'VBOX_LOG_FLAGS=disabled' -E 'VBOX_LOG_DEST=nofile' \
426 $(if $(eq $(KBUILD_TARGET),darwin), -E 'DYLD_FALLBACK_LIBRARY_PATH=$(dir $(LIB_RUNTIME))') \
427 -- \
428 $(VBOXMANAGEHELP_PATH) --dumpopts
429 $(QUIET)$(SED) \
430 -e ':a' \
431 -e 'N' \
432 -e '$(DOLLAR)!ba' \
433 -e 's/</\&lt\;/g' \
434 -e 's/>/\&gt\;/g' \
435 -e 's/\n*$(DOLLAR)/<\/screen>/' \
436 -e 's/^/<screen>/' \
437 --append $@ [email protected]
438 $(QUIET)$(RM) -f [email protected]
439 $(QUIET)$(APPEND) -n "$@" \
440 ' <remark role="VBoxManage-overview">' \
441 $(foreach refentry, $(filter man_VBoxManage%,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
442 , ' <xi:include href="overview_$(refentry)" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />') \
443 ' </remark>' \
444 '</sect1>'
445
446
447
448
449##########################################################################################
450#
451# Shared rules for PDF generation
452#
453##########################################################################################
454
455ifndef VBOX_OSE
456# copy ucs.sty and related files
457$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/ucs.sty):
458 $(call MSG_L1,Copying unicode support for LaTeX)
459 $(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_MANUAL_TEX_UNICODE_FILES) "$(@D)"
460endif
461
462# copy the PNG files.
463# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
464define def_vbox_cp_images_pdf
465local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
466$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
467 $$(out_dir)/%: $(VBOX_PATH_MANUAL_SRC)/$(lang)/% | $$$$(dir $$$$@)
468 $$(call MSG_L1,Copying temporary $$< => $$@)
469 $$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
470endef
471$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_cp_images_pdf))
472
473
474##########################################################################################
475#
476# UserManual.pdf
477#
478##########################################################################################
479
480
481# Generate PDF from LaTeX
482# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
483define def_vbox_usermanual_tex_to_pdf
484local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
485$$(out_dir)/UserManual.pdf: \
486 $$(out_dir)/UserManual.tex \
487 $$(if $$(VBOX_OSE),,$$(out_dir)/ucs.sty) \
488 $$(addprefix $$(out_dir)/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) | $$$$(dir $$$$@)
489# PDF generation via Latex: generate the .tex file
490 $$(call MSG_L1,pdflatex $$< (four passes) -> $$@)
491 $$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
492 $$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
493 $$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
494 $$(QUIET)$$(REDIRECT) -w+ti /dev/null -C $$(@D) -- $$(VBOX_PDFLATEX_CMD) UserManual.tex
495 $$(QUIET)$$(SED) -ne '/Warning: Hyper reference/p' $$(basename $$<).log
496 $$(QUIET)$$(SED) -n \
497 -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
498 $$(basename $$@).log
499 $$(call MSG_L1,Fresh LaTeX-generated PDF is now at $$@)
500endef
501$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_tex_to_pdf))
502
503# Generate LaTeX from XML
504# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
505define def_vbox_usermanual_xml_to_tex
506local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
507$$(out_dir)/UserManual.tex: \
508 $$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
509 $$(VBOX_MANUAL_XML_FILES_COMMON) \
510 $$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
511 $$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
512 $$(if $$(VBOX_HAVE_XMLLINT),$$(out_dir)/validatemanual.run,) \
513 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
514 $$(VBOX_XML_ENTITIES) $$(MAKEFILE_CURRENT) | $$$$(dir $$$$@)
515 $$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(firstword $$(filter %.xml,$$^)),$$@)
516 $$(QUIET)$$(RM) -f $$(addprefix $$(@D)/,$$(VBOX_MANUAL_LATEX_FILES_TARGET))
517# generate TeX source from processed docbook and store it in UserManual.tex.tmp;
518# pass current language to xsltproc in TARGETLANG variable
519 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG $(lang) \
520 -o [email protected] $$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $$<
521# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
522# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
523 $$(QUIET)$$(SED) \
524 -e 's|^\\QUOTE{}|\\OQ{}|g' \
525 -e 's|\(\W\)\\QUOTE{}|\1\\OQ{}|g' \
526 -e 's|\(\w\)\\QUOTE{}|\1\\CQ{}|g' \
527 --output $$@ [email protected]
528 $$(QUIET)$$(RM) -f [email protected]
529endef
530$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_xml_to_tex))
531
532# Useful aliases
533usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
534
535debug-usermanual:
536 $(MAKE) --pretty-command-printing -j1 VBOX_PDFLATEX_INTERACTION=errorstopmode $(PATH_STAGE_BIN)/UserManual.pdf
537
538#
539# Generate rules for validating the UserManual.xml. These are invoked
540# automatically at build time, but can also be manually invoked via the
541# 'validatemanual' and 'validatemanual_<lang>' aliases.
542#
543define def_vbox_validate_xml
544validatemanual_$(lang):: $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/validatemanual.run
545$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/validatemanual.run: \
546 $$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
547 $$(VBOX_MANUAL_XML_FILES_COMMON) \
548 $$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
549 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
550 $$(VBOX_XML_ENTITIES) $$(MAKEFILE_CURRENT) | $$$$(dir $$$$@)
551 $$(call MSG_L1,Validating $$<)
552 $$(QUIET)$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$<
553 $$(QUIET)$$(APPEND) -t "$$@" "done"
554endef
555$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_validate_xml))
556
557
558# Handy aliases.
559validatemanual:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),validatemanual_$(lang))
560
561
562
563#
564# SDKRef.pdf
565#
566
567# Replace <tt> tags in VirtualBox.xidl.
568$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) | $$(dir $$@)
569 $(call MSG_L1,Generating $@)
570 $(QUIET)$(SED) -e 's|@a \+\(\w\+\)|<tt>\1</tt>|g' \
571 -e 's|@c \+\(\w\+\)|<tt>\1</tt>|g' \
572 --output $@ $<
573
574# Generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
575$(VBOX_MANUAL_APIREF_TMP): $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
576 $(call MSG_L1,Generating $@)
577 $(QUIET)$(VBOX_XSLTPROC) $(VBOX_XSLTPROC_OPTS) --xinclude --nonet -o $@ $< $(VBOX_DOC_XIDL_SRC_TMP)
578
579# Turn SDKRef.xml into LaTeX.
580$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: \
581 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
582 $(VBOX_MANUAL_APIREF_TMP) \
583 $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
584 $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run,) \
585 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
586 $(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) | $$(dir $$@)
587 $(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
588 $(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
589# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
590 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
591 -o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
592# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
593# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
594 $(QUIET)$(SED) \
595 -e 's|^\\QUOTE{}|\\OQ{}|g' \
596 -e 's|\(\W\)\\QUOTE{}|\1\\OQ{}|g' \
597 -e 's|\(\w\)\\QUOTE{}|\1\\CQ{}|g' \
598 --output $@ [email protected]
599 $(QUIET)$(RM) -f [email protected]
600
601# Turn SDKRef.tex into a PDF.
602$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf: \
603 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
604 $(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
605 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) | $$(dir $$@)
606 $(call MSG_L1,pdflatex $< (three passes))
607 $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
608 $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
609 $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
610 $(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
611 $(QUIET)$(SED) -n \
612 -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
613 $(basename $<).log
614 $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
615
616# Validating SDKRef.xml. It is invoked automatically at build time,
617# but can also be manually invoked via the 'validate-sdkref' alias.
618$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run: \
619 $(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef.xml \
620 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
621 $(VBOX_MANUAL_APIREF_TMP) \
622 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
623 $(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) | $$(dir $$@)
624 $(call MSG_L1,Validating $<)
625 $(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
626 $(QUIET)$(APPEND) -t "$@" "done"
627
628
629# Handy aliases.
630validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run
631sdkref:: $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
632
633
634
635#
636# Accessibility.pdf
637#
638
639# Turn Accessibility.xml into LaTeX.
640$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex: \
641 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
642 $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
643 $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run,) \
644 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
645 $(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) | $$(dir $$@)
646 $(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
647 $(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET))
648# generate TeX source from processed docbook and store it in Accessibility.tex.tmp
649 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
650 -o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
651# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
652# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
653 $(QUIET)$(SED) \
654 -e 's|^\\QUOTE{}|\\OQ{}|g' \
655 -e 's|\(\W\)\\QUOTE{}|\1\\OQ{}|g' \
656 -e 's|\(\w\)\\QUOTE{}|\1\\CQ{}|g' \
657 --output $@ [email protected]
658 $(QUIET)$(RM) -f [email protected]
659
660# Turn Accessibility.tex into a PDF.
661$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf: \
662 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex \
663 $(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
664 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) | $$(dir $$@)
665 $(call MSG_L1,pdflatex $< (three passes))
666 $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
667 $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
668 $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
669 $(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
670 $(QUIET)$(SED) -n \
671 -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
672 $(basename $<).log
673 $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
674
675$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html: \
676 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
677 $(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
678 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
679 $(VBOX_XML_ENTITIES) | $$(dir $$@)
680 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
681 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
682 --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html \
683 $(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
684 $<
685
686# Validating Accessibility.xml. It is invoked automatically at build time,
687# but can also be manually invoked via the 'validate-accessibility' alias.
688$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run: \
689 $(VBOX_PATH_MANUAL_SRC)/en_US/Accessibility.xml \
690 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
691 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
692 $(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) | $$(dir $$@)
693 $(call MSG_L1,Validating $<)
694 $(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
695 $(QUIET)$(APPEND) -t "$@" "done"
696
697
698# Handy aliases.
699validate-accessibility:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run
700accessibility:: $(PATH_STAGE_BIN)/Accessibility.pdf
701accessibility-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
702
703
704
705ifdef VBOX_WITH_DOCS_CHM
706 #
707 # VirtualBox.chm
708 #
709 # We first generate a .hhp help source file from the preprocessed
710 # DocBook XML files, as defined above, then feed that into the
711 # Microsoft Help Compiler.
712 #
713 VBOX_DOCBOOK_HTMLHELP_FORMATCFG = \
714 $(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
715 $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
716 $(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
717
718 # Prepare the XSL file for our title page, htmlhelp variant.
719 $(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl: \
720 $(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) | $$(dir $$@)
721 $(call MSG_L1,xsltproc $<)
722 $(QUIET)$(RM) -f [email protected] $@
723 $(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o [email protected] $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $<
724 $(QUIET)$(MV) -f [email protected] $@
725
726 # Generate CHM from HHP
727 # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
728 define def_vbox_usermanual_hhp_to_chm
729 local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
730 $$(out_dir)/VirtualBox.chm: \
731 $$(out_dir)/HTMLHelp/htmlhelp.hhp \
732 $$(addprefix $$(out_dir)/HTMLHelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
733 | $$$$(dir $$$$@)
734 $$(call MSG_L1,hhc $$<,=> $$@)
735 $$(QUIET)$$(RM) -f $$@
736 $$(QUIET)$$(VBOX_HHC) $$(subst /,\\,$$<)
737 $$(call MSG_L1,Fresh CHM is now at $$@)
738 endef
739 $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_hhp_to_chm))
740
741 # Generate HHP from XML
742 # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
743 define def_vbox_usermanual_xml_to_hhp
744 local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
745 $$(out_dir)/HTMLHelp/htmlhelp.hhp: \
746 $$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
747 $$(VBOX_MANUAL_XML_FILES_COMMON) \
748 $$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
749 $$(VBOX_DOCBOOK_HTMLHELP_FORMATCFG) \
750 $$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
751 $$(if $$(VBOX_HAVE_XMLLINT),$$(out_dir)/validatemanual.run,) \
752 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
753 $$(VBOX_XML_ENTITIES) | $$$$(dir $$$$@)
754 $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
755 $$(QUIET)$$(RM) -f $$@
756 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$(@D)/ \
757 --stringparam htmlhelp.chm \
758 $$(subst /,\\,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/VirtualBox.chm) \
759 $$(HTMLHELPOPTS) $$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
760 $$<
761 endef
762 $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_xml_to_hhp))
763
764 # copy the PNG files.
765 # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
766 define def_vbox_cp_images_htmlhelp
767 local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/HTMLHelp
768 $(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
769 $$(out_dir)/%: $(VBOX_PATH_MANUAL_SRC)/$(lang)/% | $$$$(dir $$$$@)
770 $$(call MSG_L1,Copying temporary $$< => $$@)
771 $$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
772 endef
773 $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_htmlhelp)))
774
775endif # VBOX_WITH_DOCS_CHM
776
777
778# Packing the docs into a zip file
779$(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
780 $(call MSG_L1,Packing documentation $@)
781 $(QUIET)$(RM) -f $@
782 $(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
783
784
785##########################################################################################
786#
787# UserManual.xhtml
788#
789##########################################################################################
790VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG = \
791 $(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
792 $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
793 $(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
794
795$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.xhtml: \
796 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
797 $(VBOX_MANUAL_XML_FILES_COMMON) \
798 $(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
799 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
800 $(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
801 $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
802 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
803 $(VBOX_XML_ENTITIES) | $$(dir $$@)
804 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
805 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
806 --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.xhtml \
807 $(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
808 $<
809
810VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG = \
811 $(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl \
812 $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
813 $(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
814
815$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
816 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
817 $(VBOX_MANUAL_XML_FILES_COMMON) \
818 $(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
819 $(VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG) \
820 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
821 $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
822 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
823 $(VBOX_XML_ENTITIES) | $$(dir $$@)
824 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
825 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
826 --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
827 --stringparam chunk.section.depth 0 \
828 $(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl \
829 $<
830
831$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
832 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.xhtml \
833 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
834 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
835 $(call MSG_L1,Packing documentation $@)
836 $(QUIET)$(RM) -f $@
837 $(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
838 -9 -r $@ html-single html-chunks $(VBOX_MANUAL_PNG_FILES_en_US)
839
840html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.xhtml
841html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
842qhelp:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qhc
843html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
844
845
846#
847# ChangeLog.html
848#
849# This XSLT rule formats en_US/user_ChangeLog.xml (which includes the actual change log
850# contained in user_ChangeLogImpl.xml) as a standalone HTML file.
851#
852$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
853 $(VBOX_PATH_MANUAL_SRC)/en_US/docbook-changelog-formatcfg.xsl \
854 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
855 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
856 $(VBOX_XML_ENTITIES) | $$(dir $$@)
857 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
858 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" "$<" $(filter %.xml,$^)
859 $(call MSG_L1,Fresh ChangeLog.html is now at $@)
860
861cl-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
862
863
864
865endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
866
867
868#
869# VBoxManage man pages (parts also required by VBoxManage built-in help).
870#
871
872##
873# Emits rules for preprocessing refentry sources (applying remarks element),
874# and for producing the actual man pages.
875# $(evalcall2 def_vbox_refentry_to_manpage)
876# @param 1 The language
877# @param 2 The file name (no path).
878define def_vbox_refentry_to_manpage
879$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
880 $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
881 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
882 $$(VBOX_XML_XREF_TO_TEXT) \
883 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
884 $$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
885 $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
886 $$(QUIET)$$(RM) -f "$$@"
887 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
888 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
889 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output [email protected] $$(VBOX_XML_XREF_TO_TEXT) $$@
890 $$(QUIET)$$(MV) -f -- "[email protected]" "$$@"
891if defined(VBOX_HAVE_XMLLINT)
892 $$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
893endif
894
895$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
896 $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
897 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl \
898 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
899 $$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
900 $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
901 $$(QUIET)$$(RM) -f "$$@"
902 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl $$<
903endef
904$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
905, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
906
907################Generate qHelp's qhp file out of UserManual.xhtml###############################
908$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qhp: \
909 $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
910 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
911 $(VBOX_XML_ENTITIES) | $$(dir $$@) \
912 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.xhtml
913 $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
914 $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
915 --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qhp \
916 $(VBOX_PATH_MANUAL_SRC)/xhtml-qhelp.xsl \
917 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.xhtml
918
919################Copy qhcp file from the source directory###############################
920$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qhcp: \
921 $$(dir $$@)
922 $(QUIET)$(INSTALL_STAGING) -m0664 -- $(addprefix $(VBOX_PATH_MANUAL_SRC)/, $(VBOX_QHCP_FILES)) $@
923
924$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qhc: \
925 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qhcp \
926 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qhp \
927 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/, $(VBOX_MANUAL_PNG_FILES_en_US))
928 qcollectiongenerator $<
929
930$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/, images):
931 mkdir -p $@
932
933$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/, $(VBOX_MANUAL_PNG_FILES_en_US)): \
934 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/, $(VBOX_MANUAL_PNG_FILES_en_US)) \
935 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/, images)
936 $(QUIET)$(INSTALL_STAGING) -m0644 -- $< $@
937
938$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qch: \
939 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.qhc
940
941# Handy aliases.
942validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
943man-experiment:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
944 ,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
945
946#
947# Manually updating the DHCP option list taken from VirtualBox.xidl
948#
949dhcpoptions: $(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl \
950 $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
951 $(call VBOX_XSLTPROC) --output "$(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml" $+
952
953
954include $(FILE_KBUILD_SUB_FOOTER)
955
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette