VirtualBox

source: vbox/trunk/doc/manual/Config.kmk@ 94209

Last change on this file since 94209 was 94209, checked in by vboxsync, 3 years ago

doc/manual,FE/VBoxManage: Convert guestcontrol command to refentry documentation, ​bugref:9186
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 23.6 KB
Line 
1# $Id: Config.kmk 94209 2022-03-13 20:16:15Z vboxsync $
2## @file
3# kBuild Configuration file for the manual.
4#
5
6#
7# Copyright (C) 2010-2022 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
18ifndef VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED
19VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED = 1
20
21# Include the top-level configure file.
22ifndef VBOX_ROOT_CONFIG_KMK_INCLUDED
23 include $(PATH_ROOT)/Config.kmk
24endif
25
26
27#
28# Globals.
29#
30
31# Source location.
32VBOX_PATH_MANUAL_SRC := $(PATH_ROOT)/doc/manual
33# Output location.
34VBOX_PATH_MANUAL_OUTBASE := $(PATH_OBJ)/manual
35
36## List of refentry files (manpages).
37VBOX_MANUAL_XML_REFENTRY_FILES := \
38 man_VBoxManage.xml \
39 man_VBoxManage-list.xml \
40 man_VBoxManage-showvminfo.xml \
41 man_VBoxManage-registervm.xml \
42 man_VBoxManage-unregistervm.xml \
43 man_VBoxManage-createvm.xml \
44 man_VBoxManage-modifyvm.xml \
45 man_VBoxManage-snapshot.xml \
46 man_VBoxManage-clonevm.xml \
47 man_VBoxManage-movevm.xml \
48 man_VBoxManage-startvm.xml \
49 man_VBoxManage-controlvm.xml \
50 man_VBoxManage-import.xml \
51 man_VBoxManage-export.xml \
52 man_VBoxManage-mediumio.xml \
53 man_VBoxManage-sharedfolder.xml \
54 man_VBoxManage-dhcpserver.xml \
55 man_VBoxManage-debugvm.xml \
56 man_VBoxManage-extpack.xml \
57 man_VBoxManage-unattended.xml \
58 man_VBoxManage-cloud.xml \
59 man_VBoxManage-cloudprofile.xml \
60 man_VBoxManage-signova.xml \
61 man_VBoxManage-modifynvram.xml \
62 man_VBoxManage-hostonlynet.xml \
63 man_VBoxManage-updatecheck.xml \
64 man_VBoxManage-discardstate.xml \
65 man_VBoxManage-adoptstate.xml \
66 man_VBoxManage-closemedium.xml \
67 man_VBoxManage-storagectl.xml \
68 man_VBoxManage-bandwidthctl.xml \
69 man_VBoxManage-showmediuminfo.xml \
70 man_VBoxManage-createmedium.xml \
71 man_VBoxManage-clonemedium.xml \
72 man_VBoxManage-mediumproperty.xml \
73 man_VBoxManage-encryptmedium.xml \
74 man_VBoxManage-checkmediumpwd.xml \
75 man_VBoxManage-convertfromraw.xml \
76 man_VBoxManage-setextradata.xml \
77 man_VBoxManage-getextradata.xml \
78 man_VBoxManage-setproperty.xml \
79 man_VBoxManage-usbfilter.xml \
80 man_VBoxManage-guestproperty.xml \
81 man_VBoxManage-guestcontrol.xml
82
83## List of user manual XML files.
84VBOX_MANUAL_XML_FILES = \
85 UserManual.xml \
86 user_Preface.xml \
87 user_Introduction.xml \
88 user_Installation.xml \
89 user_BasicConcepts.xml \
90 user_GuestAdditions.xml \
91 user_Storage.xml \
92 user_Networking.xml \
93 user_Frontends.xml \
94 user_VBoxManage.xml \
95 user_AdvancedTopics.xml \
96 user_Technical.xml \
97 user_VirtualBoxAPI.xml \
98 user_Troubleshooting.xml \
99 user_Security.xml \
100 user_KnownIssues.xml \
101 user_ChangeLog.xml \
102 user_ThirdParty.xml \
103 user_PrivacyPolicy.xml \
104 user_Glossary.xml \
105 oracle-accessibility-en.xml \
106 oracle-diversity.xml \
107 oracle-support-en.xml
108
109## List of user manual XML files common for all languages.
110VBOX_MANUAL_XML_FILES_COMMON = \
111 $(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml
112
113
114# Tool locations.
115ifndef VBOX_OSE
116 # use docbook from our tools directory
117 VBOX_PATH_DOCBOOK ?= $(KBUILD_DEVTOOLS)/common/DocBook/v1.69.1
118 VBOX_PATH_DOCBOOK_DTD ?= $(KBUILD_DEVTOOLS)/common/docbook-xml/v4.5
119else
120 # use docbook of the build host
121 VBOX_PATH_DOCBOOK ?= /usr/share/xml/docbook/stylesheet/docbook-xsl
122 VBOX_PATH_DOCBOOK_DTD ?= /usr/share/xml/docbook/schema/dtd/4.5
123endif
124VBOX_XML_CATALOG ?= $(VBOX_PATH_MANUAL_OUTBASE)/vbox-doc.cat
125VBOX_XML_CATALOG_DOCBOOK ?= $(VBOX_PATH_MANUAL_OUTBASE)/docbook.cat
126VBOX_XML_CATALOG_MANUAL ?= $(VBOX_PATH_MANUAL_OUTBASE)/manual.cat
127VBOX_XML_ENTITIES ?= $(VBOX_PATH_MANUAL_OUTBASE)/all-entities.ent
128
129# xsltproc with the catalog trick if applicable (set XML_DEBUG_CATALOG to
130# non-zero value to debug file/uri resolution through the catalogs, using
131# one of them is enough, they show the same information).
132ifdef VBOX_XML_CATALOG
133 VBOX_XSLTPROC_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(if $(2),$(2),$(VBOX_XML_CATALOG))" -E "XML_DEBUG_CATALOG=" $1 -- \
134 $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS) --path "$(VBOX_PATH_MANUAL_OUTBASE)"
135 VBOX_XMLLINT_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -E "XML_DEBUG_CATALOG=" -- \
136 $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS) --path "$(VBOX_PATH_MANUAL_OUTBASE)"
137else
138 VBOX_XSLTPROC_WITH_CAT = $(if $(1), $(REDIRECT) $1 --,) $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS) \
139 --path "$(VBOX_PATH_MANUAL_OUTBASE)"
140 VBOX_XMLLINT_WITH_CAT = $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS) --path "$(VBOX_PATH_MANUAL_OUTBASE)"
141endif
142
143
144# File name of the generated stylesheet for transforming xref elements into
145# name user manual sections.
146VBOX_XML_XREF_TO_TEXT = xref-to-text.xsl
147
148##
149# Emits rules for preprocessing refentry sources (applying remarks element),
150# and for producing the actual man pages.
151#
152# $(evalcall2 def_vbox_refentry_preprocess_for_manpage)
153# @param 1 The output directory.
154# @param 2 The XML file name (no path).
155# @param 3 The XML file with full path.
156# @param 4 Non-empty if xrefs to replace.
157# @param 5 Language code (optional if $4 is empty).
158define def_vbox_refentry_preprocess_for_manpage
159$(1)/$(2): \
160 $(3) \
161 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
162 $(if $(4), $$(VBOX_PATH_MANUAL_OUTBASE)/$(5)/$$(VBOX_XML_XREF_TO_TEXT),) \
163 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
164 $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
165 $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
166 $$(QUIET)$$(RM) -f "$$@"
167 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
168 "$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl" $$<
169ifneq ($(4),)
170 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output [email protected] \
171 $$(VBOX_PATH_MANUAL_OUTBASE)/$(5)/$$(VBOX_XML_XREF_TO_TEXT) $$@
172 $$(QUIET)$$(MV) -f -- "[email protected]" "$$@"
173endif
174if defined(VBOX_HAVE_XMLLINT) && "$(USER)" == "bird" # Effing stuff happends on build servers, probably kmk related...
175 $$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
176endif
177endef
178
179##
180# Generate a single header file containing everything (no C file).
181#
182# @param 1 Destination file.
183# @param 2 Full source file path.
184# @param 3 Help infix.
185define def_vbox_single_refentry_to_h
186$(1).ts +| $(1): \
187 $$(VBOX_DOCBOOK_REFENTRY_TO_C_HELP) \
188 $$(VBOX_DOCBOOK_REFENTRY_TO_H_HELP) \
189 $(2) \
190 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) $(MAKEFILE) | $$$$(dir $$$$@)
191 $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(filter %.xml,$$^),$$(patsubst %.ts,%,$$@))
192 $$(QUIET)$$(APPEND) -tn "$$@" \
193 '/* Autogenerated by $$(notdir $$(filter %.xsl,$$^)), do not edit! */' \
194 '' \
195 '#include <iprt/message.h>' \
196 '#include <iprt/assertcompile.h>' \
197 '' \
198 'typedef enum HELP_CMD_$(3)' \
199 '{' \
200 ' HELP_CMD_INVALID = 0,'
201 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT, -a+to "$$@") \
202 --stringparam 'g_sMode' 'cmd' $$(VBOX_DOCBOOK_REFENTRY_TO_H_HELP) $(2)
203 $$(QUIET)$$(APPEND) -n "$$@" \
204 ' HELP_CMD_END' \
205 '} HELP_CMD_VBOXMANAGE;' \
206 ''
207 $$(NLTAB)$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT, -a+to "$$@") \
208 --stringparam 'g_sMode' 'subcmd' $$(VBOX_DOCBOOK_REFENTRY_TO_H_HELP) $(2)
209 $$(QUIET)$$(APPEND) -n "$$@" \
210 ''
211 $$(NLTAB)$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT, -a+to "$$@") $$(VBOX_DOCBOOK_REFENTRY_TO_C_HELP) $(2)
212 $$(QUIET)$$(APPEND) -n "$$@" \
213 '' \
214 '/* end of file */'
215 $$(QUIET)$$(CP) --changed -- "$$@" "$$(patsubst %.ts,%,$$@)"
216endef
217
218
219#
220# Make sure we've got a rule to make the output directory.
221#
222BLDDIRS += $(VBOX_PATH_MANUAL_OUTBASE)
223
224
225ifdef VBOX_XML_CATALOG
226 # Trickery for making sure that the file:/// URLs end up with exactly 3
227 # slashes, both on Unixy OSes (where the absolute path contributes one more,
228 # and some very picky xsltproc variants are floating around which do not work
229 # quite correctly with file:////, doing incorrect filename transformations)
230 # and on Windows (where the absolute path starts with a drive letter).
231 VBOX_FILE_URL_MAYBE_SLASH = $(if $(eq $(KBUILD_HOST),win),/,)
232 #
233 # To avoid network I/O for fetching DTDs, we generate catalogs mapping the public
234 # entity IDs to local files. (Obviously, only done when we have local files.)
235 #
236 # Create a catalog file for xsltproc that points to docbook catalog.
237 $(VBOX_XML_CATALOG): $(VBOX_PATH_MANUAL_SRC)/Config.kmk | $$(dir $$@)
238 $(call MSG_L1,Creating catalog $@)
239 $(QUIET)$(APPEND) -tn "$@" \
240 '<?xml version="1.0"?>' \
241 '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \
242 '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \
243 ' <delegatePublic publicIdStartString="-//OASIS/ENTITIES DocBook XML" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
244 ' <delegatePublic publicIdStartString="-//OASIS/DTD DocBook XML" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
245 ' <delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
246 ' <delegateSystem systemIdStartString="http://docbook.org/" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
247 ' <delegateURI uriStartString="http://www.oasis-open.org/docbook/" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
248 ' <delegateURI uriStartString="http://docbook.org/" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
249 ' <delegateSystem systemIdStartString="$(VBOX_PATH_MANUAL_SRC)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
250 ' <delegateSystem systemIdStartString="$(VBOX_PATH_MANUAL_OUTBASE)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
251 ' <delegateURI uriStartString="$(VBOX_PATH_MANUAL_SRC)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
252 ' <delegateURI uriStartString="$(VBOX_PATH_MANUAL_OUTBASE)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
253 ' <delegateURI uriStartString="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
254 ' <delegateURI uriStartString="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
255 '</catalog>'
256
257 # Create a docbook catalog file for xsltproc that points to the local docbook files.
258 $(VBOX_XML_CATALOG_DOCBOOK): $(VBOX_PATH_MANUAL_SRC)/Config.kmk | $$(dir $$@)
259 $(call MSG_L1,Creating catalog $@)
260 $(QUIET)$(APPEND) -tn "$@" \
261 '<?xml version="1.0"?>' \
262 '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \
263 '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \
264 ' <public publicId="-//OASIS//ELEMENTS DocBook XML Information Pool V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/dbpoolx.mod"/>' \
265 ' <public publicId="-//OASIS//DTD DocBook XML V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd"/>' \
266 ' <public publicId="-//OASIS//ENTITIES DocBook XML Character Entities V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/dbcentx.mod"/>' \
267 ' <public publicId="-//OASIS//ENTITIES DocBook XML Notations V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/dbnotnx.mod"/>' \
268 ' <public publicId="-//OASIS//ENTITIES DocBook XML Additional General Entities V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/dbgenent.mod"/>' \
269 ' <public publicId="-//OASIS//ELEMENTS DocBook XML Document Hierarchy V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/dbhierx.mod"/>' \
270 ' <public publicId="-//OASIS//DTD XML Exchange Table Model 19990315//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/soextblx.dtd"/>' \
271 ' <public publicId="-//OASIS//DTD DocBook XML CALS Table Model V4.5//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/calstblx.dtd"/>' \
272 ' <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.5" rewritePrefix="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)"/>' \
273 ' <rewriteSystem systemIdStartString="http://docbook.org/xml/4.5" rewritePrefix="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)"/>' \
274 ' <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.5" rewritePrefix="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)"/>' \
275 ' <rewriteURI uriStartString="http://docbook.org/xml/4.5" rewritePrefix="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)"/>' \
276 ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsa.ent"/>' \
277 ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsb.ent"/>' \
278 ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsc.ent"/>' \
279 ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsn.ent"/>' \
280 ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amso.ent"/>' \
281 ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-amsr.ent"/>' \
282 ' <public publicId="ISO 8879:1986//ENTITIES Box and Line Drawing//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-box.ent"/>' \
283 ' <public publicId="ISO 8879:1986//ENTITIES Russian Cyrillic//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-cyr1.ent"/>' \
284 ' <public publicId="ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-cyr2.ent"/>' \
285 ' <public publicId="ISO 8879:1986//ENTITIES Diacritical Marks//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-dia.ent"/>' \
286 ' <public publicId="ISO 8879:1986//ENTITIES Greek Letters//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk1.ent"/>' \
287 ' <public publicId="ISO 8879:1986//ENTITIES Monotoniko Greek//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk2.ent"/>' \
288 ' <public publicId="ISO 8879:1986//ENTITIES Greek Symbols//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk3.ent"/>' \
289 ' <public publicId="ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-grk4.ent"/>' \
290 ' <public publicId="ISO 8879:1986//ENTITIES Added Latin 1//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-lat1.ent"/>' \
291 ' <public publicId="ISO 8879:1986//ENTITIES Added Latin 2//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-lat2.ent"/>' \
292 ' <public publicId="ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-num.ent"/>' \
293 ' <public publicId="ISO 8879:1986//ENTITIES Publishing//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-pub.ent"/>' \
294 ' <public publicId="ISO 8879:1986//ENTITIES General Technical//EN" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK_DTD)/ent/iso-tech.ent"/>' \
295 '</catalog>'
296
297 # Create a docbook catalog file for xsltproc that points to the local manual files in non-default locations
298 $(VBOX_XML_CATALOG_MANUAL): $(VBOX_PATH_MANUAL_SRC)/Config.kmk | $$(dir $$@)
299 $(call MSG_L1,Creating catalog $@)
300 $(QUIET)$(APPEND) -tn "$@" \
301 '<?xml version="1.0"?>' \
302 '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \
303 '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \
304 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/common/oracle-accessibility-en.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/en_US/oracle-accessibility-en.xml"/>' \
305 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/common/oracle-diversity.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/en_US/oracle-diversity.xml"/>' \
306 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/common/oracle-support-en.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/en_US/oracle-support-en.xml"/>' \
307 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/user_ChangeLogImpl.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml"/>' \
308 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl"/>' \
309 $(foreach x,user_VBoxManage_CommandsOverview.xml user_isomakercmd-man.xml $(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES) man_VBoxHeadless.xml man_vboximg-mount.xml)\
310 ,' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/$(x)" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/en_US/$(x)"/>' \$(NLTAB)$(TAB)) \
311 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef_apiref.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml"/>' \
312 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/all-entities.ent" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/all-entities.ent"/>' \
313 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/html/docbook.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK)/html/docbook.xsl"/>' \
314 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/html/chunk.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK)/html/chunk.xsl"/>' \
315 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/htmlhelp/htmlhelp.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK)/htmlhelp/htmlhelp.xsl"/>' \
316 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/manpages/docbook.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK)/manpages/docbook.xsl"/>' \
317 '</catalog>'
318
319endif # VBOX_XML_CATALOG
320
321
322ifdef VBOX_XML_ENTITIES
323
324 $(VBOX_XML_ENTITIES): $(VBOX_PATH_MANUAL_SRC)/Config.kmk $(VBOX_VERSION_STAMP) | $$(dir $$@)
325 $(call MSG_L1,Creating entities $@)
326 $(QUIET)$(APPEND) -tn "$@" \
327 '<!-- Entities for product names -->' \
328 '<!ENTITY product-version "$(VBOX_VERSION_STRING)">' \
329 '<!ENTITY product-name "Oracle VM VirtualBox">' \
330 '<!ENTITY oci "Oracle Cloud Infrastructure">' \
331 '' \
332 '<!-- VBox placeholder entities -->' \
333 '<!ENTITY VBOX_VERSION_MAJOR "$(VBOX_VERSION_MAJOR)" >' \
334 '<!ENTITY VBOX_VERSION_MINOR "$(VBOX_VERSION_MINOR)" >' \
335 '<!ENTITY VBOX_VERSION_BUILD "$(VBOX_VERSION_BUILD)" >' \
336 '<!ENTITY VBOX_VERSION_STRING "$(VBOX_VERSION_STRING)" >' \
337 '<!ENTITY VBOX_VENDOR "$(VBOX_VENDOR)" >' \
338 '<!ENTITY VBOX_C_YEAR "$(VBOX_C_YEAR)" >' \
339 '<!ENTITY VBOX_PRODUCT '\''<trademark class="registered">Oracle</trademark> VM <trademark class="registered">VirtualBox</trademark>'\'' >' \
340 '' \
341 '<!-- Entities for Oracle Help Center -->' \
342 '<!ENTITY ohc-base-url "https://docs.oracle.com/en">' \
343 '<!ENTITY ohc-doc-page "&ohc-base-url;/virtualization/virtualbox/index.html">'
344
345endif # VBOX_XML_ENTITIES
346
347
348## Emit rules to produce stylesheet for translating cross references (xref)
349# to user manual chapters and sections in the man pages and --help output.
350#
351# Note! This requires processing UserManual.xml as a single document in order
352# to get the correct chapter and section numbering, so we use a catalog
353# file to replace the generated XML documents it includes with a dummy
354# one. This reduces the dependencies and recipies we require to build
355# VBoxManage and the RTIsoMaker (w/ derivatives).
356# $(evalcall2 def_vbox_xref_to_text)
357# @param 1 Language code.
358define def_vbox_xref_to_text
359$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) \
360+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat: \
361 $$(VBOX_PATH_MANUAL_SRC)/$(1)/docbook-refentry-link-replacement-xsl-gen.xsl \
362 $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-link-replacement-xsl-gen.xsl \
363 $$(addprefix $$(VBOX_PATH_MANUAL_SRC)/en_US/,$$(VBOX_MANUAL_XML_FILES)) \
364 $$(VBOX_MANUAL_XML_FILES_COMMON) \
365 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) $$(VBOX_XML_ENTITIES) \
366 | $$$$(dir $$$$@)
367 $$(call MSG_L1,Creating stylesheet $$@)
368 $$(QUIET)$$(APPEND) -nt "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat" \
369 '<?xml version="1.0"?>' \
370 '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \
371 '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \
372 $$(foreach x,user_VBoxManage_CommandsOverview.xml user_isomakercmd-man.xml $$(addprefix user_,$$(VBOX_MANUAL_XML_REFENTRY_FILES) man_VBoxHeadless.xml man_vboximg-mount.xml)\
373 ,' <system systemId="$$(VBOX_PATH_MANUAL_SRC)/en_US/$$(x)" uri="file://$$(VBOX_FILE_URL_MAYBE_SLASH)$$(VBOX_PATH_MANUAL_SRC)/dummy-sect1.xml"/>' \$$(NLTAB)$$(TAB)) \
374 ' <nextCatalog catalog="file://$$(VBOX_FILE_URL_MAYBE_SLASH)$$(VBOX_XML_CATALOG)"/>' \
375 '</catalog>'
376 $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
377 --stringparam 'g_sMode' 'first' --output "$$@" "$$<" $$(filter %UserManual.xml,$$^)
378 # Using en-US version as section and chapter names until user manual is translated as well
379 $$(foreach x, $$(VBOX_MANUAL_XML_REFENTRY_FILES)\
380 ,$$(NLTAB)$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT, -ato "$$@") --stringparam 'g_sMode' 'append' \
381 "$$<" "$$(VBOX_PATH_MANUAL_SRC)/en_US/$$(x)")
382 $$(QUIET)$$(APPEND) -n "$$@" '' '</xsl:stylesheet>'
383
384BLDDIRS += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/
385endef
386# generate rules for $(VBOX_XML_XREF_TO_TEXT)
387$(evalcall2 def_vbox_xref_to_text,en_US)
388
389#
390# Generate rules for editing the refentry to C/H style sheets.
391#
392VBOX_DOCBOOK_REFENTRY_TO_C_HELP = $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-C-help.xsl
393
394VBOX_DOCBOOK_REFENTRY_TO_H_HELP = $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-H-help.xsl
395
396#
397# Manual dependency.
398#
399$(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-C-help.xsl: $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl
400
401
402endif # !defined(VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED)
403
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