Add a section on proper installation of OMF files. Note, these steps have

not yet been done for all the existing GNOME applications, but there is
work underway to correct that.
This commit is contained in:
Joe Marcus Clarke 2003-01-28 06:49:26 +00:00
parent 331a2fbcc2
commit b3a9dd6462
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/www/; revision=15828

View file

@ -1,6 +1,6 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" [
<!ENTITY base CDATA "../..">
<!ENTITY date "$FreeBSD: www/en/gnome/docs/porting.sgml,v 1.24 2002/09/19 21:45:36 marcus Exp $">
<!ENTITY date "$FreeBSD: www/en/gnome/docs/porting.sgml,v 1.25 2002/12/08 06:59:44 adamw Exp $">
<!ENTITY title "FreeBSD GNOME Project: How To Make a Port">
<!ENTITY % gnomeincludes SYSTEM "../includes.sgml"> %gnomeincludes;
<!ENTITY % includes SYSTEM "../../includes.sgml"> %includes;
@ -313,6 +313,34 @@ WANT_IMLIB
<p>These are now deprecated.</p>
<!-- End GNOME-related Makefile macros -->
<!-- Begin GNOME OMF -->
<h2>OMF Installation</h2>
<p>A large number of GNOME applications (especially GNOME 2
applications) install Open Source Metadata Framework (OMF)
files which contain the help file information for those
applications. These OMF files require special processing
by ScrollKeeper in order for applications like Yelp to
find help documentation. In order to accomplish proper
registry of these OMF files when installing GNOME applications
from packages, you should make sure your port's
<tt>pkg-plist</tt> has the following for <em>each</em> OMF file
listed.</p>
<pre>
@exec scrollkeeper-install -q %D/path/to/help_file.omf 2&gt;/dev/null || /usr/bin/true
@unexec scrollkeeper-uninstall -q %D/path/to/help_file.omf 2&gt;/dev/null || /usr/bin/true
</pre>
<p>For example:</p>
<pre>
@exec scrollkeeper-install -q %D/share/gnome/bug-buddy/bug-buddy-C.omf 2&gt;/dev/null || /usr/bin/true
@unexec scrollkeeper-uninstall -q %D/share/gnome/bug-buddy/bug-buddy-C.omf 2&gt;/dev/null || /usr/bin/true
</pre>
<!-- End GNOME OMF -->
<!-- Begin GNOME libtool -->
<h2>Libtool Issues</h2>