<?xml version="1.0"?>
<!DOCTYPE riscos-prm PUBLIC "-//Gerph//DTD PRM documentation 1.03//EN"
                            "http://gerph.org/dtd/103/prm.dtd">

<riscos-prm>
<chapter title="OwnerBanner (system banner)">
<section title="Introduction">
<p>
Under earlier versions of RISC OS, the Kernel would display a banner during start up.
To allow customisation, this banner was moved to a new module, OwnerBanner.</p>

<p>The OwnerBanner's purpose is to announce the system information when the system
    boots, and present owner information when the desktop is entered.
</p>
</section>


<section title="Technical details">
<p>
    The OwnerBanner module listens for two services:
</p>
<p>
    <list>
        <item><reference type='service' name='DesktopWelcome' href='?'/>: Displays a notice about the owner of the machine.</item>
        <item><reference type='service' name='OSInitBanner'/>: Displays the OS startup banner, amount of memory, hardware being used and the owner information.</item>
    </list>
</p>
<p>The owner information is read from the ROM using <reference type='swi' name='OS_ReadSysInfo' reason='9' href='?'/>.</p>

<p>
    <version-table>
        <version riscos-ge='4.10' supplier='RISCOS Ltd'>
            The OwnerBanner module was first supplied with RISC OS 4.10, used for personalised
            masked and flash ROMs.
            The start up banner will display the system information, and the user's name
            and address as burnt into the ROM if present. During desktop startup the user's
            name will be displayed.
        </version>
        <version riscos-ge='7.43' supplier='RISC OS Pyromaniac'>
            The OwnerBanner module was first supplied with RISC OS Pyromaniac version 7.43.
            The start up banner will display the system information, and the user's name
            and address as burnt into the ROM if present, or configured through the
            'rominformation' group.
            No sprites are displayed in this version, and the desktop banner is omitted.
        </version>
    </version-table>
</p>

</section>


<section title="Service calls">

<service-definition name="OSInitBanner"
                    number="CF"
                    description="System system start up banner">
<entry>
 <register-use number="0">Pointer a 0-terminated string indicating the processor in use, or 0 if no processor name is supplied.</register-use>
 <register-use number="1">&hex;CF (reason code)</register-use>
</entry>

<exit>
 <register-use number="1">0 to claim this service and prevent further banners being displayed. Preserved to allow other clients to display banners.</register-use>
</exit>

<use>
<p>This service is issued by the Kernel when the system initialisation has completed, immediately after changing to the configured mode. Clients should use the VDU system to display a suitable startup banner to inform the user of the machine details.</p>

<p>
    The values supplied for the processor under RISC OS Select were:
</p>
<p>
    <list>
        <item>600</item>
        <item>610</item>
        <item>700</item>
        <item>710</item>
        <item>810</item>
        <item>SA110</item>
        <item>7500</item>
        <item>7500FE</item>
        <item>SA110_2</item>
    </list>
</p>
</use>

<compatibility>
    <version riscos-ge='4.10' supplier='RISCOS Ltd' state='supported'/>
    <version riscos-ge='7.01' supplier='RISC OS Pyromaniac' state='supported'/>
</compatibility>

<related>
<!-- <reference type="sysvar" name="Sys$Variable" /> -->
</related>

</service-definition>
</section>


</chapter>

<!-- MetaData -->
<meta>
 <maintainer>
  <email name="Gerph" address="gerph@gerph.org" />
 </maintainer>
 <disclaimer>
    <p>
        &copy; Gerph, 2022.
    </p>
 </disclaimer>

 <history>
  <revision number="1" author="Gerph" date="28 Dec 2022" title="Initial version">
    <change>Created</change>
  </revision>

  <revision number="2" author="Gerph" date="17 Sep 2023" title="Cleaned up version information">
    <change>Version information is now in compatibility sections.</change>
    <change>Support in different systems has been made clearer.</change>
  </revision>
 </history>

</meta>
</riscos-prm>
