diff options
author | Richard Hughes <richard@hughsie.com> | 2007-01-29 00:09:49 +0000 |
---|---|---|
committer | Richard Hughes <richard@hughsie.com> | 2007-01-29 00:09:49 +0000 |
commit | bd705c6cb98de49ce1ab21ad7115a2ed4fad6c5e (patch) | |
tree | 6a21a1dd71e02ef64da61da2ba9b3ce99af1ee0e /docs | |
parent | 1dfa9ec6df631663059c9e97afc64eff3716a8bd (diff) |
Add some initial core values
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.html | 34 | ||||
-rw-r--r-- | docs/introduction.xml | 74 |
2 files changed, 105 insertions, 3 deletions
diff --git a/docs/index.html b/docs/index.html index 869f76e..2dab382 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@ a small team of developers. </p><p> OHM : <span class="emphasis"><em>"Resistance is futile"</em></span> - </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#introduction">1. Open Hardware Manager Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#introduction-description">Overall Description</a></span></dt><dt><span class="sect1"><a href="#introduction-usecases">Use Cases</a></span></dt><dd><dl><dt><span class="sect2"><a href="#introduction-usecases-embedded">Embedded use cases</a></span></dt><dt><span class="sect2"><a href="#introduction-usecases-pc">Desktop or laptop use cases</a></span></dt></dl></dd><dt><span class="sect1"><a href="#introduction-deps">Dependencies</a></span></dt></dl></dd><dt><span class="chapter"><a href="#plugins">2. Plugins</a></span></dt><dd><dl><dt><span class="sect1"><a href="#plugins-introduction">Introduction</a></span></dt><dd><dl><dt><span class="sect2"><a href="#plugins-key-defaults">Plugin Key Defaults</a></span></dt><dt><span class="sect2"><a href="#plugins-system-start">System Start</a></span></dt><dt><span class="sect2"><a href="#plugins-other-plugins">Plugin Dependencies</a></span></dt><dt><span class="sect2"><a href="#plugins-acccess-to-keys">Plugin access to keys</a></span></dt><dt><span class="sect2"><a href="#plugins-session-access">Session Access to keys</a></span></dt></dl></dd><dt><span class="sect1"><a href="#plugins-defaults">Default plugins</a></span></dt><dd><dl><dt><span class="sect2"><a href="#plugins-backlight">Backlight Adjustment</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#dbus-interface">3. DBUS Interface</a></span></dt><dd><dl><dt><span class="sect1"><a href="#pm-intro">Introduction</a></span></dt><dt><span class="sect1"><a href="#pm-manager">Manager functionality</a></span></dt><dd><dl><dt><span class="sect2"><a href="#pm-manager-keys"> + </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#introduction">1. Open Hardware Manager Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#introduction-description">Overall Description</a></span></dt><dt><span class="sect1"><a href="#introduction-usecases">Use Cases</a></span></dt><dd><dl><dt><span class="sect2"><a href="#introduction-usecases-embedded">Embedded use cases</a></span></dt><dt><span class="sect2"><a href="#introduction-usecases-pc">Desktop or laptop use cases</a></span></dt></dl></dd><dt><span class="sect1"><a href="#introduction-core">OHM Core Values</a></span></dt><dt><span class="sect1"><a href="#introduction-deps">Dependencies</a></span></dt></dl></dd><dt><span class="chapter"><a href="#plugins">2. Plugins</a></span></dt><dd><dl><dt><span class="sect1"><a href="#plugins-introduction">Introduction</a></span></dt><dd><dl><dt><span class="sect2"><a href="#plugins-key-defaults">Plugin Key Defaults</a></span></dt><dt><span class="sect2"><a href="#plugins-system-start">System Start</a></span></dt><dt><span class="sect2"><a href="#plugins-other-plugins">Plugin Dependencies</a></span></dt><dt><span class="sect2"><a href="#plugins-acccess-to-keys">Plugin access to keys</a></span></dt><dt><span class="sect2"><a href="#plugins-session-access">Session Access to keys</a></span></dt></dl></dd><dt><span class="sect1"><a href="#plugins-defaults">Default plugins</a></span></dt><dd><dl><dt><span class="sect2"><a href="#plugins-backlight">Backlight Adjustment</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#dbus-interface">3. DBUS Interface</a></span></dt><dd><dl><dt><span class="sect1"><a href="#pm-intro">Introduction</a></span></dt><dt><span class="sect1"><a href="#pm-manager">Manager functionality</a></span></dt><dd><dl><dt><span class="sect2"><a href="#pm-manager-keys"> <code class="literal">Exported keys</code> </a></span></dt><dt><span class="sect2"><a href="#pm-manager-GetVersion"> <code class="literal">GetVersion()</code> @@ -60,7 +60,7 @@ <code class="literal">hald</code>? </a></span></dt><dt><span class="sect1"><a href="#faq-shellscripts"> Can I execute shell scripts from OHM on an event? - </a></span></dt></dl></dd></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="introduction"></a>Chapter 1. Open Hardware Manager Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#introduction-description">Overall Description</a></span></dt><dt><span class="sect1"><a href="#introduction-usecases">Use Cases</a></span></dt><dd><dl><dt><span class="sect2"><a href="#introduction-usecases-embedded">Embedded use cases</a></span></dt><dt><span class="sect2"><a href="#introduction-usecases-pc">Desktop or laptop use cases</a></span></dt></dl></dd><dt><span class="sect1"><a href="#introduction-deps">Dependencies</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="introduction-description"></a>Overall Description</h2></div></div></div><p> + </a></span></dt></dl></dd></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="introduction"></a>Chapter 1. Open Hardware Manager Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#introduction-description">Overall Description</a></span></dt><dt><span class="sect1"><a href="#introduction-usecases">Use Cases</a></span></dt><dd><dl><dt><span class="sect2"><a href="#introduction-usecases-embedded">Embedded use cases</a></span></dt><dt><span class="sect2"><a href="#introduction-usecases-pc">Desktop or laptop use cases</a></span></dt></dl></dd><dt><span class="sect1"><a href="#introduction-core">OHM Core Values</a></span></dt><dt><span class="sect1"><a href="#introduction-deps">Dependencies</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="introduction-description"></a>Overall Description</h2></div></div></div><p> OHM is a small open source systems daemon which sits above HAL and abstracts out common hardware management tasks such as: </p><div class="itemizedlist"><ul type="disc"><li><p> @@ -189,7 +189,35 @@ Alice is informed that Bob is in the process of a large download, howver as she has admin rights she can override Bob's request and shut the machine down. - </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="introduction-deps"></a>Dependencies</h2></div></div></div><p> + </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="introduction-core"></a>OHM Core Values</h2></div></div></div><p> + The OHM daemon with all management modules suitable for the platform loaded should: + </p><div class="itemizedlist"><ul type="disc"><li><p> + not have a binary size of over 200k in size + </p></li><li><p> + start in less than 200ms on 100MHz ARM + </p></li><li><p> + use less than 200k of private memory + </p></li><li><p> + be platform neutral, i.e. use HAL wherever possible + </p></li><li><p> + be plug-able so proprietary code can be used where required. + </p></li><li><p> + be simple to change preferences for the session + </p></li><li><p> + be secure so system policy cannot be changed + </p></li><li><p> + be session-aware so that multiple users can be active + </p></li><li><p> + not rely on any odd toolkits or high level programming frameworks + </p></li><li><p> + be efficient enough to do complex rule processing with minimum CPU load + </p></li><li><p> + be bug free and have no memory leaks so the daemon will never crash + </p></li><li><p> + be an open and supported project, rather than a quick custom hack + </p></li><li><p> + integrate well with modern desktops like GNOME where required + </p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="introduction-deps"></a>Dependencies</h2></div></div></div><p> OHM is lightweight. </p><div class="itemizedlist"><ul type="disc"><li><p> GLib 2.10.0 (required) diff --git a/docs/introduction.xml b/docs/introduction.xml index 0f77dc6..1ffbef6 100644 --- a/docs/introduction.xml +++ b/docs/introduction.xml @@ -245,6 +245,80 @@ </sect2> </sect1> + <sect1 id="introduction-core"> + <title>OHM Core Values</title> + <para> + The OHM daemon with all management modules suitable for the platform loaded should: + </para> + <itemizedlist> + <listitem> + <para> + not have a binary size of over 200k in size + </para> + </listitem> + <listitem> + <para> + start in less than 200ms on 100MHz ARM + </para> + </listitem> + <listitem> + <para> + use less than 200k of private memory + </para> + </listitem> + <listitem> + <para> + be platform neutral, i.e. use HAL wherever possible + </para> + </listitem> + <listitem> + <para> + be plug-able so proprietary code can be used where required. + </para> + </listitem> + <listitem> + <para> + be simple to change preferences for the session + </para> + </listitem> + <listitem> + <para> + be secure so system policy cannot be changed + </para> + </listitem> + <listitem> + <para> + be session-aware so that multiple users can be active + </para> + </listitem> + <listitem> + <para> + not rely on any odd toolkits or high level programming frameworks + </para> + </listitem> + <listitem> + <para> + be efficient enough to do complex rule processing with minimum CPU load + </para> + </listitem> + <listitem> + <para> + be bug free and have no memory leaks so the daemon will never crash + </para> + </listitem> + <listitem> + <para> + be an open and supported project, rather than a quick custom hack + </para> + </listitem> + <listitem> + <para> + integrate well with modern desktops like GNOME where required + </para> + </listitem> + </itemizedlist> + </sect1> + <sect1 id="introduction-deps"> <title>Dependencies</title> <para> |