Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

* Added more CSS control for menus, buttons, app names, shell commands, paths.

Browse Source 
* Always wanting keyboard graphics for shortcuts, Jorge suggested simple borders
  for simplicity. Great idea! Added.
* Added Jorge's rounded boxes for note/warning/stop plus symbols.
* If anyone wants to fine tune esp. colours, go ahead. Jorge and I are both
  challenged in that department. :)
* A few small corrections and reformatting here and there.
* Excluded the topic "Installation" from the contents until it's further along.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29269 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Joachim Seemer 2009-02-21 11:40:17 +00:00
parent f9e9051d3e
commit e564a3c1f7
90 changed files with 853 additions and 766 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

213
docs/Haiku-doc.css
View File

@ -15,6 +15,7 @@ html {
}
body {
color: #333333;
line-height: 1.5;
margin: 0px;
padding: 0px;
font-family: "DejaVu Sans",Arial,Helvetica,sans-serif;
@ -56,6 +57,7 @@ h4 a:hover, a:active {
color: #0c3762;
}
/* basic text elements */
div.content {
@ -64,6 +66,78 @@ div.content {
margin-right: 40px;
margin-bottom: 50px;
}
/* heading and navigation */
div.logo {
position: relative;
left: 0px;
top: 0px;
background: #efefef;
}
div.logo img {
margin-left: 20px;
}
div.title {
position: absolute;
top: 54px;
right: 40px;
font-size: 1.2em;
line-height: 1.0;
}
div.topnav {
background: #e0e0e0;
line-height: 1.0;
}
div.topnav p {
margin-left: 40px;
margin-top: 0px;
margin-right: 40px;
margin-bottom: 0px;
text-align: right;
font-size: 0.8em;
}
div.bottomnav {
background: #efefef;
}
div.bottomnav p {
margin-left: 40px;
margin-top: 0px;
margin-right: 40px;
margin-bottom: 0px;
text-align: right;
font-size: 0.8em;
}
/* Haiku User Guide styles and layout */
/* Rounded corner boxes */
/* Common declarations */
.box-info, .box-stop, .box-warning {
-webkit-border-radius: 10px;
-khtml-border-radius: 10px;
-moz-border-radius: 10px;
border-radius: 10px;
border-style: dotted;
border-width: thin;
border-color: #dcdcdc;
padding: 15px 15px 15px 80px;
margin-bottom: 15px;
margin-top: 15px;
min-height: 70px;
}
.box-info {
background: #e4ffde url(userguide/images/alert_info_32.png) 15px 15px no-repeat;
}
.box-warning {
background: #fffbc6 url(userguide/images/alert_warning_32.png) 15px 15px no-repeat;
}
.box-stop {
background: #ffeae6 url(userguide/images/alert_stop_32.png) 15px 15px no-repeat;
}
/* More layout and styles */
h1 {
font-size: 1.3em;
font-weight: normal;
@ -86,81 +160,92 @@ h3 {
}
h4 {
font-size: 1.0em;
font-weight: lighter;
font-weight: normal;
color: #0c3762;
margin-top: 30px;
}
p {
text-align: justify;
line-height: 1.3;
}
ol {
padding-left: 20px;
}
ul {
padding-left: 14px;
}
li {
line-height: 1.3;
}
td {
vertical-align: top;
}
td.onelinetop {
vertical-align: top;
white-space: nowrap;
}
li {
line-height: 1.3;
tt {
background-color: #e2e2e2;
font-size: 1.0em;
font-family: monospace;
}
pre {
border-color: #0c3762;
border-style: dotted;
border-width: thin;
margin: 0em;
padding: 1.5em;
background-color: #f0f0f0;
}
pre.terminal { /* Terminal output*/
border-color: #ffb11f;
border-style: dotted;
border-width: thin;
margin: 0em;
padding: 1.5em;
background-color: #3a3a3a;
color: #ffb11f;
}
.menu { /* Menu */
font-size: 1.0em;
font-family: serif;
font-style: italic;
color: #24225e;
}
.button { /* Button */
font-size: 1.0em;
font-family: serif;
font-style: italic;
color: #33583c;
}
.app { /* GUI Application name */
font-size: 1.0em;
font-family: serif;
font-style: italic;
/* color: #5e1c1c; */
color: #5e1c1c;
}
.cli { /* Shell command or file */
background-color: #e8e8e8;
font-size: 0.9em;
font-family: monospace;
}
.path { /* File path */
background-color: #e8e8e8;
font-size: 0.9em;
font-family: monospace;
}
.key { /* Shortcut (separate with   */
-webkit-border-radius: 3px;
-khtml-border-radius: 3px;
-moz-border-radius: 3px;
border-radius: 3px;
border-color: #c7c7c7;
border-style: solid;
border-width: 1px;
padding: 0px 2px 0px 2px;
background-color: #e8e8e8;
font-family: serif;
font-variant: small-caps;
font-size: 0.8em;
}
/* heading and navigation */
div.logo {
position: relative;
left: 0px;
top: 0px;
background: #efefef;
}
div.logo img {
margin-left: 20px;
}
div.title {
position: absolute;
top: 54px;
right: 40px;
font-size: 1.2em;
}
div.topnav {
background: #e0e0e0;
}
div.topnav p {
margin-left: 40px;
margin-top: 0px;
margin-right: 40px;
margin-bottom: 0px;
text-align: right;
font-size: 0.8em;
}
div.bottomnav {
background: #efefef;
}
div.bottomnav p {
margin-left: 40px;
margin-top: 0px;
margin-right: 40px;
margin-bottom: 0px;
text-align: right;
font-size: 0.8em;
}
/* layout elements */
td {
vertical-align: top;
}
td.onelinetop {
vertical-align: top;
white-space: nowrap;
}
tt {
background-color: #f0f0f0;
}
pre.terminal {
border-color: #0c3762;
border-style: dotted;
border-width: thin;
margin: 0em;
padding: 1.5em;
background-color: #f0f0f0;
}

14
docs/userguide/en/applications.html
View File

@ -42,26 +42,26 @@
<h2><a id="install" name="install">Installing applications</a></h2>
<p>Haiku software always comes as an archive. Most of the time it's a ZIP, some old BeOS packages come in Software Valet's PKG format. Software Valet was able to automatically execute installation scripts, so after double-clicking you just select a destination folder and everything's taken care of.<br />
If it's a ZIP archive, double-clicking opens <i>Expander</i> where you also set the destination and unpack it. As explained in the topic <a href="filesystem-layout">Filesystem layout</a>, that destination is either</p>
If it's a ZIP archive, double-clicking opens <span class="app">Expander</span> where you also set the destination and unpack it. As explained in the topic <a href="filesystem-layout">Filesystem layout</a>, that destination is either</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td><tt>/boot/common/apps/</tt></td><td>&#160;&#160;&#160;</td><td> for applications available to every user</td></tr>
<tr><td><tt>/boot/home/apps/</tt></td><td>&#160;&#160;&#160;</td><td> for applications only available to yourself</td></tr>
<tr><td><span class="path">/boot/common/apps/</span></td><td>&#160;&#160;&#160;</td><td> for applications available to every user</td></tr>
<tr><td><span class="path">/boot/home/apps/</span></td><td>&#160;&#160;&#160;</td><td> for applications only available to yourself</td></tr>
</table>
<p>This distinction will only become relevant once Haiku gets multi-user support, of course.</p>
<p>Once the archive is unpacked, you should have a look into the newly created folder. Often you find ReadMe files or other documentation of interest.</p>
<p>Some programs need further configurations. For example, <a href="tracker-add-ons.html">Tracker Add-Ons</a>, Translators or other system enhancing components have to be put into the right folders. Either you'll find a little script file (often with the suffix <tt>.sh</tt>) like <tt>install</tt> that you simply double click to have all taken care of.<br />
Sometimes you'll find folders that link to the correct destination named "<tt>drag [filename] here...</tt>". So, you simply follow that instruction and you're done.</p>
<p>Some programs need further configurations. For example, <a href="tracker-add-ons.html">Tracker Add-Ons</a>, Translators or other system enhancing components have to be put into the right folders. Either you'll find a little script file (often with the suffix <span class="cli">.sh</span>) like <span class="cli">install</span> that you simply double click to have all taken care of.<br />
Sometimes you'll find folders that link to the correct destination named "<span class="cli">drag [filename] here...</span>". So, you simply follow that instruction and you're done.</p>
<p>Most of the time, however, nothing of the sort is necessary and you're done after unpacking.<br />
See topic <a href="deskbar.html">Deskbar</a> or LaunchBox to see how to add shortcuts to your newly installed application.</p>
<h2><a id="uninstall" name="uninstall">Uninstalling applications</a></h2>
<p>If the installation was done with an install script, chances are, there's an uninstall script as well. In that case, double-click it and you're done.<br />
Otherwise, uninstalling is simply done by deleting the application's folder.</p>
<p>This, of course, leaves back possible configuration files in your <tt>~/config/settings</tt> folder. This may be on purpose, if you want to keep those settings in case you'll install it again in the future. Also, when the installation involved those "<tt>drag [filename] here...</tt>" folders, those files are also left behind.</p>
<p>This, of course, leaves back possible configuration files in your <span class="path">~/config/settings</span> folder. This may be on purpose, if you want to keep those settings in case you'll install it again in the future. Also, when the installation involved those "<span class="cli">drag [filename] here...</span>" folders, those files are also left behind.</p>
<p>One method to quickly get to all the app's files is to do a quick query for a significant part of the application's name. This will reveal the app's binary, its installation folder and its settings as well as possible links in the Deskbar etc. Simply select all relevant files and delete them.</p>
<h2><a id="list-of-apps" name="list-of-apps">Haiku's applications</a></h2>
<p>Haiku comes with a set of mostly small but essential applications. You'll find all of them at <tt>/boot/beos/apps/</tt> or <tt>/boot/common/apps/</tt>. Applications that are not usually launched by a double-click on a data file (e.g. ShowImage for image files) can be found in the <i>Applications</i> menu of the Deskbar.</p>
<p>Haiku comes with a set of mostly small but essential applications. You'll find all of them at <span class="path">/boot/beos/apps/</span> or <span class="path">/boot/common/apps/</span>. Applications that are not usually launched by a double-click on a data file (e.g. ShowImage for image files) can be found in the <span class="menu">Applications</span> menu of the Deskbar.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td style="width:24px;"><img src="../images/apps-images/activitymonitor-icon_16.png" alt="icon" width="16" height="16" /></td><td><a href="applications/apps-activitymonitor.html">ActivityMonitor</a></td><td style="width:10px;">&#160;</td>
<td valign="top">A tool to track system resources like CPU and memory usage.</td></tr>

10
docs/userguide/en/applications/apps-activitymonitor.html
View File

@ -37,17 +37,17 @@
<h1><img src="../../images/apps-images/activitymonitor-icon_64.png" alt="activitymonitor-icon_64.png"
width="64" height="64" />ActivityMonitor</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/ActivityMonitor</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/ActivityMonitor settings</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/ActivityMonitor</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/ActivityMonitor settings</span></td></tr>
</table>
<p>You can track system resources by launching the ActivityMonitor and activating different items of interest.
</p>
<img src="../../images/apps-images/activitymonitor.png" alt="activitymonitor.png" width="688" height="340" />
<p>By right-clicking into the window, you can toggle the display of all kinds of resources:<br />
<i>Used/Cached Memory, Swap Space, CPU Usage, Network Receive/Send, Page faults, Semaphores, Ports, Threads, Teams, Running Applications, Raw/Text Clipboard Size, Media Nodes</i></p>
<p>Below the graphics is a legend (hideable from the context menu). You can change their colors and that of the graph's background via drag&amp;drop from any color picker, e.g. from <i>Icon-O-Matic</i>.</p>
<p>You can add more views from the <i>File</i> menu if it gets too crowded.</p>
<p>Below the graphics is a legend (hideable from the context menu). You can change their colors and that of the graph's background via drag&amp;drop from any color picker, e.g. from <span class="app">Icon-O-Matic</span>.</p>
<p>You can add more views from the <span class="menu">File</span> menu if it gets too crowded.</p>
<p>Each view has it's own Replicator handle and can thus be arranged, for example, on the Desktop.</p>
</div>

10
docs/userguide/en/applications/apps-bepdf.html
View File

@ -39,13 +39,13 @@
<h1><img src="../../images/apps-images/bepdf-icon_64.png" alt="bepdf-icon_64.png"
width="64" height="64" />BePDF</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/apps/BePDF/BePDF</tt></td></tr>
<tr><td>Documentation:</td><td></td><td><tt>/boot/apps/BePDF/docs/*</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>/boot/common/settings/BePDF</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/apps/BePDF/BePDF</span></td></tr>
<tr><td>Documentation:</td><td></td><td><span class="path">/boot/apps/BePDF/docs/*</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">/boot/common/settings/BePDF</span></td></tr>
</table>
<p>BePDF is Haiku's fast launching PDF viewer. Besides viewing, it supports annotating and user-defined bookmarking for unencrypted PDFs. It's fully localized for 20 languages at the moment with additional languages being easily added via text files.</p>
<p>BePDF comes with its own documentation as <a href="">HTML</a> or as <a href="">PDF</a>. The later will also open from the menu <i>Help | Show Help..</i>.</p>
<p>BePDF comes with its own documentation as <a href="">HTML</a> or as <a href="">PDF</a>. The later will also open from the menu <span class="menu">Help | Show Help..</span>.</p>
</div>
<!--
<div class="bottomnav">

14
docs/userguide/en/applications/apps-cdplayer.html
View File

@ -39,19 +39,19 @@
<h1><img src="../../images/apps-images/cdplayer-icon_64.png" alt="cdplayer-icon_64.png"
width="64" height="64" />CDPlayer</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/CDPlayer</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/cd/*</tt> - Stores details to all identified CDs</td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/CDPlayer</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/cd/*</span> - Stores details to all identified CDs</td></tr>
</table>
<!-- TODO: Exactly how does it work, once BGA got the cddb daemon finished?
<p>Haiku's simple CD player uses the system's <i>cddb</i> daemon to download artist/album/song names from a server on the internet. This means that a network connection is needed for this identification, of course, and also, privately burned compilations can't be identified.<br />
<p>This data is stored as plain text file containing the album/song names and playing time in <tt>~/cd</tt>. Thus only one look-up after first insertion is needed. Plus, if you need the details of a CD, maybe for creating a nice cover, you now know where to look for it.</p>
<p>Haiku's simple CD player uses the system's <span class="cli">cddb</span> daemon to download artist/album/song names from a server on the internet. This means that a network connection is needed for this identification, of course, and also, privately burned compilations can't be identified.<br />
<p>This data is stored as plain text file containing the album/song names and playing time in <span class="path">~/cd</span>. Thus only one look-up after first insertion is needed. Plus, if you need the details of a CD, maybe for creating a nice cover, you now know where to look for it.</p>
-->
<p><br /></p>
<img src="../../images/apps-images/cdplayer.png" alt="cdplayer.png" width="311" height="187" />
<p>Usage is pretty much what you'd expect from looking at the control buttons.<br />
Activate the <i>Repeat</i> button to the left of <i>Shuffle</i> to loop the complete CD.</p>
<p>If you need more control like playlists, try <i>MediaPlayer</i> instead.</p>
Activate the <span class="button">Repeat</span> button to the left of <span class="button">Shuffle</span> to loop the complete CD.</p>
<p>If you need more control like playlists, try <span class="app">MediaPlayer</span> instead.</p>
</div>
<!--
<div class="bottomnav">

6
docs/userguide/en/applications/apps-codycam.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/codycam-icon_64.png" alt="codycam-icon_64.png"
width="64" height="64" />CodyCam</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/CodyCam</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/codycam</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/CodyCam</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/codycam</span></td></tr>
</table>
<p>With CodyCam you take pictures at a specified interval from a connected webcam or any other video-in device and save it via FTP.</p>

18
docs/userguide/en/applications/apps-deskcalc.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/deskcalc-icon_64.png" alt="deskcalc-icon_64.png"
width="64" height="64" />DeskCalc</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/DeskCalc</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/DeskCalc_settings</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/DeskCalc</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/DeskCalc_settings</span></td></tr>
</table>
<p>DeskCalc is a simple calculator that nevertheless has some nice features that aren't apparent on first sight.</p>
<img src="../../images/apps-images/deskcalc.png" alt="deskcalc.png" width="230" height="171" />
@ -55,13 +55,13 @@ Besides the operators <tt>+</tt>, <tt>-</tt>, <tt>*</tt>, <tt>/</tt>, <tt>%</tt>
Also, be aware that <tt>.</tt> and <tt>,</tt> are both considered floating points, which means you mustn't use them as 1000 separators.</p></li>
<li><p>Right-clicking offers these options:</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td><i>Auto Num Lock</i></td><td style="width:15px;"></td><td>automatically activates the number block when launching DeskCalc</td></tr>
<tr><td><i>Audio Feedback</i></td><td></td><td>plays a sound when showing a result</td></tr>
<tr><td><i>Show Keypad</i></td><td></td><td>hides the keypad when deactivated</td></tr>
<tr><td><span class="menu">Auto Num Lock</span></td><td style="width:15px;"></td><td>automatically activates the number block when launching DeskCalc</td></tr>
<tr><td><span class="menu">Audio Feedback</span></td><td></td><td>plays a sound when showing a result</td></tr>
<tr><td><span class="menu">Show Keypad</span></td><td></td><td>hides the keypad when deactivated</td></tr>
</table></li>
<li><p>You can resize the calculator until it fits your needs and then put it as Replicant onto the Desktop via drag&drop of the symbol in the bottom right corner. Make sure <i>Show Replicants</i> is activated in the Deskbar.</p></li>
<li><p>The keypad can be colored with a drag&amp;drop from any color well, e.g. from <i>Icon-O-Matic</i>.</p></li>
<li><p>You can move up and down in a history of past calculations with the <tt>CURSOR-UP/DOWN</tt> keys.</p></li>
<li><p>You can resize the calculator until it fits your needs and then put it as Replicant onto the Desktop via drag&drop of the symbol in the bottom right corner. Make sure <span class="menu">Show Replicants</span> is activated in the Deskbar.</p></li>
<li><p>The keypad can be colored with a drag&amp;drop from any color well, e.g. from <span class="app">Icon-O-Matic</span>.</p></li>
<li><p>You can move up and down in a history of past calculations with <span class="key">CURSOR</span>&#160;<span class="key">UP</span>/<span class="key">DOWN</span>.</p></li>
<li><p>You can select DeskCalc's contents and drag&amp;drop it into any application. Or you drop it into a Tracker window or onto the Desktop and a text file with that clipping is created there.</p>
<p>Even better, the reverse is also possible:<br />
Create clippings as described at various stages of your calculation and go back to them by drag&amp;dropping them back into DeskCalc.<br />

6
docs/userguide/en/applications/apps-diskprobe.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/diskprobe-icon_64.png" alt="diskprobe-icon_64.png"
width="64" height="64" />DiskProbe</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/DiskProbe</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/DiskProbe_data</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/DiskProbe</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/DiskProbe_data</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-diskusage.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/diskusage-icon_64.png" alt="diskusage-icon_64.png"
width="64" height="64" />DiskUsage</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/DiskUsage</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/DiskUsage</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/DiskUsage</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/DiskUsage</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-drivesetup.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/drivesetup-icon_64.png" alt="drivesetup-icon_64.png"
width="64" height="64" />DriveSetup</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/DriveSetup</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/DriveSetup</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/DriveSetup</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/DriveSetup</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-expander.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/expander-icon_64.png" alt="expander-icon_64.png"
width="64" height="64" />Expander</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>---</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/Expander</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Expander_Settings</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">---</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/Expander</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Expander_Settings</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-firefox.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/firefox-icon_64.png" alt="firefox-icon_64.png"
width="64" height="64" />Firefox</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/apps/Firefox/Firefox</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Mozilla/Firefox/*</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/apps/Firefox/Firefox</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Mozilla/Firefox/*</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-icon-o-matic.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/icon-o-matic-icon_64.png" alt="icon-o-matic-icon_64.png"
width="64" height="64" />Icon-O-Matic</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/Icon-O-Matic</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Icon-O-Matic</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/Icon-O-Matic</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Icon-O-Matic</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-installer.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/installer-icon_64.png" alt="installer-icon_64.png"
width="64" height="64" />Installer</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/Installer</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/???</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/Installer</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/???</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

40
docs/userguide/en/applications/apps-magnify.html
View File

@ -39,33 +39,33 @@
<h1><img src="../../images/apps-images/magnify-icon_64.png" alt="magnify-icon_64.png"
width="64" height="64" />Magnify</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/Magnify</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Magnify_prefs</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/Magnify</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Magnify_prefs</span></td></tr>
</table>
<p>Magnify shows an enlarged version of the area around your mouse pointer.</p>
<img src="../../images/apps-images/magnify.png" alt="magnify.png" width="292" height="384" />
<p>At the top you'll find the size and magnification level of the area. "<i>32 x 32 @ 8 pixels/pixel</i>" means that you look at a 32x32 pixel square around your mouse pointer and every pixel is enlarged by a factor of 8.</p>
<p>Below that is the color of the pixel that's marked by a red outline. Its color is presented as RGB and hex value.<br />
You can move the red outline with the <tt>CURSOR</tt> keys.</p>
<p>To measure distances and align objects, you can add up to two blue crosshairs with <tt>ALT+H</tt>. Their X/Y coordinates toward the top left corner and, if both are added, their X/Y distance from each other, are displayed at the bottom.<br />
They can also be moved with the <tt>CURSOR</tt> keys. The active crosshair is marked with an "x".</p>
<p>You can move the mouse pointer pixel by pixel with <tt>AltGr+CURSOR</tt> keys.</p>
You can move the red outline with <span class="key">CURSOR</span>.</p>
<p>To measure distances and align objects, you can add up to two blue crosshairs with <span class="key">ALT+H</span>. Their X/Y coordinates toward the top left corner and, if both are added, their X/Y distance from each other, are displayed at the bottom.<br />
They can also be moved with the <span class="key">CURSOR</span> keys. The active crosshair is marked with an "x".</p>
<p>You can move the mouse pointer pixel by pixel with <span class="key">AltGr</span>&#160;<span class="key">CURSOR</span> keys.</p>
<p>Clicking on the drop-down menu gives you a number of options:</p>
<table summary="options" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Save Image</i></td><td><tt>ALT+S</tt></td><td>&#160;</td><td>Saves the current display as a resource file.</td></tr>
<tr><td><i>Copy Image</i></td><td><tt>ALT+C</tt></td><td>&#160;</td><td>Copies the current display to the clipboard.</td></tr>
<tr><td><i>Hide/Show Info</i></td><td><tt>ALT+T</tt></td><td>&#160;</td><td>Toggles the display of all the additional information.</td></tr>
<tr><td><i>Add a Crosshair</i></td><td><tt>ALT+H</tt></td><td>&#160;</td><td>Adds a crosshair you can drag around. </td></tr>
<tr><td><i>Remove a Crosshair</i></td><td><tt>ALT+SHIFT+H</tt></td><td>&#160;</td><td>Removes the last added crosshair.</td></tr>
<tr><td><i>Hide/Show Grid</i></td><td><tt>ALT+G</tt></td><td>&#160;</td><td>Toggles the overlayed grid.</td></tr>
<tr><td class="onelinetop"><i>Freeze/Unfreeze image</i></td><td><tt>ALT+F</tt></td><td>&#160;</td><td>Stops/continues updating the magnification area.</td></tr>
<tr><td><i>Stick Coordinates</i></td><td><tt>ALT+I</tt></td><td>&#160;</td><td>Keeps updating the magnification area, but don't follow the mouse pointer any more.</td></tr>
<tr><td><i>Make Square</i></td><td><tt>ALT+/</tt></td><td>&#160;</td><td>Reverts back to a square display after resizing the window.</td></tr>
<tr><td class="onelinetop"><i>Decrease Window Size</i></td><td><tt>ALT+-</tt></td><td>&#160;</td><td>Shrinks the magnified area around the mouse pointer.</td></tr>
<tr><td><i>Increase Window Size</i></td><td><tt>ALT++</tt></td><td>&#160;</td><td>Enlarges the magnified area around the mouse pointer.</td></tr>
<tr><td><i>Decrease Pixel Size</i></td><td><tt>ALT+,</tt></td><td>&#160;</td><td>Lowers magnification.</td></tr>
<tr><td><i>Increase Pixel Size</i></td><td><tt>ALT+.</tt></td><td>&#160;</td><td>Increases magnification.</td></tr>
<tr><td><span class="menu">Save Image</span></td><td><span class="key">ALT</span>&#160;<span class="key">S</span></td><td>&#160;</td><td>Saves the current display as a resource file.</td></tr>
<tr><td><span class="menu">Copy Image</span></td><td><span class="key">ALT</span>&#160;<span class="key">C</span></td><td>&#160;</td><td>Copies the current display to the clipboard.</td></tr>
<tr><td><span class="menu">Hide/Show Info</span></td><td><span class="key">ALT</span>&#160;<span class="key">T</span></td><td>&#160;</td><td>Toggles the display of all the additional information.</td></tr>
<tr><td><span class="menu">Add a Crosshair</span></td><td><span class="key">ALT</span>&#160;<span class="key">H</span></td><td>&#160;</td><td>Adds a crosshair you can drag around. </td></tr>
<tr><td><span class="menu">Remove a Crosshair</span></td><td><span class="key">ALT</span>&#160;<span class="key">SHIFT</span>&#160;<span class="key">H</span></td><td>&#160;</td><td>Removes the last added crosshair.</td></tr>
<tr><td><span class="menu">Hide/Show Grid</span></td><td><span class="key">ALT</span>&#160;<span class="key">G</span></td><td>&#160;</td><td>Toggles the overlayed grid.</td></tr>
<tr><td class="onelinetop"><span class="menu">Freeze/Unfreeze image</span></td><td><span class="key">ALT</span>&#160;<span class="key">F</span></td><td>&#160;</td><td>Stops/continues updating the magnification area.</td></tr>
<tr><td><span class="menu">Stick Coordinates</span></td><td><span class="key">ALT</span>&#160;<span class="key">I</span></td><td>&#160;</td><td>Keeps updating the magnification area, but don't follow the mouse pointer any more.</td></tr>
<tr><td><span class="menu">Make Square</span></td><td><span class="key">ALT</span>&#160;<span class="key">/</span></td><td>&#160;</td><td>Reverts back to a square display after resizing the window.</td></tr>
<tr><td class="onelinetop"><span class="menu">Decrease Window Size</span></td><td><span class="key">ALT</span>&#160;<span class="key">-</span></td><td>&#160;</td><td>Shrinks the magnified area around the mouse pointer.</td></tr>
<tr><td><span class="menu">Increase Window Size</span></td><td><span class="key">ALT</span>&#160;<span class="key">+</span></td><td>&#160;</td><td>Enlarges the magnified area around the mouse pointer.</td></tr>
<tr><td><span class="menu">Decrease Pixel Size</span></td><td><span class="key">ALT</span>&#160;<span class="key">,</span></td><td>&#160;</td><td>Lowers magnification.</td></tr>
<tr><td><span class="menu">Increase Pixel Size</span></td><td></span>&#160;<span class="key">ALT</span>&#160;<span class="key">.</span></td><td>&#160;</td><td>Increases magnification.</td></tr>
</table>
</div>

6
docs/userguide/en/applications/apps-mail.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/mail-icon_64.png" alt="mail-icon_64.png"
width="64" height="64" />Mail</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/Mail</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Mail/BeMail Settings</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/Mail</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Mail/BeMail Settings</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-mediaplayer.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/mediaplayer-icon_64.png" alt="mediaplayer-icon_64.png"
width="64" height="64" />MediaPlayer</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/MediaPlayer</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/MediaPlayer</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/MediaPlayer</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/MediaPlayer</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-midiplayer.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/midiplayer-icon_64.png" alt="midiplayer-icon_64.png"
width="64" height="64" />MidiPlayer</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/MidiPlayer</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/MidiPlayerSettings</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/MidiPlayer</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/MidiPlayerSettings</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

2
docs/userguide/en/applications/apps-packageinstaller.html
View File

@ -41,7 +41,7 @@ width="64" height="64" />PackageInstaller</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>No entry, normally launched via
double-clicking a supported file.</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/PackageInstaller</tt></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/PackageInstaller</span></td></tr>
<tr><td>Settings:</td><td></td><td>none</td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-pe.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/pe-icon_64.png" alt="pe-icon_64.png"
width="64" height="64" />Pe</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/apps/Pe/Pe</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/pe/*</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/apps/Pe/Pe</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/pe/*</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-people.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/people-icon_64.png" alt="people-icon_64.png"
width="64" height="64" />People</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/People</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/People_data</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/People</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/People_data</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-screenshot.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/screenshot-icon_64.png" alt="screenshot-icon_64.png"
width="64" height="64" />Screenshot</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/Screenshot</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/screenshot</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/Screenshot</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/screenshot</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

4
docs/userguide/en/applications/apps-showimage.html
View File

@ -41,8 +41,8 @@ width="64" height="64" />Showimage</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>No entry, normally launched via
double-clicking a supported file.</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/Showimage</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Showimage_settings</tt></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/Showimage</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Showimage_settings</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-soundrecorder.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/soundrecorder-icon_64.png" alt="soundrecorder-icon_64.png"
width="64" height="64" />SoundRecorder</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/SoundRecorder</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/???</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/SoundRecorder</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/???</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

19
docs/userguide/en/applications/apps-stylededit.html
View File

@ -5,7 +5,7 @@
<head>
<!--
*
* Copyright 2008, Haiku. All rights reserved.
* Copyright 2008-2009, Haiku. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
@ -39,13 +39,13 @@
<h1><img src="../../images/apps-images/stylededit-icon_64.png" alt="stylededit-icon_64.png"
width="64" height="64" />StyledEdit</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/StyledEdit</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/StyledEdit</span></td></tr>
<tr><td>Settings:</td><td></td><td>no settings</td></tr>
</table>
<p>StyledEdit is Haiku's simple text editor. Although it saves files in plain text format, additional attributes are written in order to have limited formatting capabilities when viewed with StyledEdit.</p>
<img src="../../images/apps-images/stylededit.png" alt="stylededit.png" width="525" height="438" />
<p>If you're interested, this is what those additional attributes look like when examined in Terminal with <tt>listattr</tt>:</p>
<p>If you're interested, this is what those additional attributes look like when examined in Terminal with <span class="cli">listattr</span>:</p>
<pre class="terminal">~> listattr /boot/home/Desktop/test.txt
File: /boot/home/Desktop/test.txt
Type Size Name
@ -58,13 +58,12 @@ MIME String 11 "BEOS:TYPE"
1071 bytes total in attributes.</pre>
<p>As you can see, all the formatting options from StyledEdit's menu are present: line wrapping (on/off) and alignment (left/center/right), each in one attribute. Styles (font, size, color) of each letter mangled into another.</p>
<p><i>Note:</i> Because these attributes are a file system feature of BFS, this means that not only other platforms just see a plain text
file, it also follows, that the formatting will be lost when a file is stored on a non-BFS partition. The above attributes are simply stripped and what's left is the ordinary, plain text file.</p>
<p>In any case, it's a nice idea having the possibility of colored text in different fonts and sizes while still being a normal text file. A <tt>ReadMe.txt</tt>, for example, is therefore readable in a shell on any platform and still has a bit of style when viewed via double-click from Haiku.</p>
<p>Actually using StyledEdit is so simple, we'll skip explaining every mundane menu item. Just write down your text then select the words you'd like to format and apply font, size and color from the <i>Font</i> menu. Line wrapping and alignment from the <i>Document</i> menu only work on the whole file.</p>
<div class="box-info">Because these attributes are a file system feature of BFS, this means that not only other platforms just see a plain text file, it also follows, that the formatting will be lost when a file is stored on a non-BFS partition. The above attributes are simply stripped and what's left is the ordinary, plain text file.</div>
<p>In any case, it's a nice idea having the possibility of colored text in different fonts and sizes while still being a normal text file. A <span class="cli">ReadMe.txt</span>, for example, is therefore readable in a shell on any platform and still has a bit of style when viewed via double-click from Haiku.</p>
<p>Actually using StyledEdit is so simple, we'll skip explaining every mundane menu item. Just write down your text then select the words you'd like to format and apply font, size and color from the <span class="menu">Font</span> menu. Line wrapping and alignment from the <span class="menu">Document</span> menu only work on the whole file.</p>
</div>
<!--
<div class="bottomnav">
<p>
<a href="../applications.html">Applications</a>
@ -74,6 +73,6 @@ file, it also follows, that the formatting will be lost when a file is stored on
Next: <a href="apps-terminal.html">Terminal</a>
</p>
</div>
-->
</body>
</html>

40
docs/userguide/en/applications/apps-terminal.html
View File

@ -38,30 +38,30 @@
<h1><img src="../../images/apps-images/terminal-icon_64.png" alt="terminal-icon_64.png" width="64" height="64" />Terminal</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/Terminal</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Terminal_settings</tt><br />
<tt>~/.profile</tt> - adds/overrides defaults in <tt>/boot/beos/etc/profile</tt><br />
<tt>~/.inputrc</tt> - adds/overrides defaults in <tt>/boot/beos/etc/inputrc</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/Terminal</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Terminal_settings</span><br />
<span class="path">~/.profile</span> - adds/overrides defaults in <span class="path">/boot/beos/etc/profile</span><br />
<span class="path">~/.inputrc</span> - adds/overrides defaults in <span class="path">/boot/beos/etc/inputrc</span></td></tr>
</table>
<p>The Terminal is Haiku's interface to bash, the Bourne Again Shell.</p>
<p>Please refer to the topic on <a href="../bash-scripting.html">Scripting</a> for a few links to online tutorials on working in the shell. Here, we'll concentrate on the Terminal application itself.</p>
<h2><a id="appearance" name="appearance">Appearance</a></h2>
<p>You can open as many Terminals as needed, either each in it's own window by simply launching more Terminals or with <tt>ALT+N</tt> from an already running Terminal. Or you use Terminal's tabbed view and open another tab with <tt>ALT+T</tt>.</p>
<p>A Terminal window can be resized like any other window or you use the presets from the <i>Ssettings | Window Size</i> menu. <tt>ALT+RETURN</tt> toggles fullscreen mode.</p>
<p>Changed window size and text encoding are only kept choosing <i>Settings | Save as default</i>.</p>
<p>You can open as many Terminals as needed, either each in it's own window by simply launching more Terminals or with <span class="key">ALT</span>&#160;<span class="key">N</span> from an already running Terminal. Or you use Terminal's tabbed view and open another tab with <span class="key">ALT</span>&#160;<span class="key">T</span>.</p>
<p>A Terminal window can be resized like any other window or you use the presets from the <span class="menu">Settings | Window Size</span> menu. <span class="key">ALT</span>&#160;<span class="key">ENTER</span> toggles fullscreen mode.</p>
<p>Changed window size and text encoding are only kept choosing <span class="menu">Settings | Save as default</span>.</p>
<img src="../../images/apps-images/terminal.png" alt="terminal.png" width="532" height="391" />
<br />
<p><i>Settings | Preferences</i> opens a panel where you can set font type, font size and the different text and background colors. You can save different settings as separate profiles, which on double-click open an accordingly configured Terminal.<br />
Pressing <i>OK</i> will save the current settings as default.</p>
<p><span class="menu">Settings | Preferences</span> opens a panel where you can set font type, font size and the different text and background colors. You can save different settings as separate profiles, which on double-click open an accordingly configured Terminal.<br />
Pressing <span class="button">OK</span> will save the current settings as default.</p>
<h2><a id="customization" name="customization">Bash customization</a></h2>
<p>Coming from Unix, there are countless possibilities to customize the bash itself. There are two files that are especially important to the user: <tt>.profile</tt> and <tt>.inputrc</tt><br />
Both files can be created in the <tt>home/</tt> folder and add or override the system defaults that are defined in <tt>/boot/beos/etc/</tt>.</p>
<p>Coming from Unix, there are countless possibilities to customize the bash itself. There are two files that are especially important to the user: <span class="cli">.profile</span> and <span class="cli">.inputrc</span><br />
Both files can be created in the <span class="path">home/</span> folder and add or override the system defaults that are defined in <span class="path">/boot/beos/etc/</span>.</p>
<h3>.profile</h3>
<p>The <tt>.profile</tt> is loaded every time you open a new Terminal. It sets all kinds of aliases and variables that will affect bash's behavior and appearance. You'll find many online resources that will detail all possibilities.</p>
<p>The <span class="cli">.profile</span> is loaded every time you open a new Terminal. It sets all kinds of aliases and variables that will affect bash's behavior and appearance. You'll find many online resources that will detail all possibilities.</p>
<p>The Haiku/BeOS Tip Server has quite a few tips to get you started, for example:</p>
<ul>
<li><a href="http://betips.net/1997/09/09/customize-your-terminal-prompt/">Customize your Terminal prompt</a></li>
@ -72,7 +72,7 @@ Both files can be created in the <tt>home/</tt> folder and add or override the s
<p>There are more, <a href="http://betips.net/index.php?s=.profile">have a look</a>.</p>
<h3>.inputrc</h3>
<p>The <tt>.inputrc</tt> deals with keybindings. Since Haiku provides useful defaults, you probably don't have to mess with these more involved settings. If you do have special needs here, consult one of the many online resources, e.g. <a href="http://tiswww.case.edu/php/chet/readline/rluserman.html">The GNU Readline Library</a>.</p>
<p>The <span class="cli">.inputrc</span> deals with keybindings. Since Haiku provides useful defaults, you probably don't have to mess with these more involved settings. If you do have special needs here, consult one of the many online resources, e.g. <a href="http://tiswww.case.edu/php/chet/readline/rluserman.html">The GNU Readline Library</a>.</p>
<h2><a id="shortcuts" name="shortcuts">Keyboard shortcuts</a></h2>
<p>You'll find a list of useful shortcuts in <a href="../keyboard-shortcuts.html#terminal">Shortcuts and key combinations</a>.</p>
@ -80,13 +80,13 @@ Both files can be created in the <tt>home/</tt> folder and add or override the s
<h2><a id="hints" name="hints">Hints for working with the Terminal</a></h2>
<ul><li><p>Dragging a file or folder from a Tracker window into the Terminal will insert its path at the location of the cursor. Dragging with the right mouse button offers additional actions in a context menu:</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Insert Path</i></td><td>&#160;</td><td>Inserts the location of the file, same as drag&dropping with the left mouse button.</td></tr>
<tr><td><i>Change Directory</i></td><td>&#160;</td><td>Changes to the folder of the dragged file.</td>
<tr><td><i>Create Link Here</i></td><td>&#160;</td><td>Creates a link to the dragged file in the current working directory of the Terminal.</td>
<tr><td><i>Move Here</i></td><td>&#160;</td><td>Moves the dragged file into the current working directory of the Terminal.</td>
<tr><td><i>Copy Here</i></td><td>&#160;</td><td>Copies the dragged file into the current working directory of the Terminal.</td></tr>
<tr><td><span class="menu">Insert Path</span></td><td>&#160;</td><td>Inserts the location of the file, same as drag&dropping with the left mouse button.</td></tr>
<tr><td><span class="menu">Change Directory</span></td><td>&#160;</td><td>Changes to the folder of the dragged file.</td>
<tr><td><span class="menu">Create Link Here</span></td><td>&#160;</td><td>Creates a link to the dragged file in the current working directory of the Terminal.</td>
<tr><td><span class="menu">Move Here</span></td><td>&#160;</td><td>Moves the dragged file into the current working directory of the Terminal.</td>
<tr><td><span class="menu">Copy Here</span></td><td>&#160;</td><td>Copies the dragged file into the current working directory of the Terminal.</td></tr>
</table></li>
<li><p>You can open any file with its preferred application with the command <tt>open <i>[filename]</i></tt>. This also works with the representation of the current ("<tt>.</tt>") and parent ("<tt>..</tt>") folder which then open in a Tracker window. So, to open the current working directory, you type:</p>
<li><p>You can open any file with its preferred application with the command <span class="cli">open <i>[filename]</i></span>. This also works with the representation of the current ("<span class="cli">.</span>") and parent ("<span class="cli">..</span>") folder which then open in a Tracker window. So, to open the current working directory, you type:</p>
<pre class="terminal">open .</pre>
</li></ul>

4
docs/userguide/en/applications/apps-textsearch.html
View File

@ -40,8 +40,8 @@
width="64" height="64" />TextSearch</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>No entry, normally launched via <a href="../tracker-add-ons.html">Tracker Add-On</a></i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/TextSearch</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/TextSearch</tt></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/TextSearch</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/TextSearch</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-tv.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/tv-icon_64.png" alt="tv-icon_64.png"
width="64" height="64" />TV</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/TV</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/???</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/TV</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/???</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-vision.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/vision-icon_64.png" alt="vision-icon_64.png"
width="64" height="64" />Vision</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/apps/Vision{version}/Vision</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Vision/*</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/apps/Vision{version}/Vision</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Vision/*</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

6
docs/userguide/en/applications/apps-vlc.html
View File

@ -39,9 +39,9 @@
<h1><img src="../../images/apps-images/vlc-icon_64.png" alt="vlc-icon_64.png"
width="64" height="64" />VLC</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/apps/vlc{version}/VLC media player</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/VideoLAN Client/*</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/apps/vlc{version}/VLC media player</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/VideoLAN Client/*</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

8
docs/userguide/en/applications/apps-wonderbrush.html
View File

@ -37,10 +37,10 @@
<h1><img src="../../images/apps-images/wonderbrush-icon_64.png" alt="wonderbrush-icon_64.png"
width="64" height="64" />WonderBrush</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Applications</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/apps/WonderBrush/WonderBrush</tt></td></tr>
<tr><td>Documentation:</td><td></td><td><tt>/boot/apps/WonderBrush/Documentation {language}</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/WonderBrush</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Applications</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/apps/WonderBrush/WonderBrush</span></td></tr>
<tr><td>Documentation:</td><td></td><td><span class="path">/boot/apps/WonderBrush/Documentation {language}</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/WonderBrush</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

10
docs/userguide/en/attributes.html
View File

@ -46,10 +46,10 @@
<h2><a id="attributes-tracker" name="attributes-tracker">Attributes in Tracker</a></h2>
<p>Attributes are displayed quite similar to a database or spreadsheet. Using Tracker you can choose which attributes to display (columns) and sort file listings (rows) accordingly.</p>
<p>To do this, open a Tracker window, click on the <i>Attributes</i> menu, and select the attributes you want to display. Alternatively, simply right-click onto a column heading and mark the items in the context menu. You can rearrange the columns by a simple drag&amp;drop of the column heading. Moving a column out of a window, is a fast way to get rid of columns you don't need.</p>
<p>To do this, open a Tracker window, click on the <span class="menu">Attributes</span> menu, and select the attributes you want to display. Alternatively, simply right-click onto a column heading and mark the items in the context menu. You can rearrange the columns by a simple drag&amp;drop of the column heading. Moving a column out of a window, is a fast way to get rid of columns you don't need.</p>
<p>Double-click on the line between two attributes in the heading to automatically resize a column to its optimal width.</p>
<p>Click on a column heading to toggle the sorting order from ascending to descending. You can establish a secondary sort order by pressing the <tt>SHIFT</tt> key while clicking on a column heading. Doing that you can, for example, sort your People files by company and within that order sort by contact name. See the above screenshot as an example. The secondary sort order is marked by a dotted line under the heading.</p>
<p>Editing these attributes is as simple as renaming a file: Either click on an entry or press <tt>ALT+E</tt> and move between the attibutes with <tt>TAB</tt> and <tt>SHIFT+TAB</tt>. <tt>ESC</tt> leaves the editing mode without applying the changes.</p>
<p>Click on a column heading to toggle the sorting order from ascending to descending. You can establish a secondary sort order by pressing the <span class="key">SHIFT</span> key while clicking on a column heading. Doing that you can, for example, sort your People files by company and within that order sort by contact name. See the above screenshot as an example. The secondary sort order is marked by a dotted line under the heading.</p>
<p>Editing these attributes is as simple as renaming a file: Either click on an entry or press <span class="key">ALT</span>&#160;<span class="key">E</span> and move between the attibutes with <span class="key">TAB</span> and <span class="key">SHIFT</span>&#160;<span class="key">TAB</span>. <span class="key">ESC</span> leaves the editing mode without applying the changes.</p>
<h2><a id="attributes-terminal" name="attributes-terminal">Attributes in Terminal</a></h2>
<p>If you prefer to use the commandline or plan to work with many files using scripting, there are several commands for controlling attributes from Terminal:</p>
@ -118,10 +118,10 @@ Clara Botters&#160;: string&#160;: Whelton</pre></li>
<ul><li><b>copyattr</b> - copies attributes from one or more files to another. By default, the actual contents of the file is <b>not</b> copied.
<pre>Usage: copyattr &lt;options&gt; &lt;source&gt; [ ... ] &lt;destination&gt;</pre>
If you do want to copy the attributes plus the data of the file itself, you can add the option "<tt>-d</tt>" or "<tt>--data</tt>".</li>
If you do want to copy the attributes plus the data of the file itself, you can add the option "<span class="cli">-d</span>" or "<span class="cli">--data</span>".</li>
</ul>
<p><br /></p>
<p>More information on these commands and their options can be found by typing the command name followed by "<tt>-h</tt>" or "<tt>--help</tt>".</p>
<p>More information on these commands and their options can be found by typing the command name followed by "<span class="cli">-h</span>" or "<span class="cli">--help</span>".</p>
</div>

6
docs/userguide/en/bash-scripting.html
View File

@ -50,7 +50,7 @@ Scripts can range from simply executing a few commands in a specific order to so
If they don't exist already, you'll have to create the needed files yourself. Otherwise simply add your commands where in the process you want them to be executed.</p>
<h2><a id="userbootscript" name="userbootscript">The UserBootscript</a></h2>
<p><tt>/boot/home/config/boot/UserBootscript</tt> will be executed after the system has finished its boot process. For example, you could launch a number of programs that would then be automatically started on every boot up:</p>
<p><span class="path">/boot/home/config/boot/UserBootscript</span> will be executed after the system has finished its boot process. For example, you could launch a number of programs that would then be automatically started on every boot up:</p>
<pre># Start LaunchBox
/boot/beos/apps/LaunchBox &amp;
@ -59,10 +59,10 @@ If they don't exist already, you'll have to create the needed files yourself. Ot
<p>Remember to end a command with an "<tt>&amp;</tt>" to start it as a background process, or the script will halt until that command has finished (in this case: the launched app was closed again).</p>
<h2><a id="usershutdownscript" name="usershutdownscript">The UserShutdownScript</a></h2>
<p><tt>/boot/home/config/boot/UserShutdownScript</tt> will be executed as the first step in the shutdown process. If the script returns a non-zero exit status, the shutdown is aborted.</p>
<p><span class="path">/boot/home/config/boot/UserShutdownScript</span> will be executed as the first step in the shutdown process. If the script returns a non-zero exit status, the shutdown is aborted.</p>
<h2><a id="usershutdownfinishscript" name="usershutdownfinishscript">The UserShutdownFinishScript</a></h2>
<p><tt>/boot/home/config/boot/UserShutdownFinishScript</tt> is executed as the last step in the shutdown process. Note, that most parts of the system have terminated by the time this script is executed.</p>
<p><span class="path">/boot/home/config/boot/UserShutdownFinishScript</span> is executed as the last step in the shutdown process. Note, that most parts of the system have terminated by the time this script is executed.</p>
</div>

4
docs/userguide/en/bootloader.html
View File

@ -38,7 +38,7 @@
<p>Haiku's Boot Loader can help you when you experience hardware related problems or want to choose which Haiku installation to start, if you have more than one (maybe on an installation CD or USB stick).<br />
It's also handy after you installed a software component that acts up and prevents you from booting the system to remove it again. The <i>Disable user add-ons</i> option that's mentioned below, will start Haiku without loading user installed components, e.g. a driver.</p>
<p>To enter the Boot Loader options, you have to press the <tt>SPACE BAR</tt> right at the beginning of the boot process. It's easy to miss so you best keep hitting the key until it shows up.</p>
<p>To enter the Boot Loader options, you have to press the <span class="key">SPACE BAR</span> right at the beginning of the boot process. It's easy to miss so you best keep hitting the key until it shows up.</p>
<p><br /></p>
<p>Once it's there, you're offered three menus:</p>
<table summary="bootloader menus" border="0" cellspacing="0" cellpadding="2">
@ -65,7 +65,7 @@ It's also handy after you installed a software component that acts up and preven
The different symbols roughly correspond to these boot stages:</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><b>Atom</b></td><td style="width:10px;">&#160;</td><td>Initializing modules.</td></tr>
<tr><td><b>Disk + magnifier</b></td><td>&#160;</td><td>Creating rootfs (<tt>/</tt>) and mounting devfs (<tt>/dev</tt>).</td></tr>
<tr><td><b>Disk + magnifier</b></td><td>&#160;</td><td>Creating rootfs (<span class="path">/</span>) and mounting devfs (<span class="path">/dev</span>).</td></tr>
<tr><td><b>Plug-in card</b></td><td>&#160;</td><td>Initializing device manager.</td></tr>
<tr><td><b>Boot disk</b></td><td>&#160;</td><td>Mounting boot disk.</td></tr>
<tr><td><b>Chip</b></td><td>&#160;</td><td>Loading CPU specific modules.</td></tr>

2
docs/userguide/en/contents.html
View File

@ -35,6 +35,7 @@
<h2><a name="welcome">Welcome to the Haiku User Guide</a></h2>
<p>Below, you'll find the documentation of the most important aspects of Haiku. Naturally, completing and extending the documentation is a continuing process. If you find errors or would like to suggest topics or maybe even contribute yourself, please file a <a href="../../welcome/en/bugreports.html">bugreport</a> or get in touch on the <a href="http://www.freelists.org/list/haiku-doc">documentation mailing list</a>.</p>
<table summary="contents" border="0" cellpadding="10" cellspacing="0">
<!-- Excluded until it's further fleshed out
<tr><td valign="top"><a href="installation.html">Installation</a><ul>
<li><a href="installation.html#boot-process">The basic boot process</a></li>
<li><a href="installation.html#virtual-machine">Haiku in a virtual machine</a></li>
@ -43,6 +44,7 @@
<li><a href="installation.html#grub">Adding Haiku to your boot manager (GRUB)</a></li>
<li><a href="installation.html#transfer-data">Transfering data to/from a Haiku installation</a></li></ul></td>
<td valign="top">Step by step guides covering Haiku installation during the (pre-) alpha release phase.</td></tr>
-->
<tr><td valign="top"><a href="bootloader.html">Boot Loader</a></td>
<td valign="top">Set safe boot options to solve configuration problems.</td></tr>
<tr><td valign="top"><a href="filesystem-layout.html">Filesystem layout</a><ul>

45
docs/userguide/en/deskbar.html
View File

@ -45,41 +45,42 @@
<p>A menu opens when you click on the Deskbar's uppermost part:</p>
<img src="../images/deskbar-images/settings.png" alt="settings.png" width="521" height="309" />
<ul>
<li><b>About This System...</b> - Shows some basic information of the system, licenses and the credits of the Haiku project.</li>
<li><p><b>About This System...</b> - Shows some basic information of the system, licenses and the credits of the Haiku project.</p></li>
<li><b>Find...</b> - Opens the query dialog.</li>
<li><b>Show Replicants</b> - Shows/hides the little Replicant widget you use to drag it around, remove or access its context menu.</li>
<li><b>Deskbar Settings</b><ul>
<li><i>Configure Deskbar Menu...</i> - Opens a panel to configure the Deskbar menu (see below).</li>
<li><i>Always on Top</i> - The Deskbar always stays above all other windows.</li>
<li><i>Auto Raise</i> - The Deskbar pops to the front if the mouse pointer touches it.</li>
<li><i>Sort Running Applications</i> - Sorts the list of running programs alphabetically.</li>
<li><i>Tracker always First</i> - Even if you sort alphabetically, the Tracker entry always stays first in the list.</li>
<li><i>24 Hour Clock</i> - Toggles between 24 and 12 hour clock.</li>
<li><i>Show Seconds</i> - Adds the display of seconds to the clock.</li>
<li><i>European Date</i> - Shows the date in European format: day-month-year</li>
<li><i>---- Full Date ----</i></li>
<li><i>Show Application Expander</i> - Provides a small widget to show/hide all windows of a program directly under its entry in the Deskbar.</li>
<li><i>Expand New Applications</i> - Newly launched programs have their windows automatically expanded under their entry in the Deskbar.</li>
</ul></li>
<li><b>Restart</b> - Restarts the system.</li>
<li><b>Shutdown</b> - Shuts down the system.</li>
<li><b>Recent Documents, Folders, Applications</b> - List the last recently opened documents, folders and applications (see <i>Configure Deskbar Menu...</i> below).
<li><b>Applications, Demos, Deskbar Applets, Preferences</b> - List of installed applications, demos, applets and preferences (see <i>Configure Deskbar Menu...</i> below).</li>
<li><p><b>Find...</b> - Opens the query dialog.</p></li>
<li><p><b>Show Replicants</b> - Shows/hides the little Replicant widget you use to drag it around, remove or access its context menu.</p></li>
<li><p><b>Deskbar Settings</b></p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><span class="menu">Configure Deskbar Menu...</span></td><td>&#160;</td><td>Opens a panel to configure the Deskbar menu (see below).</td></tr>
<tr><td><span class="menu">Always on Top</span></td><td>&#160;</td><td>The Deskbar always stays above all other windows.</td></tr>
<tr><td><span class="menu">Auto Raise</span></td><td>&#160;</td><td>The Deskbar pops to the front if the mouse pointer touches it.</td></tr>
<tr><td><span class="menu">Sort Running Applications</span></td><td>&#160;</td><td>Sorts the list of running programs alphabetically.</td></tr>
<tr><td><span class="menu">Tracker always First</span></td><td>&#160;</td><td>Even if you sort alphabetically, the Tracker entry always stays first in the list.</td></tr>
<tr><td><span class="menu">24 Hour Clock</span></td><td>&#160;</td><td>Toggles between 24 and 12 hour clock.</td></tr>
<tr><td><span class="menu">Show Seconds</span></td><td>&#160;</td><td>Adds the display of seconds to the clock.</td></tr>
<tr><td><span class="menu">European Date</span></td><td>&#160;</td><td>Shows the date in European format: day-month-year</td></tr>
<tr><td><span class="menu">---- Full Date ----</span></td></tr>
<tr><td class="onelinetop"><span class="menu">Show Application Expander</span></td><td>&#160;</td><td>Provides a small widget to show/hide all windows of a program directly under its entry in the Deskbar.</td></tr>
<tr><td><span class="menu">Expand New Applications</span></td><td>&#160;</td><td>Newly launched programs have their windows automatically expanded under their entry in the Deskbar.</td></tr>
</table></li>
<li><p><b>Restart</b> - Restarts the system.</p></li>
<li><p><b>Shutdown</b> - Shuts down the system.</p></li>
<li><p><b>Recent Documents, Folders, Applications</b> - List the last recently opened documents, folders and applications (see <span class="menu">Configure Deskbar Menu...</span> below).
<li><p><b>Applications, Demos, Deskbar Applets, Preferences</b> - List of installed applications, demos, applets and preferences (see <span class="menu">Configure Deskbar Menu...</span> below).</p></li>
</ul>
<h3>Configure Deskbar Menu...</h3>
<img src="../images/deskbar-images/configure.png" alt="configure.png" width="359" height="416" />
<p>In this panel you set how many recent documents, folders and applications are shown in the Deskbar, or if you show them at all.</p>
<p>Here, you also configure folders and their contents, which are by default Applications, Demos, Deskbar Applets, and Preferences. You can add your own entries and edit or remove items.<br />
This part of the panel is just a representation of the folder <tt>/boot/home/config/be/</tt>. You can just as well link or copy files and folders directly in Tracker to configure your Deskbar.<br />
This part of the panel is just a representation of the folder <span class="path">/boot/home/config/be/</span>. You can just as well link or copy files and folders directly in Tracker to configure your Deskbar.<br />
Another method is to simply drag a file or folder and drop it where you want it into the Deskbar.</p>
<h2><a id="tray" name="tray">The Tray</a></h2>
<img src="../images/deskbar-images/calendar.png" alt="calendar.png" width="229" height="210" />
<p>Among other things, the tray's housing the clock. Left-click it to toggle between date and time. Right-click it to hide/show it or launch the <a href="prefs-time.html">Time</a> preferences to set it.<br />
Here you can also launch a calendar that also appears, when you hold down the left mouse button on the clock for a little time.</p>
<p>Any program can install an icon in the tray to provide an interface to the user. The email system, for instance, shows a different symbol when there's unread mail and offers a context menu to e.g. create or check for new mail. <i>ProcessController</i> is another example that uses its icon in the tray to provide information (CPU/memory usage) and to offer a context menu.</p>
<p>Any program can install an icon in the tray to provide an interface to the user. The email system, for instance, shows a different symbol when there's unread mail and offers a context menu to e.g. create or check for new mail. <span class="app">ProcessController</span> is another example that uses its icon in the tray to provide information (CPU/memory usage) and to offer a context menu.</p>
<h2><a id="list-of-apps" name="list-of-apps">The list of running programs</a></h2>
<img src="../images/deskbar-images/list-of-apps.png" alt="list-of-apps.png" width="229" height="306" />

38
docs/userguide/en/desktop-applets/desktop-applets-launchbox.html
View File

@ -37,38 +37,38 @@
<h1><img src="../../images/desktop-applets-images/launchbox-icon_64.png" alt="launchbox-icon_64.png"
width="64" height="64" />LaunchBox</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Desktop Applets</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/LaunchBox</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/LaunchBox/*</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Desktop Applets</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/LaunchBox</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/LaunchBox/*</span></td></tr>
</table>
<p>One or more LaunchBox applets can be started to organize shortcuts to your favorite applications or documents. You decide if each is shown on all or just the current workspace. They can also serve to quickly open a document in a specific application. For example, you could drag&amp;drop a HTML file onto a text editor in a LaunchBox to open it in the editor instead of its preferred application, the browser.</p>
<img src="../../images/desktop-applets-images/launchbox.png" alt="launchbox.png" width="372" height="306" />
<p>All options are reached from the context menu:</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Add Button Here</i></td><td style="width:10px;">&#160;</td><td>Adds an empty button.</td></tr>
<tr><td><i>Clear Button</i></td><td>&#160;</td><td>Empties a button.</td></tr>
<tr><td><i>Remove Button</i></td><td>&#160;</td><td>Removes a button.</td></tr>
<tr><td class="onelinetop"><i>Settings</i><br />
<i>- Horizontal Layout</i><br />
<i>- Icon size</i><br />
<i>- Show Window Border</i><br />
<i>- Auto Raise</i><br />
<i>- Show On All Workspaces</i></td><td>&#160;</td><td class="onelinetop"><br />
<tr><td><span class="menu">Add Button Here</span></td><td style="width:10px;">&#160;</td><td>Adds an empty button.</td></tr>
<tr><td><span class="menu">Clear Button</span></td><td>&#160;</td><td>Empties a button.</td></tr>
<tr><td><span class="menu">Remove Button</span></td><td>&#160;</td><td>Removes a button.</td></tr>
<tr><td class="onelinetop"><span class="menu">Settings</span><br />
<span class="menu">- Horizontal Layout</span><br />
<span class="menu">- Icon size</span><br />
<span class="menu">- Show Window Border</span><br />
<span class="menu">- Auto Raise</span><br />
<span class="menu">- Show On All Workspaces</span></td><td>&#160;</td><td class="onelinetop"><br />
Aligns the buttons horizontally.<br />
Sets the icon size between 16 and 64 pixel.<br />
Shows the window border.<br />
LaunchBox pops up if the mouse is near the screen edge.<br />
Shows the LaunchBox on every workspace.</td></tr>
<tr><td><i>Pad</i><br />
<i>- New</i><br />
<i>- Clone</i><br />
<i>- Close</i></td><td>&#160;</td><td><br />
<tr><td><span class="menu">Pad</span><br />
<span class="menu">- New</span><br />
<span class="menu">- Clone</span><br />
<span class="menu">- Close</span></td><td>&#160;</td><td><br />
Add a new pad.<br />
Duplicate the current pad.<br />
Close the current pad.</td></tr>
<tr><td><i>LaunchBox</i><br />
<i>- About...</i><br />
<i>- Quit</i></td><td>&#160;</td><td><br />
<tr><td><span class="menu">LaunchBox</span><br />
<span class="menu">- About...</span><br />
<span class="menu">- Quit</span></td><td>&#160;</td><td><br />
Shows the About window.<br />
Quits all LaunchBox pads.</td><td>&#160;</td></tr>
</table>

4
docs/userguide/en/desktop-applets/desktop-applets-networkstatus.html
View File

@ -39,8 +39,8 @@
<h1><img src="../../images/desktop-applets-images/networkstatus-icon_64.png" alt="networkstatus-icon_64.png"
width="64" height="64" />NetworkStatus</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Desktop Applets</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/NetworkStatus</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Desktop Applets</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/NetworkStatus</span></td></tr>
<tr><td>Settings:</td><td></td><td>none</td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

4
docs/userguide/en/desktop-applets/desktop-applets-processcontroller.html
View File

@ -39,8 +39,8 @@
<h1><img src="../../images/desktop-applets-images/processcontroller-icon_64.png" alt="processcontroller-icon_64.png"
width="64" height="64" />ProcessController</h1>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Desktop Applets</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/ProcessController</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Desktop Applets</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/ProcessController</span></td></tr>
<tr><td>Settings:</td><td></td><td>none</td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

62
docs/userguide/en/filesystem-layout.html
View File

@ -39,25 +39,25 @@
<p>Haiku's filesystem layout is quite transparent, trying to always use non-cryptic names for files and folders, that don't leave the user guessing. Files and folders that are important for the system to function properly, are protected from accidental tempering by showing one of these alerts:</p>
<img src="../images/filesystem-layout-images/achtung-user.png" alt="achtung-user.png" width="349" height="121" />&#160;
<img src="../images/filesystem-layout-images/achtung-system.png" alt="achtung-system.png" width="349" height="151" />
<p>The second alert pops up if you try to rename or delete something in the system hierarchy. Here, the "<i>Do it</i>" button will only become clickable when you're holding down the <tt>SHIFT</tt> key.</p>
<p>The second alert pops up if you try to rename or delete something in the system hierarchy. Here, the "<span class="button">Do it</span>" button will only become clickable when you're holding down the <span class="key">SHIFT</span> key.</p>
<p>Generally, there are three seperate branches springing from the root folder of the boot volume:</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td><tt>/boot/beos/</tt></td><td>&#160;</td><td>belongs to the system. Don't touch!</td></tr>
<tr><td><tt>/boot/common/</tt></td><td>&#160;</td><td>holds files that are shared between users.</td></tr>
<tr><td><tt>/boot/home/</tt></td><td>&#160;</td><td>is your personal folder where you keep your data and settings.</td></tr>
<tr><td><span class="path">/boot/beos/</span></td><td>&#160;</td><td>belongs to the system. Don't touch!</td></tr>
<tr><td><span class="path">/boot/common/</span></td><td>&#160;</td><td>holds files that are shared between users.</td></tr>
<tr><td><span class="path">/boot/home/</span></td><td>&#160;</td><td>is your personal folder where you keep your data and settings.</td></tr>
</table>
<h2><a id="system" name="system">The system folder - <tt>/boot/beos/</tt></a></h2>
<h2><a id="system" name="system">The system folder - <span class="path">/boot/beos/</span></a></h2>
<p>The fact that it's called "<i>beos</i>" shows Haiku's BeOS heritage. It wasn't renamed yet to ensure backward compatibility with BeOS software.<br />
Whatever it's named, you should not alter what's inside. Every update of Haiku can add, remove or overwrite anything within it. If you want to add functionality, maybe with other Tracker Add-Ons or Translators or maybe another hardware driver, you install these things under your own <tt>/boot/home/</tt> hierarchy or, if it's supposed to be for every user, under <tt>/boot/common/</tt>. As long as Haiku isn't multi-user, this distinction has no apparent effect, as there's only one user with one <i>home</i> folder. But since there will be support for more users than one eventually, it makes sense to learn the right way from the start.</p>
Whatever it's named, you should not alter what's inside. Every update of Haiku can add, remove or overwrite anything within it. If you want to add functionality, maybe with other Tracker Add-Ons or Translators or maybe another hardware driver, you install these things under your own <span class="path">/boot/home/</span> hierarchy or, if it's supposed to be for every user, under <span class="path">/boot/common/</span>. As long as Haiku isn't multi-user, this distinction has no apparent effect, as there's only one user with one <i>home</i> folder. But since there will be support for more users than one eventually, it makes sense to learn the right way from the start.</p>
<p>So, let's say you want to install a new Translator for the latest image format, you <b>don't</b> simply copy it into the respective system folder. Remember: Don't touch!<br />
Instead, you put it into the mirrored hierarchy under <tt>/boot/common/</tt> or <tt>/boot/home/config/</tt>.</p>
Instead, you put it into the mirrored hierarchy under <span class="path">/boot/common/</span> or <span class="path">/boot/home/config/</span>.</p>
<p>In our example the location for Translators in the system folder would be</p>
<p><tt>/boot/beos/add-ons/Translators/</tt></p>
<p><span class="path">/boot/beos/add-ons/Translators/</span></p>
<p>So, the user "mirror" folder is either</p>
<p><tt>/boot/home/config/add-ons/Translators/</tt><br />
<p><span class="path">/boot/home/config/add-ons/Translators/</span><br />
or<br />
<tt>/boot/common/add-ons/Translators/</tt></p>
<span class="path">/boot/common/add-ons/Translators/</span></p>
<p>This has another advantage: If the component you have installed messes things up (which is possible as you install hardware drivers like this, too) you are able to choose "<i>Disable User Add-Ons</i>" from the <a href="bootloader.html">Boot Loader</a> menu and are thus always able to boot without the offending component.</p>
<p>Most of the time, however, you won't have to deal with these things at all, since every software that comes from a trusted source should include an installation routine that handles these things.<br />
<!--
@ -69,50 +69,50 @@ If you do want to know more about how things tick in Haiku, have a look at this
-->
</p>
<h2><a id="common" name="common">The common folder - <tt>/boot/common/</tt></a></h2>
<h2><a id="common" name="common">The common folder - <span class="path">/boot/common/</span></a></h2>
<p>Haiku is not a multi-user system yet. Once it is though, every user has her own <i>home</i> folder that is not accessible to anyone else. Every application or added component like Tracker Add-Ons, Translators etc. as well as any data that's supposed to be shared between different users, go here.</p>
<h2><a id="home" name="home">The home folder - <tt>/boot/home/</tt></a></h2>
<p>This folder belongs to you. Here you can create and delete files and folders as you wish. However, you shouldn't mess too much with the <tt>~/config/</tt> directory and its subfolders. You <i>could</i> delete e.g. the <tt>~/config/settings/</tt> folder without damaging the operating system itself, but who wants to lose all his configurations and application settings? In any case, the system warns you with the at the top mentioned alert.</p>
<p>Besides the <tt>~/config/add-ons/</tt> folder, which mirrors the system's add-ons folder for additional components as described above, there are a few other folders of interest. (By the way, the tilde ("<tt>~</tt>") is a shortcut for your home folder, so you don't always have to write "<tt>/boot/home/</tt>" in Terminal.)</p>
<h2><a id="home" name="home">The home folder - <span class="path">/boot/home/</span></a></h2>
<p>This folder belongs to you. Here you can create and delete files and folders as you wish. However, you shouldn't mess too much with the <span class="path">~/config/</span> directory and its subfolders. You <i>could</i> delete e.g. the <span class="path">~/config/settings/</span> folder without damaging the operating system itself, but who wants to lose all his configurations and application settings? In any case, the system warns you with the at the top mentioned alert.</p>
<p>Besides the <span class="path">~/config/add-ons/</span> folder, which mirrors the system's add-ons folder for additional components as described above, there are a few other folders of interest. (By the way, the tilde ("<tt>~</tt>") is a shortcut for your home folder, so you don't always have to write "<span class="path">/boot/home/</span>" in Terminal.)</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="4">
<tr><td><tt>~/mail</tt></td><td style="width:10px;">&#160;</td>
<tr><td><span class="path">~/mail</span></td><td style="width:10px;">&#160;</td>
<td>By default, this is where your mails are kept.</td></tr>
<tr><td><tt>~/queries</tt></td><td style="width:10px;">&#160;</td>
<tr><td><span class="path">~/queries</span></td><td style="width:10px;">&#160;</td>
<td><a href="queries.html">Queries</a> are stored, by default temporarily for 7 days, in this folder.</td></tr>
<tr><td><tt>~/config/be/</tt></td><td>&#160;</td>
<td>Again from our BeOS legacy, the <tt>be</tt> folder contains what's shown in the <a href="deskbar.html#deskbar-menu">Deskbar menu</a>. You can add and remove items either with the Deskbar configuration panel or by putting files, folders or links into this folder directly.</td></tr>
<tr><td><span class="path">~/config/be/</span></td><td>&#160;</td>
<td>Again from our BeOS legacy, the <span class="path">be</span> folder contains what's shown in the <a href="deskbar.html#deskbar-menu">Deskbar menu</a>. You can add and remove items either with the Deskbar configuration panel or by putting files, folders or links into this folder directly.</td></tr>
<tr><td><tt>~/config/bin/</tt></td><td>&#160;</td>
<td>Complements the system's <tt>/boot/beos/bin/</tt> folder and holds all your command line programs.</td></tr>
<tr><td><span class="path">~/config/bin/</span></td><td>&#160;</td>
<td>Complements the system's <span class="path">/boot/beos/bin/</span> folder and holds all your command line programs.</td></tr>
<tr><td><tt>~/config/boot/</tt></td><td>&#160;</td>
<tr><td><span class="path">~/config/boot/</span></td><td>&#160;</td>
<td>This folder is the place for <a href="scripting.html#user-scripts">User Scripts</a> that are executed before or after the system boots up or shuts down.</td></tr>
<tr><td><tt>~/config/fonts/</tt></td><td>&#160;</td>
<tr><td><span class="path">~/config/fonts/</span></td><td>&#160;</td>
<td>Simply copy a TrueType or Postscript font into this folder and its usable right away.</td></tr>
<tr><td><tt>~/config/settings/</tt></td><td>&#160;</td>
<tr><td><span class="path">~/config/settings/</span></td><td>&#160;</td>
<td>This folder contains the settings to all applications and a few configurations for the system. Some applications manage their settings in their own subfolders, others simply put their configuration file in there.</td></tr>
<tr><td><tt>~/config/settings/beos_mime/</tt></td><td>&#160;</td>
<tr><td><span class="path">~/config/settings/beos_mime/</span></td><td>&#160;</td>
<td>In this <acronym title="Multipurpose Internet Mail Extensions">MIME</acronym> database Haiku keeps track of all the different <a href="filetypes.html">filetypes</a> and their settings.</td></tr>
<tr><td class="onelinetop"><tt>~/config/settings/kernel/drivers/</tt></td><td>&#160;</td>
<td>There, one settings files that may be of interest. <tt>kernel</tt> offers some low level configurations like disabling <acronym title="Symmetric Multi Processing">SMP</acronym>, activating serial debugging or enabling advanced power management. You activate a configuration line by removing the commentary symbol "<tt>#</tt>". Be careful here!</td></tr>
<tr><td class="onelinetop"><span class="path">~/config/settings/kernel/drivers/</span></td><td>&#160;</td>
<td>There, one settings files that may be of interest. <span class="cli">kernel</span> offers some low level configurations like disabling <acronym title="Symmetric Multi Processing">SMP</acronym>, activating serial debugging or enabling advanced power management. You activate a configuration line by removing the commentary symbol "<tt>#</tt>". Be careful here!</td></tr>
<tr><td><tt>~/config/settings/Tracker/</tt></td><td>&#160;</td>
<tr><td><span class="path">~/config/settings/Tracker/</span></td><td>&#160;</td>
<td>Here are some interesting subfolders:</td></tr>
<tr><td align="right"><tt>DefaultFolderTemplate/</tt></td><td style="width:10px;"></td><td>Show and arrange all attributes and the window size to your liking. Every new folder you create will use it as a template.</td></tr>
<tr><td align="right"><span class="path">DefaultFolderTemplate/</span></td><td style="width:10px;"></td><td>Show and arrange all attributes and the window size to your liking. Every new folder you create will use it as a template.</td></tr>
<tr><td align="right"><tt>DefaultQueryTemplates/</tt></td><td></td><td>You can define the layout of query result windows for certain filetypes. See topic <a href="queries.html#result-window">Query: The result window</a>.</td></tr>
<tr><td align="right"><span class="path">DefaultQueryTemplates/</span></td><td></td><td>You can define the layout of query result windows for certain filetypes. See topic <a href="queries.html#result-window">Query: The result window</a>.</td></tr>
<tr><td align="right"><tt>Go/</tt></td><td></td><td>Put links to your favorite locations in here to make them available e.g. in open and save panels. See topic <a href="gui.html#favorites-recent">Haiku's GUI: Favorites and recent folders</a>.</td></tr>
<tr><td align="right"><span class="path">Go/</span></td><td></td><td>Put links to your favorite locations in here to make them available e.g. in open and save panels. See topic <a href="gui.html#favorites-recent">Haiku's GUI: Favorites and recent folders</a>.</td></tr>
<tr><td align="right"><tt>Tracker New Template/</tt></td><td></td><td>Add a template for any filetype that's then available from Tracker's <i>File | New...</i> menu. See topic <a href="tracker.html#working-with-files">Tracker: Working with files</a>.</td></tr>
<tr><td align="right"><span class="path">Tracker New Template/</span></td><td></td><td>Add a template for any filetype that's then available from Tracker's <span class="menu">File | New...</span> menu. See topic <a href="tracker.html#working-with-files">Tracker: Working with files</a>.</td></tr>
</table>
</div>

41
docs/userguide/en/filetypes.html
View File

@ -5,7 +5,7 @@
<head>
<!--
*
* Copyright 2008, Haiku. All rights reserved.
* Copyright 2008-2009, Haiku. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
@ -39,41 +39,42 @@
<p>Other than Windows, Haiku doesn't rely on the 3-letter file extension for a file type (e.g. .txt, .jpg, .mp3). This method is only a last resort fallback. Haiku uses <acronym title="Multipurpose Internet Mail Extensions">MIME</acronym> types just like it's custom on the internet.</p>
<h3><a id="specific-file" name="specific-file">Setting the filetype of a specific file</a></h3>
<p>You can change the type of a specific file, its icon and the associated application. Select the file and invoke the Add-Ons | Filetype add-on from the right-click context menu.</p>
<p>You can change the type of a specific file, its icon and the associated application. Select the file and invoke the <span class="menu">Add-Ons | Filetype add-on</span> from the right-click context menu.</p>
<img src="../images/filetypes-images/filetype-addon.png" alt="filetype-addon.png" width="288" height="212" />
<h3><a name="filetype">The File Type</a></h3>
<p>This is a JPEG file, it's MIME string image/jpeg. Let's say you definitely know that it's not a JPEG but a GIF. You can change that either by entering the correct MIME string by hand or with one of the two buttons below the textbox:</p>
<ul>
<li><i>Select...</i> shows a hierarchical list of filetypes where you navigate to <tt>image | GIF Image</tt>.</li>
<li><i>Same as...</i> opens a file dialog where you choose any file that already has the filetype you're looking for.</li>
</ul>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><span class="button">Select...</span></td><td>&#160;</td><td>shows a hierarchical list of filetypes where you navigate to <tt>image | GIF Image</tt>.</td></tr>
<tr><td><span class="button">Same as...</span></td><td>&#160;</td><td>opens a file dialog where you choose any file that already has the filetype you're looking for.</td></tr>
</table>
<h3><a id="preferred-app" name="preferred-app">The Preferred Application</a></h3>
<p>This drop-down menu shows a list of all applications that can handle this particular filetype. From here you can choose which program should open this specific file when it's double-clicked. You could, for example, change a HTML file's preferred application from the browser to a text editor while you're working on it. Every other HTML file still opens in the browser, only this particular one starts in your text editor.</p>
<p>The "Default Application" is the one that's set globally for that filetype. If you don't find the program you want to associate with this file in the drop-down menu, you'll again find the buttons Select... and Same As... which do the similar thing described under "The File Type" above.</p>
<p>The <span class="menu">Default Application</span> is the one that's set globally for that filetype. If you don't find the program you want to associate with this file in the drop-down menu, you'll again find the buttons <span class="button">Select...</span> and <span class="button">Same As...</span> which do the similar thing described under "The File Type" above.</p>
<h3><a id="icon" name="icon">The Icon</a></h3>
<p>If you're wondering why the icon well on the top right is empty: Icons are normally inherited from the system default for that filetype. You can open the <i>Filetype Add-On</i> of a file that contains an icon and drag&amp;drop it into your file's icon well. Or you double-click the icon well and create or edit your own icon in <i>Icon-O-Matic</i>.</p>
<p>If you're wondering why the icon well on the top right is empty: Icons are normally inherited from the system default for that filetype. You can open the <span class="app">Filetype Add-On</span> of a file that contains an icon and drag&amp;drop it into your file's icon well. Or you double-click the icon well and create or edit your own icon in <span class="app">Icon-O-Matic</span>.</p>
<h2><a id="filetypes-preferences" name="filetypes-preferences">Global settings with the Filetypes Preferences</a></h2>
<p>The <i>Filetypes</i> preferences don't deal with individual files but with global settings of filetypes. You can change default icons and preferred applications or add, remove, or alter attributes of whole filetypes. You can even create your own filetype from scratch.</p>
<p>All filetypes and their configurations are stored in <tt>/boot/home/config/settings/beos_mime/</tt>. Before you start experimenting, it may be prudent to make a backup of that folder...</p>
<p>To learn more about the <i>Filetypes</i> preferences see the workshop: <a href="workshop-filetypes+attributes.html">Filetypes, Attributes, Index and Queries</a>.</p>
<p>The <span class="app">Filetypes</span> preferences don't deal with individual files but with global settings of filetypes. You can change default icons and preferred applications or add, remove, or alter attributes of whole filetypes. You can even create your own filetype from scratch.</p>
<p>All filetypes and their configurations are stored in <span class="path">/boot/home/config/settings/beos_mime/</span>. Before you start experimenting, it may be prudent to make a backup of that folder...</p>
<p>To learn more about the <span class="app">Filetypes</span> preferences see the workshop: <a href="workshop-filetypes+attributes.html">Filetypes, Attributes, Index and Queries</a>.</p>
<h2><a id="settings-apps" name="settings-apps">Special settings for applications</a></h2>
<p>If you invoke the <i>Filetype Add-On</i> on an executable (here: <i>StyledEdit</i>), you'll get a different dialog:</p>
<p>If you invoke the <span class="app">Filetype Add-On</span> on an executable (here: <span class="app">StyledEdit</span>), you'll get a different dialog:</p>
<img src="../images/filetypes-images/filetype-addon-stylededit.png" alt="filetype-addon-stylededit.png" width="353" height="422" />
<p>On top, you'll see, instead of a standardized MIME string, the unique application signature. With it, the system finds the program wherever it's installed.</p>
<p>Below it are several flags, controlling the app's behaviour:</p>
<ul>
<li><i>Single Launch</i> - Only one instance of the app can be running per executable file. If you have two copies of that app, however, they can run side by side.</li>
<li><i>Multiple Launch</i> - Many instances of the app can run simultaneously.</li>
<li><i>Exclusive Launch</i> - Really only one instance with that app's signature is allowed to run at a time.</li>
<li><i>Args Only</i> - Indicates the app doesn't respond to messages.</li>
<li><i>Background App</i> - The app won't appear in Twitcher or the list of running apps of the Deskbar.</li>
</ul>
<p>Then there's the list of supported filetypes. You can add (and remove) filetypes if you think the application can handle them. As a consequence, the app will appear in the menu for preferred applications or Tracker's <i>Open with...</i> context menu when you right-click on a file of that type.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><span class="menu">Single Launch</span></td><td>&#160;</td><td>Only one instance of the app can be running per executable file. If you have two copies of that app, however, they can run side by side.</td></tr>
<tr><td><span class="menu">Multiple Launch</span></td><td>&#160;</td><td>Many instances of the app can run simultaneously.</td></tr>
<tr><td class="onelinetop"><span class="menu">Exclusive Launch</span></td><td>&#160;</td><td>Really only one instance with that app's signature is allowed to run at a time.</td></tr>
<tr><td><span class="menu">Args Only</span></td><td>&#160;</td><td>Indicates the app doesn't respond to messages.</td></tr>
<tr><td><span class="menu">Background App</span></td><td>&#160;</td><td>The app won't appear in Twitcher or the list of running apps of the Deskbar.</td></tr>
</table>
<p>Then there's the list of supported filetypes. You can add (and remove) filetypes if you think the application can handle them. As a consequence, the app will appear in the menu for preferred applications or Tracker's <span class="menu">Open with...</span> context menu when you right-click on a file of that type.</p>
<p>At the bottom are version and copyright information. Like the application signature, they are filled in by the app's author and shouldn't be altered.</p>
</div>

22
docs/userguide/en/gui.html
View File

@ -43,7 +43,7 @@
<ol>
<li><p>The Deskbar is Haiku's "Start" menu and taskbar, if you will. See topic <a href="deskbar.html">Deskbar</a>.</p></li>
<li>The yellow tab offers more than just a program's name or a document's filename:
<ul><li>You can move it by holding the <tt>SHIFT</tt> key while dragging it to another position, enabling you to stack a number of windows and conveniently access them by their named tab.</li>
<ul><li>You can move it by holding the </span>&#160;<span class="key">SHIFT</span> key while dragging it to another position, enabling you to stack a number of windows and conveniently access them by their named tab.</li>
<li>You minimize a window with a double-click on its tab. A such hidden window can be accessed by its entry in the <a href="deskbar.html">Deskbar</a> or the <a href="twitcher.html">Twitcher</a>.</li>
<li>You can send a window to the back with a right-click on its tab (or its border).</li></ul></li>
<li><p>The close button.</p></li>
@ -59,21 +59,21 @@ You can enter parent folders with the drop-down menu above the file listing.</p>
<p>If you already have a Tracker window with the location for a file open, you can simply drag either any file or the folder-representation (i.e. the symbol to the far right in its menubar) into the panel. This changes the panel to that new location.</p>
<h3><a id="open-save-shortcuts" name="open-save-shortcuts">Keyboard shortcuts</a></h3>
<p>You can use many of the shortcuts also used in Tracker. Besides the commands that are also available through the <i>File</i> menu, there are a few not that obvious:</p>
<p>You can use many of the shortcuts also used in Tracker. Besides the commands that are also available through the <span class="menu">File</span> menu, there are a few not that obvious:</p>
<table summary="shortcuts" border="0" cellspacing="0" cellpadding="2">
<tr><td><tt>ALT+N</tt></td><td></td><td> Creates a new folder.</td></tr>
<tr><td><tt>ALT+E</tt></td><td></td><td> Lets you rename the selected entry.</td></tr>
<tr><td><tt>ALT+CURSOR-UP</tt></td><td style="width:24px;"></td><td> Opens the parent folder.</td></tr>
<tr><td class="onelinetop"><tt>ALT+CURSOR-DOWN or RETURN</tt></td><td></td><td> Opens the selected folder.</td></tr>
<tr><td><tt>ALT+D</tt></td><td></td><td> Takes you to your Desktop.</td></tr>
<tr><td><tt>ALT+H</tt></td><td></td><td> Takes you to your Home folder.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">N</span></td><td></td><td> Creates a new folder.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">E</span></td><td></td><td> Lets you rename the selected entry.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">CURSOR-UP</span></td><td style="width:24px;"></td><td> Opens the parent folder.</td></tr>
<tr><td class="onelinetop"><span class="key">ALT</span>&#160;<span class="key">CURSOR-DOWN</span> or <span class="key">ENTER</span></td><td></td><td> Opens the selected folder.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">D</span></td><td></td><td> Takes you to your Desktop.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">H</span></td><td></td><td> Takes you to your Home folder.</td></tr>
</table>
<h3><a id="favorites-recent" name="favorites-recent">Favorites and recent folders</a></h3>
<p>The menu <i>Favorites</i> provides recently visited folders and favorite locations that you can set up yourself. As indicated by the little arrow, you can also use these locations to navigate further down the hierarchy via submenus.</p>
<p>The menu <span class="menu">Favorites</span> provides recently visited folders and favorite locations that you can set up yourself. As indicated by the little arrow, you can also use these locations to navigate further down the hierarchy via submenus.</p>
<img src="../images/gui-images/favorites.png" alt="favorites.png" width="455" height="209" />
<p>To add a Favorite, you simply navigate to your destination and choose <i>Favorites | Add Current Folder</i>. From now on it will appear in every open/save panel. To remove a Favorite, choose <i>Favorites | Configure Favorites...</i> and delete its entry.<br />
All Favorites are kept in <tt>/boot/home/config/settings/Tracker/Go/</tt>. So you might as well add and remove links to files and folders there directly.</p>
<p>To add a Favorite, you simply navigate to your destination and choose <span class="menu">Favorites | Add Current Folder</span>. From now on it will appear in every open/save panel. To remove a Favorite, choose <span class="menu">Favorites | Configure Favorites...</span> and delete its entry.<br />
All Favorites are kept in <span class="path">/boot/home/config/settings/Tracker/Go/</span>. So you might as well add and remove links to files and folders there directly.</p>
</div>

11
docs/userguide/en/index.html
View File

@ -5,7 +5,7 @@
<head>
<!--
*
* Copyright 2008, Haiku. All rights reserved.
* Copyright 2008-2009, Haiku. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
@ -83,7 +83,7 @@ be:deskbar_item_status
last_modified
name
size
</pre></li>
</pre><p><br /></p></li>
<li><b>mkindex</b> - Adds an attribute to the index of a volume/partition.
<pre>Usage: mkindex [options] &lt;attribute&gt;
Creates a new index for the specified attribute.
@ -97,10 +97,9 @@ Creates a new index for the specified attribute.
-v, --verbose print information about the index being created
</pre>
<p><i><b>Note:</b> Only <b>new</b> files with that attribute come automatically into the index!</i><br />
Existing files have to be added manually by copying them and deleting the originals after that. Alternatively you can use the tool <a href="http://www.bebits.com/app/2033" rel="nofollow">reindex</a>.
</p>
</li>
<p>Only <b>new</b> files with that attribute come automatically into the index!<br />
Existing files have to be added manually by copying them and deleting the originals after that. Alternatively you can use the tool <a href="http://www.bebits.com/app/2033">reindex</a>.
</p></li>
<li><b>rmindex</b> - Removes an attribute from the index of a volume/partition.
<pre>Usage: rmindex [OPTION]... INDEX_NAME

2
docs/userguide/en/installation/install-boot-process.html
View File

@ -45,7 +45,7 @@ OK, not going into more detail as that's not essential here.</p>
Boot managers range from totally simple ones that are just enough to find the partition marked active and jump to the partition boot code of said partition, to almost complete operating systems with editing capabilities and other fancy features.</p>
<h1>The Partition Boot Record</h1>
<p>Additionally to the Master Boot Record, there can also be a partition boot record. It's located at the start of a partition and contains further boot code. Depending on the boot manager you are using and how you configured it, this boot code will be executed or not. In the case of Haiku the partition boot code does locate the <tt>/boot/beos/system/zbeos</tt>" file which then starts the operating system boot process.<br /> Additionally it contains the partition offset needed to access this partition during boot. A wrong value for that offset is probably one of the most common reason why a Haiku installation doesn't start to boot.</p>
<p>Additionally to the Master Boot Record, there can also be a partition boot record. It's located at the start of a partition and contains further boot code. Depending on the boot manager you are using and how you configured it, this boot code will be executed or not. In the case of Haiku the partition boot code does locate the <span class="path">/boot/beos/system/zbeos</span>" file which then starts the operating system boot process.<br /> Additionally it contains the partition offset needed to access this partition during boot. A wrong value for that offset is probably one of the most common reason why a Haiku installation doesn't start to boot.</p>
<p>As mentioned, whether or not the partition boot code is used depends on the boot manager and boot manager configuration. If you take GRUB installed as boot manager in the MBR and booting Linux. GRUB knows how to handle most Linux filesystems and it does know how to load and start a Linux kernel off of it. Therefore it can directly load Linux without the need for any additional boot code.<br />
However GRUB does neither know how to handle BFS and find the zbeos boot loader, nor would it really know how to execute it. Therefore you cannot use GRUB to directly boot Haiku.<br />
Instead you need to chainload the partition boot code of the BFS partition, as it knows how to handle both the BFS and zbeos.</p>

28
docs/userguide/en/installation/install-raw.html
View File

@ -38,7 +38,7 @@
<p>If you can't or don't want to go through building from source, you can also install an already built image. You'll have to <a href="http://www.haiku-files.org/raw">download a raw image</a> for that, not a VMWare image. Note that these are test images, they are not complete distributions that include a lot of software, both to keep the size and complexity of building them down.</p>
<h1>Installing on a partition</h1>
<p>After you have downloaded the raw image, you need to get this image to the partition or medium you intend to install it to. Under BeOS, Linux or basically everything except Windows you can use <tt>dd</tt> to just copy it over, using the partition or drive as a target.</p>
<p>After you have downloaded the raw image, you need to get this image to the partition or medium you intend to install it to. Under BeOS, Linux or basically everything except Windows you can use <span class="cli">dd</span> to just copy it over, using the partition or drive as a target.</p>
<p>Under BeOS to partition X on the master on the first channel:</p>
<pre class="terminal">dd if=/path/to/image of=/dev/disk/ide/ata/0/master/X</pre>
@ -49,48 +49,48 @@
<p>Under Linux to partition X on the first hard disk:</p>
<pre class="terminal">dd if=/path/to/image of=/dev/hdaX</pre>
<p>Make extra sure that you have the right partition picked there, as these commands are destructive. Recheck with a partitioning tool to verify for example. Note that you'll probably need administrative rights under Linux, so use <tt>sudo</tt> or <tt>su</tt> to execute these commands.</p>
<p>Make extra sure that you have the right partition picked there, as these commands are destructive. Recheck with a partitioning tool to verify for example. Note that you'll probably need administrative rights under Linux, so use <span class="cli">sudo</span> or <span class="cli">su</span> to execute these commands.</p>
<p>If you want to put the image at the absolute start of the drive (so that you don't need an additional boot manager), make sure that you write to the whole raw drive and not to a partition. You do that by specifying a raw device instead of a partition. Under Linux you would for example omit the partition number resulting in <tt>sdb</tt> instead of <tt>sdb1</tt>. Under BeOS you would pick the <tt>.../raw</tt> path instead of one with a number. If you use such a command, you overwrite the MBR containing the partition table. This means, that all the partitions on that drive will become inaccessible (not only the first part of the drive). So be sure that you want to do such a destructive operation!</p>
<p>If you want to put the image at the absolute start of the drive (so that you don't need an additional boot manager), make sure that you write to the whole raw drive and not to a partition. You do that by specifying a raw device instead of a partition. Under Linux you would for example omit the partition number resulting in <tt>sdb</tt> instead of <tt>sdb1</tt>. Under BeOS you would pick the <span class="path">.../raw</span> path instead of one with a number. If you use such a command, you overwrite the MBR containing the partition table. This means, that all the partitions on that drive will become inaccessible (not only the first part of the drive). So be sure that you want to do such a destructive operation!</p>
<p>Under Windows things are sadly a bit more complicated. You can try <tt>dd</tt> for Windows or use a tool like <a href="http://shounen.ru/soft/flashnul">Flashnul</a> to get the image to a partition or USB drive. You should find the tools on the Internet, go back to the <a href="installation-usb.html">USB section</a> to learn how to use <i>Flashnul</i> to copy a Haiku image.</p>
<p>Under Windows things are sadly a bit more complicated. You can try <span class="cli">dd</span> for Windows or use a tool like <a href="http://shounen.ru/soft/flashnul">Flashnul</a> to get the image to a partition or USB drive. You should find the tools on the Internet, go back to the <a href="installation-usb.html">USB section</a> to learn how to use <span class="app">Flashnul</span> to copy a Haiku image.</p>
<p>Note that when you just copy over an image to a partition or drive, you won't be able to use the full size of the target partition/drive. The image was built with a certain size (256MB currently) which is the size of the filesystem inside the image. So there's no real point in making a 10GB partition available for it, it won't be usable.</p>
<h1>Copying the contents of a pre-built image</h1>
<p>Instead of copying the image itself you can also make a separate BFS partition yourself and then copy over the contents of the image to that partition. You will need a platform supporting BFS to do that obviously, which leaves you with two possible options. Either you use a version of BeOS to do the setup with <i>DriveSetup</i> or <tt>mkbfs</tt> or you use Haiku itself with <i>Installer</i> or <i>DriveSetup</i>.<br />
Once you've created and initialized the target partition you can mount the image (using tools like <i>Mount Image</i> or through the Terminal) and copy over all the files. If you are under Haiku, you can just as well use <i>Installer</i> to make a duplicate of your currently booted installation.</p>
<p>Instead of copying the image itself you can also make a separate BFS partition yourself and then copy over the contents of the image to that partition. You will need a platform supporting BFS to do that obviously, which leaves you with two possible options. Either you use a version of BeOS to do the setup with <span class="app">DriveSetup</span> or <span class="cli">mkbfs</span> or you use Haiku itself with <span class="app">Installer</span> or <span class="app">DriveSetup</span>.<br />
Once you've created and initialized the target partition you can mount the image (using tools like <span class="app">Mount Image</span> or through the Terminal) and copy over all the files. If you are under Haiku, you can just as well use <span class="app">Installer</span> to make a duplicate of your currently booted installation.</p>
<h1>Making it bootable</h1>
<p>When you just create a plain partition and initialize it to a BFS filesystem or if you copy over a complete Haiku image, this doesn't necessarily make the partition bootable. The partition boot record may be missing, or the partition offset could be misconfigured. The prebuilt images for example contain a partition offset of 0 for example, since they are not actually partitioned. They only consist of a direct BFS filesystem, so the offset to that is 0. This will work in exactly one case, where you don't actually put it into a partition. If you for example copy such an image directly to a USB drive starting from 0, overwriting the MBR (destroying all partitions already there), then this will boot. If you however copy an image to the first partition on your hard disk, this will not work out of the box, as the boot code in the partition boot record won't find the desired filesystem at offset 0 (that's where the MBR still is).</p>
<p>To make sure a partition boot record is there and it contains the right partition offset, you can use the tool <tt>makebootable</tt>. It will do both, write the partition boot code to the beginning of the partition and detect and write the partition offset to where it is needed. You can use the <tt>makebootable</tt> from BeOS if you have a BeOS installation that has access to the partition in question. To do that, mount the volume you have Haiku installed to and use:</p>
<p>To make sure a partition boot record is there and it contains the right partition offset, you can use the tool <span class="cli">makebootable</span>. It will do both, write the partition boot code to the beginning of the partition and detect and write the partition offset to where it is needed. You can use the <span class="cli">makebootable</span> from BeOS if you have a BeOS installation that has access to the partition in question. To do that, mount the volume you have Haiku installed to and use:</p>
<pre class="terminal">makebootable /HaikuMountpoint</pre>
<p>Where <tt>/HaikuMountpoint</tt> is where you have mounted your Haiku volume to. Note that the BeOS' <tt>makebootable</tt> can be used, because the partition boot record does only load the zbeos boot loader. As Haiku does provide a zbeos as well and there is no information passed from the partition boot code to the boot loader, this is compatible between BeOS and Haiku and you can use a BeOS' <tt>makebootable</tt> with a Haiku boot loader and the other way around.</p>
<p>Where <span class="path">/HaikuMountpoint</span> is where you have mounted your Haiku volume to. Note that the BeOS' <span class="cli">makebootable</span> can be used, because the partition boot record does only load the zbeos boot loader. As Haiku does provide a zbeos as well and there is no information passed from the partition boot code to the boot loader, this is compatible between BeOS and Haiku and you can use a BeOS' <span class="cli">makebootable</span> with a Haiku boot loader and the other way around.</p>
<p>If you already have some Haiku medium capable of booting Haiku (like a USB drive) you could also boot into Haiku and run <tt>makebootable</tt> from there. Note that there is currently a bug that will require you to run it from the location it resides in like so:</p>
<p>If you already have some Haiku medium capable of booting Haiku (like a USB drive) you could also boot into Haiku and run <span class="cli">makebootable</span> from there. Note that there is currently a bug that will require you to run it from the location it resides in like so:</p>
<pre class="terminal">cd /bin
makebootable /MountpointOfNewHaikuInstallation</pre>
<p>If you are on Linux or another build platform that has support for <tt>makebootable</tt> and have the sources available you can run:</p>
<p>If you are on Linux or another build platform that has support for <span class="cli">makebootable</span> and have the sources available you can run:</p>
<pre class="terminal">jam run ":&lt;build&gt;makebootable" /dev/sdaX</pre>
<p>Where the <tt>/dev/sdaX</tt> is the partition that is supposed to be made bootable. Under Windows this is currently not possible.</p>
<p>Where the <span class="path">/dev/sdaX</span> is the partition that is supposed to be made bootable. Under Windows this is currently not possible.</p>
<h1>Configuring the boot manager</h1>
<p>When the partition itself is bootable, i.e. contains a partition boot record and the correct partition offset, there needs to be a way to get it executed. If you use a boot manager like GRUB, you need to instruct it to load from that partition. You do that for GRUB by adding an entry to its <tt>menu.lst</tt> usually located at <tt>/boot/grub/menu.lst</tt>. The following would instruct it to switch to the partition and then just chainload the partition boot record:</p>
<p>When the partition itself is bootable, i.e. contains a partition boot record and the correct partition offset, there needs to be a way to get it executed. If you use a boot manager like GRUB, you need to instruct it to load from that partition. You do that for GRUB by adding an entry to its <span class="cli">menu.lst</span> usually located at <span class="path">/boot/grub/menu.lst</span>. The following would instruct it to switch to the partition and then just chainload the partition boot record:</p>
<pre>title Haiku
rootnoverify (hd0,3)
chainloader +1</pre>
<p>That would work if you installed to disk "0" and partition "3". Note that the GRUB naming is one-off the Linux one, so if you have it installed to <tt>/dev/sda4</tt> that would translate to disk "0" (sda == 0, sdb == 1, ...) and partition "3" (4 - 1).</p>
<p>That would work if you installed to disk "0" and partition "3". Note that the GRUB naming is one-off the Linux one, so if you have it installed to <span class="path">/dev/sda4</span> that would translate to disk "0" (sda == 0, sdb == 1, ...) and partition "3" (4 - 1).</p>
<p>In case you are using the BeOS boot manager, just re-run the <tt>bootman</tt> command and add the new Haiku partition to the boot menu.</p>
<p>In case you are using the BeOS boot manager, just re-run the <span class="cli">bootman</span> command and add the new Haiku partition to the boot menu.</p>
<p>If you have another boot manager consult its documentation on how to chainload partitions, most should support such a thing, possibly named a bit different. In doubt just add an entry for the partition, probably this will cause it to chainload, even if not explicitly named so.</p>

12
docs/userguide/en/installation/install-source-beos.html
View File

@ -37,7 +37,7 @@
<h1>Getting the source</h1>
<p><b>Note:</b> <i>All commands must be executed in the Terminal.</i></p>
<p>Go to the parent directory for Haiku's repository (ex. <tt>/home/develop</tt>) and enter:</p>
<p>Go to the parent directory for Haiku's repository (ex. <span class="path">/home/develop</span>) and enter:</p>
<pre class="terminal">svn checkout svn://svn.berlios.de/haiku/haiku/trunk haiku</pre>
@ -49,11 +49,11 @@
<h1>Installing the cross-compiler</h1>
<p>Download the <a href="http://haiku.mlotz.ch/haiku_cross_compiler_bone_2.95.3-haiku-080323.zip">Haiku cross-compiler</a> and extract it to <tt>/boot</tt> (for example by setting the <i>Destination</i> in Expander to just <tt>/boot</tt>). Then you need to configure your tree to use this cross compiler. Go to the root folder of your checked out Haiku repository and invoke the configure script with the <tt>--cross-tools-prefix</tt> option like this:</p>
<p>Download the <a href="http://haiku.mlotz.ch/haiku_cross_compiler_bone_2.95.3-haiku-080323.zip">Haiku cross-compiler</a> and extract it to <span class="path">/boot</span> (for example by setting the <i>Destination</i> in Expander to just <span class="path">/boot</span>). Then you need to configure your tree to use this cross compiler. Go to the root folder of your checked out Haiku repository and invoke the configure script with the <span class="cli">--cross-tools-prefix</span> option like this:</p>
<pre class="terminal">configure --cross-tools-prefix /boot/apps/haiku/cross-tools/bin/i586-pc-haiku-</pre>
<p>Be careful to include all of the string up to and including the last dash, as all the cross compiler tools have this prefix (they are for example called <tt>i586-pc-haiku-ar</tt>). You need to specify this prefix everytime you run configure.</p>
<p>Be careful to include all of the string up to and including the last dash, as all the cross compiler tools have this prefix (they are for example called <span class="cli">i586-pc-haiku-ar</span>). You need to specify this prefix everytime you run configure.</p>
<h1>Building the source</h1>
@ -61,19 +61,19 @@
<pre class="terminal">jam</pre>
<p style="text-indent: 15pt"><b>Note:</b> <i>this will just build any target that is found in the tree. This is usually not that useful, as many parts might not build and are not required. So optionally, a target can be specified by adding a target name. For example, </i><tt>jam app_server</tt><i> will only build the </i><tt>app_server</tt><i> target. Normally though you will want to build an image or installation using the commands below. Add the </i><tt>-a</tt><i> option to rebuild the whole source or only the specified target in case </i><tt>Jam</tt><i> didn't notice source changes.</i></p>
<p style="text-indent: 15pt"><b>Note:</b> <i>this will just build any target that is found in the tree. This is usually not that useful, as many parts might not build and are not required. So optionally, a target can be specified by adding a target name. For example, </i><span class="cli">jam app_server</span><i> will only build the </i><tt>app_server</tt><i> target. Normally though you will want to build an image or installation using the commands below. Add the </i><span class="cli">-a</span><i> option to rebuild the whole source or only the specified target in case </i><span class="cli">jam</span><i> didn't notice source changes.</i></p>
<h1>Building an image</h1>
<p>You can build a Haiku image with:</p>
<pre class="terminal">jam haiku-image</pre>
<p>This will place a file named <tt>haiku.image</tt> into the <tt>generated/</tt> folder.</p>
<p>This will place a file named <span class="cli">haiku.image</span> into the <span class="path">generated/</span> folder.</p>
<p>To build an image for testing in VMWare:</p>
<pre class="terminal">jam haiku-vmware-image</pre>
<p>This will place a file named <tt>haiku.vmdk</tt> into the <tt>generated/</tt> folder.</p>
<p>This will place a file named <span class="cli">haiku.vmdk</span> into the <span class="path">generated/</span> folder.</p>
<p>Instead of building an image, you may install Haiku on a mounted partition using:</p>
<pre class="terminal">HAIKU_INSTALL_DIR=/target_folder jam install-haiku</pre>

44
docs/userguide/en/installation/install-source-linux.html
View File

@ -61,7 +61,7 @@ For anonymous check-out:</p>
<p>If you have a valid Haiku developer account at Berlios:</p>
<pre class="terminal">svn checkout https://developername@svn.berlios.de/svnroot/repos/haiku/haiku/trunk trunk</pre>
<p>If there are any errors while checking out the source, just cd into the trunk directory and type <tt>svn update</tt> to get any missed files.<br />
<p>If there are any errors while checking out the source, just cd into the trunk directory and type <span class="cli">svn update</span> to get any missed files.<br />
This is also how you update the code in the future.</p></li>
<li><p>Build the cross compiler tools (GCC 2.95):</p>
@ -73,21 +73,21 @@ This is also how you update the code in the future.</p></li>
</ol>
<p><br /></p>
<p>To download all code changes from now on, simply enter the <tt>haiku/trunk/</tt> folder and type:</p>
<p>To download all code changes from now on, simply enter the <span class="path">haiku/trunk/</span> folder and type:</p>
<pre class="terminal">svn update</pre>
<h1>Customizing UserBuildConfig</h1>
<p>Now you could already start to build RAW or VMWare images. Before we come to that, however, let's have a look at the <tt>UserBuildConfig</tt> that can be used to customize and automate some things.</p>
<p>Now you could already start to build RAW or VMWare images. Before we come to that, however, let's have a look at the <span class="cli">UserBuildConfig</span> that can be used to customize and automate some things.</p>
<p>In <tt>trunk/haiku/build/jam/</tt> there's a <tt>UserBuildConfig.ReadMe</tt> that explains various options. <b>Don't</b> simply rename it and use it as <tt>UserBuildConfig</tt>!</p>
<p>You start by duplicating the <tt>UserBuildConfig.sample</tt> and the remove the<tt>.sample</tt> suffix to get your <tt>UserBuildConfig</tt>. From the <tt>.ReadMe</tt> you can copy interesting parts into your config and customize them there.</p>
<p>In <span class="path">trunk/haiku/build/jam/</span> there's a <span class="cli">UserBuildConfig.ReadMe</span> that explains various options. <b>Don't</b> simply rename it and use it as <span class="cli">UserBuildConfig</span>!</p>
<p>You start by duplicating the <span class="cli">UserBuildConfig.sample</span> and the remove the<span class="cli">.sample</span> suffix to get your <span class="cli">UserBuildConfig</span>. From the <span class="cli">.ReadMe</span> you can copy interesting parts into your config and customize them there.</p>
<ol>
<li><p>First, the line is needed for the optional "OpenSSH" package:</p>
<pre>HAIKU_IMAGE_HOST_NAME = "TEST" ;</pre>
</li>
<li><p>There are several optional software packages available, that are dowloaded at build time if they haven't been so already. For a list of all available packages, see <tt>haiku/trunk/build/jam/OptionalPackages</tt>. Here's an example:</p>
<li><p>There are several optional software packages available, that are dowloaded at build time if they haven't been so already. For a list of all available packages, see <span class="path">haiku/trunk/build/jam/OptionalPackages</span>. Here's an example:</p>
<pre># Add these optional packages.
AddOptionalHaikuImagePackages Beam ;
AddOptionalHaikuImagePackages BeHappy ;
@ -107,15 +107,15 @@ AddSymlinkToHaikuImage home config settings
: /boot/beos/etc/timezones/Europe/Paris : timezone ;
AddFilesToHaikuImage home config settings : German
: Key_map ;</pre></li>
<li><p>The build process can be fine tuned until it fits your needs. You could create your own folder <tt>haiku/trunk/user_data/</tt> and put files there that are then copied or unzipped into the image. Zipping is important when dealing with Haiku files with their attributes, because zipping them up will preserve them on non-BFS partitions.<br />
<li><p>The build process can be fine tuned until it fits your needs. You could create your own folder <span class="path">haiku/trunk/user_data/</span> and put files there that are then copied or unzipped into the image. Zipping is important when dealing with Haiku files with their attributes, because zipping them up will preserve them on non-BFS partitions.<br />
For example:</p>
<pre># Zip up your emails between each system update and place the archive into the
# user_data folder to be automatically put back when building the new image.
UnzipArchiveToHaikuImage home
: $(HAIKU_TOP)/user_data/mail.zip ;</pre>
<p>The first line defines the location in the image where the archive will be unzipped (here: <tt>/boot/home/</tt>). Deeper hierarchies are separated with a blank instead of the usual "<tt>/</tt>" (see the setting of the timezone above).<br />
The second line is the location of the zip file. <tt>$(HAIKU_TOP)</tt> is the lowest level of the checked out source tree, normally <tt>haiku/trunk/</tt>.</p>
<p>The first line defines the location in the image where the archive will be unzipped (here: <span class="path">/boot/home/</span>). Deeper hierarchies are separated with a blank instead of the usual "<span class="path">/</span>" (see the setting of the timezone above).<br />
The second line is the location of the zip file. <tt>$(HAIKU_TOP)</tt> is the lowest level of the checked out source tree, normally <span class="path">haiku/trunk/</span>.</p>
<p>In the same way, you use <tt>CopyDirectoryToHaikuImage</tt> and <tt>AddFilesToHaikuImage</tt> to copy whole directories or single files into the image.</p></li>
<li><p>The above commands are executed when building any kind of image. "Build Profiles" provide the means to set commands specifically for different configurations.<br />
@ -134,14 +134,14 @@ switch $(HAIKU_BUILD_PROFILE) {
}
}</pre>
<p>The first line is especially important and <b>dangerous</b>: "<tt>/dev/sda7</tt>"<br />
<p>The first line is especially important and <b>dangerous</b>: "<span class="path">/dev/sda7</span>"<br />
<span style="font-size: 1.2em; font-weight: bold;">The so defined partition will be irretrievably overwritten!
</span></p>
<p>Before you use this profile, you should make sure that it's really the correct partition on the right harddisk or USB-stick, for example by using Ubuntu's partition editor <i>GParted</i>.</p></li>
<p>Before you use this profile, you should make sure that it's really the correct partition on the right harddisk or USB-stick, for example by using Ubuntu's partition editor <span class="app">GParted</span>.</p></li>
</ol>
<p><br /></p>
<p>Here's the complete <tt>UserBuildConfig</tt> once more:</p>
<p>Here's the complete <span class="cli">UserBuildConfig</span> once more:</p>
<pre># Quick start file for UserBuildConfig. Copy it and uncomment and edit the
# lines you want. See UserBuildConfig.ReadMe for details.
@ -182,14 +182,14 @@ switch $(HAIKU_BUILD_PROFILE) {
}</pre>
<p><b>Note:</b> <i>when building an a USB memory stick, you wouldn't specify the partition number in the disk entry (ex. </i><tt>/dev/sdb</tt><i> instead of </i><tt>/dev/sdb1</tt><i>). This will erase your whole flash drive and it's partitions, so be cautious to use the correct drive name!</i></p>
<p><b>Note:</b> <i>when building an a USB memory stick, you wouldn't specify the partition number in the disk entry (ex. </i><span class="path">/dev/sdb</span><i> instead of </i><span class="path">/dev/sdb1</span><i>). This will erase your whole flash drive and it's partitions, so be cautious to use the correct drive name!</i></p>
<p>Besides these user build profiles, there are also official release profiles, see <tt>ReleaseBuildProfiles</tt> in the same folder. The profiles <i>alpha-raw</i> and <i>alpha-vmware</i> will build all officially planned components for the alpha release. They are invoked just like the user profiles, see <a href="#build_vmimage">Building a VMWare Image</a> a bit further down.
<p>Besides these user build profiles, there are also official release profiles, see <span class="cli">ReleaseBuildProfiles</span> in the same folder. The profiles <i>alpha-raw</i> and <i>alpha-vmware</i> will build all officially planned components for the alpha release. They are invoked just like the user profiles, see <a href="#build_vmimage">Building a VMWare Image</a> a bit further down.
</p>
<h1>Building/installing Haiku Images</h1>
<p>Thanks to our <tt>UserBuildConfig</tt> it's all quite simple now.</p>
<p>Thanks to our <span class="cli">UserBuildConfig</span> it's all quite simple now.</p>
<h4>Installing on a partition/USB-stick</h4>
@ -218,7 +218,7 @@ sudo chmod o+rw /dev/sda7
<p>You can also decide to only update certain components:</p>
<pre class="terminal">jam -q @disk update {components}</pre>
<p>Just replace the <tt>{components}</tt> with the program/component to be updated, e.g. <tt>kernel</tt>, <tt>StyledEdit</tt> or <tt>libmedia.so</tt> or more than one, separated with blanks. <tt>haiku/build/jam/HaikuImage</tt> lists all possible "targets".</p>
<p>Just replace the <tt>{components}</tt> with the program/component to be updated, e.g. <tt>kernel</tt>, <tt>StyledEdit</tt> or <tt>libmedia.so</tt> or more than one, separated with blanks. <span class="path">haiku/build/jam/HaikuImage</span> lists all possible "targets".</p>
<h4><a id="build_vmimage" name="build_vmimage">Building a VMWare Image</a></h4>
@ -226,7 +226,7 @@ sudo chmod o+rw /dev/sda7
<p>Just enter:</p>
<pre class="terminal">jam -q @vmware</pre>
<p>The resulting image can be run in VMPlayer with an associated <a href="http://haiku-files.org/files/haiku.vmx">.vmx</a> file (There's also a <tt>.vmx</tt> file in <tt>haiku/3rdparty/vmware/</tt>).</p>
<p>The resulting image can be run in VMPlayer with an associated <a href="http://haiku-files.org/files/haiku.vmx">.vmx</a> file (There's also a <span class="cli">.vmx</span> file in <span class="path">haiku/3rdparty/vmware/</span>).</p>
<h1>Booting with GRUB</h1>
@ -249,9 +249,9 @@ The first logical partition always have the number 4, regardless of the number o
<p>As an example:</p>
<p style="margin: 15pt"><tt>/dev/sda7</tt> would be <tt>(hd0,6)</tt> in GRUB.</p>
<p style="margin: 15pt"><span class="path">/dev/sda7</span> would be <tt>(hd0,6)</tt> in GRUB.</p>
<p>Now using your own hard drive number, type this entry in <tt>/boot/grub/menu.lst</tt>:</p>
<p>Now using your own hard drive number, type this entry in <span class="path">/boot/grub/menu.lst</span>:</p>
<pre># Haiku on /dev/sda7
title Haiku
@ -263,12 +263,12 @@ chainloader +1</pre>
<h1>Accessing images/partitions</h1>
<p>Using build profiles has another advantage: You can mount a VMWare image or the partition of a Haiku installation to transfer data. Navigate to <tt>haiku/trunk/</tt> and simply enter:</p>
<p>Using build profiles has another advantage: You can mount a VMWare image or the partition of a Haiku installation to transfer data. Navigate to <span class="path">haiku/trunk/</span> and simply enter:</p>
<pre class="terminal">jam @disk mount</pre>
<p>or</p>
<pre class="terminal">jam @vmware mount</pre>
<p>You are now in the <tt>bfs_shell</tt>. Enter <tt>help</tt> to get a list of all supported commands:</p>
<p>You are now in the <span class="cli">bfs_shell</span>. Enter <span class="cli">help</span> to get a list of all supported commands:</p>
<pre class="terminal">fssh:/&gt; help supported commands:
cd - change current directory
chmod - change file permissions
@ -287,7 +287,7 @@ sync - syncs the file system</pre>
<p>It all works pretty much like in your normal bash shell (besides there's sadly no tab-completion).<br />
The one thing to remember: You have to prefix every local path (your Linux partition) with a "<tt>:</tt>".</p>
<p>Here's an example to copy the file <tt>.bash_history</tt> from Haiku to your Linux partition:</p>
<p>Here's an example to copy the file <span class="cli">.bash_history</span> from Haiku to your Linux partition:</p>
<pre class="terminal">fssh:/&gt; cd myfs/home
fssh:/myfs/home&gt; cp .bash_history :/home/humdinger/</pre>
<p>The other way around works the same:</p>

26
docs/userguide/en/installation/install-source-mac.html
View File

@ -79,10 +79,10 @@ buildtools and source code on it.</p>
<p>Open a Terminal (in /Application/Utilities), and enter:</p>
<pre class="terminal">cd /Volumes/Haiku/</pre>
<p><tt>/Volumes/Haiku</tt> refers here (and in
<p><span class="path">/Volumes/Haiku</span> refers here (and in
all this tutorial) to the mounted disk image name. I named it "Haiku",
so if you chose another name, use it instead of "Haiku" after
<tt>/Volumes/</tt>.</p>
<span class="path">/Volumes/</span>.</p>
<p>Checkout the buildtools:</p>
<pre class="terminal">svn checkout svn://svn.berlios.de/haiku/buildtools/trunk buildtools</pre>
@ -94,7 +94,7 @@ so if you chose another name, use it instead of "Haiku" after
<p>You should now have two folders "haiku" and "buildtools" into the mounted disk image.</p>
<p>To update your code from now on, go to the <tt>haiku/trunk/</tt> folder and type:</p>
<p>To update your code from now on, go to the <span class="path">haiku/trunk/</span> folder and type:</p>
<pre class="terminal">svn update</pre>
<h2>Step 3: Install required software</h2>
@ -106,7 +106,7 @@ so if you chose another name, use it instead of "Haiku" after
<p>You will be prompted for the administrator password of the current account - Do not worry if nothing you type shows after the Password prompt, this is intended.</p>
<p>If you get an error "port: command not found", the MacPorts shell configuration is probably not taken into account. You probably have a <tt>~/.bash_profile</tt> or <tt>~/.bash_login</tt> file overwriting MacPorts config located in <tt>~/.profile</tt>. When a "login shell" starts up, it reads the file <tt>"/etc/profile"</tt> and then <tt>"~/.bash_profile"</tt> or <tt>"~/.bash_login"</tt> or <tt>"~/.profile"</tt> (whichever one exists - it only reads one of these, checking for them in the order mentioned). Check the file used by Bash (in the mentioned order) and add these lines to the used file:</p>
<p>If you get an error "port: command not found", the MacPorts shell configuration is probably not taken into account. You probably have a <span class="path">~/.bash_profile</span> or <span class="path">~/.bash_login</span> file overwriting MacPorts config located in <span class="path">~/.profile</span>. When a "login shell" starts up, it reads the file <span class="path">"/etc/profile"</span> and then <span class="path">"~/.bash_profile"</span> or <span class="path">"~/.bash_login"</span> or <span class="path">"~/.profile"</span> (whichever one exists - it only reads one of these, checking for them in the order mentioned). Check the file used by Bash (in the mentioned order) and add these lines to the used file:</p>
<pre class="terminal">nano ~/.bash_profile
<b>or</b>
@ -120,7 +120,7 @@ nano ~/.profile
export MANPATH=$MANPATH:/opt/local/share/man
export INFOPATH=$INFOPATH:/opt/local/share/info</pre>
<p>To save the file and quit the editor, type <tt>CTRL-X</tt>, <tt>Y</tt> and <tt>RETURN</tt>. If you are using another shell, take a look a the shell documentation to see which file is parsed at login, and add the required commands.</p>
<p>To save the file and quit the editor, type <span class="key">CTRL</span>&#160;<span class="key">X</span>, <span class="key">Y</span> and <span class="key">ENTER</span>. If you are using another shell, take a look a the shell documentation to see which file is parsed at login, and add the required commands.</p>
<p>You can now retry the command in a new Terminal:</p>
<pre class="terminal">sudo port install gnuregex gaw wget</pre>
@ -140,7 +140,7 @@ cd ..</pre>
<h2>Step 4: Let's Patch</h2>
<p>With your favorite text editor, open the file:<br /> <tt>[Mounted Disk Image]/buildtools/legacy/gcc/config.guess</tt></p>
<p>With your favorite text editor, open the file:<br /> <span class="path">[Mounted Disk Image]/buildtools/legacy/gcc/config.guess</span></p>
<p>Go to line 522, and add this:</p>
<pre>*:Darwin:*:*)
@ -159,7 +159,7 @@ exit 0 ;;</pre>
<p><b>Warning!</b> When you copy-paste preformatted text from a web page, some versions of Safari replace every space with a no-break space. You can use the search/replace function of your text editor to replaces these "spaces" with real ones. (or copy the text by hand... or use another browser).</p>
<p>Save the file, and open:<br />
<tt>[Mounted Disk Image]/buildtools/legacy/gcc/Makefile.in</tt></p>
<span class="path">[Mounted Disk Image]/buildtools/legacy/gcc/Makefile.in</span></p>
<p>Replace (line 144):</p>
@ -184,7 +184,7 @@ exit 0 ;;</pre>
<p>If you do not now which one you should use, choose gcc2 : Original BeOS R5 binaries (and many Haiku optional packages) will not run on a gcc4 build.</p>
<p><tt>./configure</tt> has some more options, use this command to list them:</p>
<p><span class="cli">./configure</span> has some more options, use this command to list them:</p>
<pre class="terminal">./configure --help</pre>
<p>After some time, you should get:</p>
@ -194,9 +194,9 @@ exit 0 ;;</pre>
<p>Now you could already start to build RAW or VMWare images. Before we come to that, however, let's have a look at the UserBuildConfig that can be used to customize and automate some things.</p>
<p>In <tt>trunk/haiku/build/jam/</tt> there's a <tt>UserBuildConfig.ReadMe</tt> that explains various options. <b>Don't</b> simply rename it and use it as UserBuildConfig!</p>
<p>In <span class="path">trunk/haiku/build/jam/</span> there's a <span class="cli">UserBuildConfig.ReadMe</span> that explains various options. <b>Don't</b> simply rename it and use it as UserBuildConfig!</p>
You start by duplicating the <tt>UserBuildConfig.sample</tt> and the remove the .sample suffix to get your <tt>UserBuildConfig</tt>. From the .ReadMe you can copy interesting parts into your config and customize them there.
You start by duplicating the <span class="cli">UserBuildConfig.sample</span> and the remove the .sample suffix to get your <span class="cli">UserBuildConfig</span>. From the .ReadMe you can copy interesting parts into your config and customize them there.
<h2>Step 7: Building Haiku</h2>
@ -208,13 +208,13 @@ You start by duplicating the <tt>UserBuildConfig.sample</tt> and the remove the
jam -q haiku-vmware-image</pre>
<p>will build a VMWare disk image:<br />
<tt>[Mounted Disk Image]/haiku/generated/haiku.vmdk</tt>.</p>
<span class="path">[Mounted Disk Image]/haiku/generated/haiku.vmdk</span>.</p>
<p>To use it, follow these steps:</p>
<ol>
<li>Create a folder at the root of the disk image.</li>
<li>Copy <tt>[Mounted Disk Image]/3rdparty/vmware/haiku.vmx</tt> inside this folder, and edit the copy.</li>
<li>Copy <span class="path">[Mounted Disk Image]/3rdparty/vmware/haiku.vmx</tt> inside this folder, and edit the copy.</li>
<li>Change <tt>ide0:0.fileName = "haiku.vmdk"</tt> to <tt>ide0:0.fileName = "../haiku/generated/haiku.vmdk"</tt>. Save the file.</li>
<li>Double-clicking on the file should start VMWare Fusion and launch Haiku.</li>
</ol>
@ -235,7 +235,7 @@ jam -q haiku-vmware-image</pre>
<pre class="terminal">cd /Volumes/Haiku/haiku
jam haiku-image</pre>
<p>The image will be created in <tt>[Mounted Disk Image]/haiku/generated/haiku.image</tt>.</p>
<p>The image will be created in <span class="path">[Mounted Disk Image]/haiku/generated/haiku.image</span>.</p>
</div>

22
docs/userguide/en/installation/install-usb.html
View File

@ -60,13 +60,13 @@ TODO
<p> You will need a small USB memory stick (512MB should be more than enough) that you are ready to erase and a recent <a href="http://haiku-files.org/raw/index.php">HDD raw image</a>. Note that these are test images, they are not complete distributions that include a lot of software. Future releases will include a more complete set of software, obviously. Your motherboard should also support booting from USB Drives (most recent computers do).</p>
<h2><a id="unix" name="unix">Using a Unix system (Linux, Mac OS X, FreeBSD etc.)</a></h2>
<p>Now that you've downloaded the raw image, you will need to expand this image on your USB Drive you intend to install it to. You will first need to know the name of your drive (something like <tt>/dev/sdb</tt>, <tt>/dev/disk1</tt> or a variant).</p>
<p>Now that you've downloaded the raw image, you will need to expand this image on your USB Drive you intend to install it to. You will first need to know the name of your drive (something like <span class="path">/dev/sdb</span>, <span class="path">/dev/disk1</span> or a variant).</p>
<p>First connect your flash drive.</p>
<p>Under Linux, open your shell and type:</p>
<pre class="terminal">fdisk -l</pre>
<p>On Mac OS X, open the terminal (<i>Utilities > Terminal</i>) and type:</p>
<p>On Mac OS X, open the terminal (<span class="menu">Utilities > Terminal</span>) and type:</p>
<pre class="terminal">df -hl</pre>
<p>The output should resemble something like,</p>
@ -92,33 +92,33 @@ or
/dev/disk0s2 186Gi 112Gi 74Gi 61% /
<b>/dev/disk1s1 1.9Gi 265Mi 1.6Gi 14% /Volumes/KINGSTON</b></pre>
<p>Now you need to use the <tt>dd</tt> tool to extract the raw image to your USB Key. Make sure you have the right drive selected here, since this will erase all data on the specified location. Recheck with a partition tool to verify for example. You might need administrative rights, so add the <tt>sudo</tt> or <tt>su</tt> command before the next step to run the process as administrator (a password will be required).</p>
<p>Now you need to use the <span class="cli">dd</span> tool to extract the raw image to your USB Key. Make sure you have the right drive selected here, since this will erase all data on the specified location. Recheck with a partition tool to verify for example. You might need administrative rights, so add the <span class="cli">sudo</span> or <span class="cli">su</span> command before the next step to run the process as administrator (a password will be required).</p>
<p><b>Note:</b> <i>You will want to put the image at the absolute start of the drive, make sure that you write to the whole raw drive and not to a partition. You do that by specifying a raw device instead of a partition. Under Linux you would for example omit the partition number resulting in</i> <tt>sdb</tt> <i>instead of</i> <tt>sdb1</tt><i>. Under BeOS you would pick the</i> <tt>.../raw</tt> <i>path instead of one with a number. If you use such a command, you overwrite the MBR containing the partition table of your USB memory stick. This means, that all the partitions on that drive will become inaccessible (not only the first part of the drive). So be sure that you want to do such a destructive operation!</i></p>
<p><b>Note:</b> <i>You will want to put the image at the absolute start of the drive, make sure that you write to the whole raw drive and not to a partition. You do that by specifying a raw device instead of a partition. Under Linux you would for example omit the partition number resulting in</i> <span class="cli">sdb</span> <i>instead of</i> <span class="cli">sdb1</span><i>. Under BeOS you would pick the</i> <span class="cli">.../raw</span> <i>path instead of one with a number. If you use such a command, you overwrite the MBR containing the partition table of your USB memory stick. This means, that all the partitions on that drive will become inaccessible (not only the first part of the drive). So be sure that you want to do such a destructive operation!</i></p>
<p>Still in the terminal, enter:</p>
<pre class="terminal">dd if=/path/to/image of=/dev/sdb</pre>
<p>Where <tt>/dev/sdb</tt> stands for your USB memory stick's name found earlier.</p>
<p>Where <span class="path">/dev/sdb</span> stands for your USB memory stick's name found earlier.</p>
<p>Congratualtions! You have just installed Haiku to a USB memory stick. You can now restart your computer to boot from Haiku. Note that you will probably have to enable USB drive booting in your BIOS and change the hard drive boot priority order. If Haiku's splash screen stops in the middle of the icons, and then sends you to <i>Kernel Debug Land</i>, you might have to disable the <i>Plug and Play OS</i> option in your BIOS.</p>
<h2><a id="windows" name="windows">Using Windows</a></h2>
<p>You will need basic knowledge of your command prompt to go through this step-by-step guide. You can type <tt>help</tt> inside your command prompt to get some information on the required navigation commands.</p>
<p>You will need basic knowledge of your command prompt to go through this step-by-step guide. You can type <span class="cli">help</span> inside your command prompt to get some information on the required navigation commands.</p>
<p>You have to download and install the latest <a href="http://shounen.ru/soft/flashnul">Flashnul</a> utility.</p>
<p><b>Note:</b><i>The <i>Flashnul</i> website isn't in English. You can simply click on the "Download" link and then select the upper-most entry (the latest version) to download.</i></p>
<p><b>Note:</b><i>The <span class="app">Flashnul</span> website isn't in English. You can simply click on the "Download" link and then select the upper-most entry (the latest version) to download.</i></p>
<p>Extract your raw image zip file and the <i>Flashnul</i> program in the same directory (ex. <tt>c:\haiku</tt>). Rename the raw image's extension to <tt>.img</tt> (ex. <tt>haiku.img</tt>).</p>
<p>Extract your raw image zip file and the <span class="app">Flashnul</span> program in the same directory (ex. <span class="path">c:\haiku</span>). Rename the raw image's extension to <span class="cli">.img</span> (ex. <span class="cli">haiku.img</span>).</p>
<p>Open your command prompt (go to <i>Start > Run</i>, then type <tt>cmd</tt> and press <tt>ENTER</tt>). You will see a black window with a blinking cursor, this is your command line editor (commonly named command prompt or shell).</p>
<p>Open your command prompt (go to <span class="menu">Start > Run</span>, then type <span class="cli">cmd</span> and press <span class="key">ENTER</span>). You will see a black window with a blinking cursor, this is your command line editor (commonly named command prompt or shell).</p>
<p><b>Note:</b><i>If you are using Windows Vista, you will need administrator rights to see the available physical drives. To run the command prompt in administrator mode, go to </i>Start > All Programs > Accessories > Command prompt<i>, right click on the program and select </i>Run as Administrator.</p>
<p>Navigate to the directory containing your raw image and the <i>Flashnul</i> utility. For example,</p>
<p>Navigate to the directory containing your raw image and the <span class="app">Flashnul</span> utility. For example,</p>
<pre class="terminal">cd \haiku</pre>
<p>if the directory is <tt>c:\haiku</tt></p>
<p>if the directory is <span class="path">c:\haiku</span></p>
<p>You need to find the number of your USB flash drive. This is very important, because if you do not select the right drive, your whole hard drive <b><i>will be erased</i></b>. To find out your flashdrive's name, in the command prompt, type:</p>
<pre class="terminal">flashnul -p</pre>

30
docs/userguide/en/installation/install-vm.html
View File

@ -96,17 +96,17 @@ TODO:
<h1>Using disk images</h1>
<h2>VMWare:</h2>
<p>To use Haiku under Vmware, simply unzip the archive and execute the included <tt>*.vmx</tt> file.</p>
<p>To use Haiku under Vmware, simply unzip the archive and execute the included <span class="cli">*.vmx</span> file.</p>
<h2>VirtualBox:</h2>
<p><b>Note:</b> <i>Use the latest version of VirtualBox for the best compatibility, but emulating Haiku in VirtualBox isn't totally supported. Some settings will require you have a specific processor to work. If it isn't the case, you will either have to wait for upgrades (from Haiku and/or VirtualBox) or get a free version of VMWare.</i></p>
<p>To use the VMWare disk image under Virtual Box, create a virtual machine (click <i>New</i>) and press next. First name your image (ex. Haiku r28888). Under the <i>Operating System</i> tab, select "other", and for the <i>Version</i> tab, select "other" again. Next, you will have to chose the amount of RAM you wish to allocate to Haiku (512 MB through 1 GB should be enough). Remember your host OS will be deprived from this amount of memory.<br />
Now in the <i>Virtual Hard Disk</i> section, enable <i>Boot Hard Disk (Primary Master)</i>, then click <i>Existing...</i>, click <i>Add</i>, navigate to your VMWare (.vmdk) image and click <i>Open</i>. Select it in the list, and click <i>Select</i>. Now your done creating your Virtual Machine, but you will have to tweak some settings.</p>
<p>To use the VMWare disk image under Virtual Box, create a virtual machine (click <span class="button">New</span>) and press next. First name your image (ex. Haiku r28888). Under the <span class="menu">Operating System</span> tab, select "other", and for the <span class="menu">Version</span> tab, select "other" again. Next, you will have to chose the amount of RAM you wish to allocate to Haiku (512 MB through 1 GB should be enough). Remember your host OS will be deprived from this amount of memory.<br />
Now in the <span class="menu">Virtual Hard Disk</span> section, enable <span class="menu">Boot Hard Disk (Primary Master)</span>, then click <span class="button">Existing...</span>, click <span class="button">Add</span>, navigate to your VMWare (.vmdk) image and click <span class="button">Open</span>. Select it in the list, and click <span class="button">Select</span>. Now your done creating your Virtual Machine, but you will have to tweak some settings.</p>
<p>With your new virtual machine selected, click on <i>Settings</i>. Here you can tweak your VM to your likings. Haiku will not boot if the "VT-x/AMD-V" option isn't on. Go to <i>General > Advanced > Enable VT-x/AMD-V</i> and activate the option. Your processor might not support this option, if so, your out of luck for VirtualBox emulation.</p>
<p>With your new virtual machine selected, click on <span class="menu">Settings</span>. Here you can tweak your VM to your likings. Haiku will not boot if the "VT-x/AMD-V" option isn't on. Go to <span class="menu">General > Advanced > Enable VT-x/AMD-V</span> and activate the option. Your processor might not support this option, if so, your out of luck for VirtualBox emulation.</p>
<p>In order to get networking running under Haiku in Virtual Box, under the <i>Network > Adapter 1</i> tab, change the adapter type to "Intel Pro/1000 MT (82540OEM)". You can use either "NAT" or "Host Interface" under the <i>attached to</i> option. If you choose "Host Interface", you'll then have to select your desired network card in the bottom window ("Host Interfaces")</p>
<p>In order to get networking running under Haiku in Virtual Box, under the <span class="menu">Network > Adapter 1</span> tab, change the adapter type to "Intel Pro/1000 MT (82540OEM)". You can use either "NAT" or "Host Interface" under the <i>attached to</i> option. If you choose "Host Interface", you'll then have to select your desired network card in the bottom window ("Host Interfaces")</p>
<p>Sound doesn't work when emulating Haiku in VirtualBox, so you might as well disable it. I haven't tested the USB ports, but it should work. For more information on the various options you have, refer to (the very complete) VirtualBox User Manual.</p>
@ -114,16 +114,16 @@ Now in the <i>Virtual Hard Disk</i> section, enable <i>Boot Hard Disk (Primary M
<p><b>Note:</b> <i>These instructions have been posted in the forums, they are not guaranteed to work, and some issues might arise (like networking). Visit the forums for more information.</i></p>
<ul>
<li><p>Download a nightly build from the Haiku Build Factory and extract the tar.bz2 file.</p></li>
<li><p>Move the extracted <tt>haiku.image</tt> file to the desired directory. Open terminal and navigate to that directory. Type:</p>
<li><p>Move the extracted <span class="cli">haiku.image</span> file to the desired directory. Open terminal and navigate to that directory. Type:</p>
<pre class="terminal">dd if=/dev/zero of=haiku.image bs=1024 count=1 conv=notrunc seek=408600</pre></li>
<li><p>Rename the <tt>haiku.image</tt> file to <tt>haiku.hdd</tt>.</p></li>
<li><p>Rename the <span class="cli">haiku.image</span> file to <span class="cli">haiku.hdd</span>.</p></li>
<li><p>Use ImageTool to resize the haiku.hdd file to 120MB.</p></li>
<li><p>Create a new virtual machine in Parallels, with <i>Guest OS Type</i> as Windows.</p></li>
<li><p>Set the <i>Hard Drive</i> to the <tt>haiku.hdd</tt> file that you downloaded.</p></li>
<li><p>Set the <i>Hard Drive</i> to the <span class="cli">haiku.hdd</span> file that you downloaded.</p></li>
</ul>
<h2>Qemu:</h2>
<p>For Qemu, rename the raw disk image to <tt>haiku.img</tt> and manually configure a virtual machine using that disk image.</p>
<p>For Qemu, rename the raw disk image to <span class="cli">haiku.img</span> and manually configure a virtual machine using that disk image.</p>
<h1>Increasing disk image space - Creating and formatting disks</h1>
<p>The disk images provided come as 250MB fixed disk images. The disk image's size can't be increased, but one can easily create a new disk with an increased capacity. Under the emulators GUI and virtual machine's settings, you should find an option to add another hard disk.<br />
@ -132,15 +132,15 @@ Choose which type of disk you would like to create. There are two options:</p>
<li><p>Fixed disk: This means the disk's space will be pre-allocated, i.e if you choose to create a 10GB fixed disk, the disk image will occupy 10GB of data on your hard drive.</p></li>
<li><p>Expanding disk: If you choose to create a 10GB disk image, the disk will appear as it's 10GB under Haiku, but will only actually be as big as the space that's used within Haiku (it grows).</p></li>
</ul>
<p>Once you've created the disk image to a size of your choice, add the secondary disk to your virtual machine and boot Haiku. The disk won't show up until you have formatted it. Navigate to Haiku's <i>DiskSetup</i> application - the disk should be shown (see a 1GB disk added in the screenshot below).</p>
<p>Once you've created the disk image to a size of your choice, add the secondary disk to your virtual machine and boot Haiku. The disk won't show up until you have formatted it. Navigate to Haiku's <span class="app">DiskSetup</span> application - the disk should be shown (see a 1GB disk added in the screenshot below).</p>
<br />
<a href="../../images/installation-images/haiku.jpg"><img style="border: 0px solid ; width: 200px; height: 175px;" alt="" src="../../images/installation-images/haiku.jpg" /></a><br />
<br />
<p>Select the disk, and then select <i>Partition | Initialize | Be File System</i>. Select the default variables, and accept the alert messages. Return to the menu and select <i>Partition Mount</i> - another Haiku disk should now be on your desktop (without the leaf logo). Now simply open a Tracker window on the boot disk, and a Tracker window on your newly created disk and copy the contents over (over-writing the <tt>home</tt> folder on the new disk).</p>
<p>Select the disk, and then select <span class="menu">Partition | Initialize | Be File System</span>. Select the default variables, and accept the alert messages. Return to the menu and select <i>Partition Mount</i> - another Haiku disk should now be on your desktop (without the leaf logo). Now simply open a Tracker window on the boot disk, and a Tracker window on your newly created disk and copy the contents over (over-writing the <span class="path">home</span> folder on the new disk).</p>
<p>One final step: Open a Terminal and type:</p>
<pre class ="terminal">df</pre>
<p>to see the disk space size &amp; usage on each disk. After selecting the correct disk (probably <tt>/Haiku1</tt>) type:</p>
<p>to see the disk space size &amp; usage on each disk. After selecting the correct disk (probably <span class="path">/Haiku1</span>) type:</p>
<pre class="terminal">makebootable Haiku1</pre>
<p>You can now shutdown the Haiku virtual machine, remove the primary disk image (the Haiku disk image you downloaded) in your virtual machine's preferences, and make sure that the new disk you created is your primary disk now.</p>
@ -149,11 +149,11 @@ Choose which type of disk you would like to create. There are two options:</p>
<h1>Transferring files between your host computer and a Haiku virtual machine</h1>
<p>There are several ways you can transfer files between the host and guest machines on your computer. Since there is no 'Vmware tools installer' for Haiku, file-sharing between the host and guest isn't built-in, and there's no clipboard sharing. Here are a couple of ways you could share files.</p>
<ul>
<li><p><b><i>Transfer files using a disk image</i></b>: create a disk image with the files you'd like to transfer from your PC to Haiku. In Windows use a utility like <i>Burn At Once</i>, in OS X you could use the the hard drisk utility to make an ISO i.e create a folder called 'test' on your desktop, put the files you want into that folder and execute the command:</p>
<li><p><b><i>Transfer files using a disk image</i></b>: create a disk image with the files you'd like to transfer from your PC to Haiku. In Windows use a utility like <span class="app">Burn At Once</span>, in OS X you could use the the hard drisk utility to make an ISO i.e create a folder called 'test' on your desktop, put the files you want into that folder and execute the command:</p>
<pre class="terminal">hdiutil makehybrid -o /Users/myusername/Desktop/test.iso /Users/myusername/Desktop/test -iso -joliet'</pre>
<p>(replacing "myusername" with your username). Attach the resultant ISO images in place of your optical disk in your virtual machine preferences.</p></li>
<li><p><b><i>Transfer files over the internet</i></b>: upload files to an online server you have, and then download them internally through Haiku. Note, Haiku doesn't yet have a web browser included, however, you can use <tt>wget</tt>.</p></li>
<li><p><b><i>Transfer files between the host and machine</i></b>: First you'll need to setup a FTP server on your host machine. OS X users can easily do this under their sharing preferences tab. As suggested, you can use <tt>wget</tt> to download files from your host machine. You could use <a href="http://www.haikuware.com/view-details/internet-&amp;-network/ftp/wput">wput</a> to upload files to your host machine, alternatively, you could use a grahphical client like <a href="http://www.haikuware.com/view-details/internet-&amp;-network/ftp/netpenguin">NetPenguin</a>.</p></li>
<li><p><b><i>Transfer files over the internet</i></b>: upload files to an online server you have, and then download them internally through Haiku. Note, Haiku doesn't yet have a web browser included, however, you can use <span class="cli">wget</span>.</p></li>
<li><p><b><i>Transfer files between the host and machine</i></b>: First you'll need to setup a FTP server on your host machine. OS X users can easily do this under their sharing preferences tab. As suggested, you can use <span class="cli">wget</span> to download files from your host machine. You could use <a href="http://www.haikuware.com/view-details/internet-&amp;-network/ftp/wput">wput</a> to upload files to your host machine, alternatively, you could use a grahphical client like <a href="http://www.haikuware.com/view-details/internet-&amp;-network/ftp/netpenguin">NetPenguin</a>.</p></li>
</ul>
</div>

44
docs/userguide/en/installing.html
View File

@ -58,7 +58,7 @@ For anonymous check-out:</p>
<pre class="terminal">svn checkout http://svn.berlios.de/svnroot/repos/haiku/haiku/trunk trunk</pre>
<p>If you have a valid Haiku developer account at Berlios:</p>
<pre class="terminal">svn checkout https://developername@svn.berlios.de/svnroot/repos/haiku/haiku/trunk trunk</pre>
<p>If there are any errors while checking out the source, just cd into the trunk directory and type <tt>svn update</tt> to get any missed files.<br />
<p>If there are any errors while checking out the source, just cd into the trunk directory and type <span class="cli">svn update</span> to get any missed files.<br />
This is also how you update the code in the future.</p></li>
<li><p>Build the cross compiler tools (GCC 2.95):</p>
<pre class="terminal">cd ~/develop/haiku/trunk
@ -69,13 +69,13 @@ This is also how you update the code in the future.</p></li>
</ol>
<p><br /></p>
<p>To download all code changes from now on, simply enter the <tt>haiku/trunk/</tt> folder and type:</p>
<p>To download all code changes from now on, simply enter the <span class="path">haiku/trunk/</span> folder and type:</p>
<pre class="terminal">svn update</pre>
<h1><a name="userbuildconfig">Customizing UserBuildConfig</a></h1>
<p>Now you could already start to build RAW or VMWare images. Before we come to that, however, let's have a look at the <tt>UserBuildConfig</tt> that can be used to customize and automate some things.</p>
<p>In <tt>trunk/haiku/build/jam/</tt> there's a <tt>UserBuildConfig.ReadMe</tt> that explains various options. <b>Don't</b> simply rename it and use it as <tt>UserBuildConfig</tt>!</p>
<p>You start by duplicating the <tt>UserBuildConfig.sample</tt> and the remove the<tt>.sample</tt> suffix to get your <tt>UserBuildConfig</tt>. From the <tt>.ReadMe</tt> you can copy interesting parts into your config and customize them there.</p>
<p>Now you could already start to build RAW or VMWare images. Before we come to that, however, let's have a look at the <span class="cli">UserBuildConfig</span> that can be used to customize and automate some things.</p>
<p>In <span class="path">trunk/haiku/build/jam/</span> there's a <span class="cli">UserBuildConfig.ReadMe</span> that explains various options. <b>Don't</b> simply rename it and use it as <span class="cli">UserBuildConfig</span>!</p>
<p>You start by duplicating the <span class="cli">UserBuildConfig.sample</span> and the remove the <span class="cli">.sample</span> suffix to get your <span class="cli">UserBuildConfig</span>. From the <span class="cli">.ReadMe</span> you can copy interesting parts into your config and customize them there.</p>
<ol>
<li><p>First, the line needed for the optional "OpenSSH" package:</p>
<pre>HAIKU_IMAGE_HOST_NAME = "TEST" ;</pre>
@ -86,14 +86,14 @@ AddSymlinkToHaikuImage home config settings
: /boot/beos/etc/timezones/Europe/Paris : timezone ;
AddFilesToHaikuImage home config settings : <keymap>German
: Key_map ;</keymap></pre></li>
<li><p>The build process can be fine tuned until it fits your needs. You could create your own folder <tt>haiku/trunk/user_data/</tt> and put files there that are then copied or unzipped into the image. Zipping is important when dealing with Haiku files with their attributes, because zipping them up will preserve them on non-BFS partitions.<br />
<li><p>The build process can be fine tuned until it fits your needs. You could create your own folder <span class="path">haiku/trunk/user_data/</span> and put files there that are then copied or unzipped into the image. Zipping is important when dealing with Haiku files with their attributes, because zipping them up will preserve them on non-BFS partitions.<br />
For example:</p>
<pre># Zip up your emails between each system update and place the archive into the
# user_data folder to be automatically put back when building the new image.
UnzipArchiveToHaikuImage home
: $(HAIKU_TOP)/user_data/mail.zip ;</pre>
<p>The first line defines the location in the image where the archive will be unzipped (here: <tt>/boot/home/</tt>). Deeper hierarchies are separated with a blank instead of the usual "<tt>/</tt>" (see the setting of the timezone above).<br />
The second line is the location of the zip file. <tt>$(HAIKU_TOP)</tt> is the lowest level of the checked out source tree, normally <tt>haiku/trunk/</tt>.</p>
<p>The first line defines the location in the image where the archive will be unzipped (here: <span class="path">/boot/home/</span>). Deeper hierarchies are separated with a blank instead of the usual "<span class="path">/</span>" (see the setting of the timezone above).<br />
The second line is the location of the zip file. <tt>$(HAIKU_TOP)</tt> is the lowest level of the checked out source tree, normally <span class="path">haiku/trunk/</span>.</p>
<p>In the same way, you use <tt>CopyDirectoryToHaikuImage</tt> and <tt>AddFilesToHaikuImage</tt> to copy whole directories or single files into the image.</p></li>
<li><p>The above commands are executed when building any kind of image. "Build Profiles" provide the means to set commands specifically for different configurations.<br />
These are two profiles, one for building and installing an image directly onto a partition and the other to generate a VMWare image:</p>
@ -113,13 +113,13 @@ switch $(HAIKU_BUILD_PROFILE) {
}
}</pre>
<p>The first line is especially important and <b>dangerous</b>: "<tt>/dev/sda7</tt>"<br />
<p>The first line is especially important and <b>dangerous</b>: "<span class="path">/dev/sda7</span>"<br />
<span style="font-size: 1.2em; font-weight: bold;">The so defined partition will be irretrievably overwritten!
</span></p>
<p>Before you use this profile, you should make sure that it's really the correct partition on the right harddisk or USB-stick, for example by using Ubuntu's partition editor <i>GParted</i>.</p></li>
<p>Before you use this profile, you should make sure that it's really the correct partition on the right harddisk or USB-stick, for example by using Ubuntu's partition editor <span class="app">GParted</span>.</p></li>
</ol>
<p><br /></p>
<p>Here's the complete <tt>UserBuildConfig</tt> once more:</p>
<p>Here's the complete <span class="cli">UserBuildConfig</span> once more:</p>
<pre># Quick start file for UserBuildConfig. Copy it and uncomment and edit the
# lines you want. See UserBuildConfig.ReadMe for details.
@ -148,10 +148,10 @@ switch $(HAIKU_BUILD_PROFILE) {
}
}</pre>
<p>Besides these user build profiles, there are also official release profiles, see <tt>ReleaseBuildProfiles</tt> in the same folder. The profiles <i>alpha-raw</i> and <i>alpha-vmware</i> will build all officially planned components for the alpha release. They are invoked just like the user profiles, s. <a href="#build_vmimage">Building a VMWare Image</a> a bit further down.
<p>Besides these user build profiles, there are also official release profiles, see <span class="cli">ReleaseBuildProfiles</span> in the same folder. The profiles <i>alpha-raw</i> and <i>alpha-vmware</i> will build all officially planned components for the alpha release. They are invoked just like the user profiles, s. <a href="#build_vmimage">Building a VMWare Image</a> a bit further down.
</p>
<h1>Building/installing Haiku Images</h1>
<p>Thanks to our <tt>UserBuildConfig</tt> it's all quite simple now.
<p>Thanks to our <span class="cli">UserBuildConfig</span> it's all quite simple now.
</p>
<h2><a name="install_partition">Installing on a partition/USB-stick</a></h2>
<p>To install Haiku directly onto a partition/USB-stick, you have to set the according read and write permissions. In our example it's done with:</p>
@ -168,12 +168,12 @@ Installing to its own partition offers some interesting possibilities:</p>
<p><br /></p>
<p>You can also decide to only update certain components:</p>
<pre class="terminal">sudo jam -q @disk update {components}</pre>
<p>Just replace the <tt>{components}</tt> with the program/component to be updated, e.g. <tt>kernel</tt>, <tt>StyledEdit</tt> or <tt>libmedia.so</tt> or more than one, separated with blanks. <tt>haiku/build/jam/HaikuImage</tt> lists all possible "targets".</p>
<p>Just replace the <tt>{components}</tt> with the program/component to be updated, e.g. <tt>kernel</tt>, <tt>StyledEdit</tt> or <tt>libmedia.so</tt> or more than one, separated with blanks. <span class="path">haiku/build/jam/HaikuImage</span> lists all possible "targets".</p>
<h2><a name="build_vmimage">Building a VMWare Image</a></h2>
<p>Just enter:</p>
<pre class="terminal">sudo jam -q @vmware</pre>
<p>You have to rededicate the generated image to satisfy the VMPlayer, before you can run it with an associated <a href="http://haiku-files.org/files/haiku.vmx">.vmx</a> file (There's also a <tt>.vmx</tt> file in <tt>haiku/3rdparty/vmware/</tt>):</p>
<p>You have to rededicate the generated image to satisfy the VMPlayer, before you can run it with an associated <a href="http://haiku-files.org/files/haiku.vmx">.vmx</a> file (There's also a <span class="cli">.vmx</span> file in <span class="path">haiku/3rdparty/vmware/</span>):</p>
<pre class="terminal">sudo chown [YourUsername] haiku.image</pre>
<h1><a name="grub">Booting with GRUB</a></h1>
@ -181,7 +181,7 @@ Installing to its own partition offers some interesting possibilities:</p>
<p><br /></p>
<p>If Haiku was installed on a partition on your harddrive, you have to adjust the boot loader accordingly. This is how it's done with GRUB:</p>
<p>
<p>Open the list of boot options, shown when pressing <tt>ESC</tt> at the beginning of the boot process:</p>
<p>Open the list of boot options, shown when pressing <span class="key">ESC</span> at the beginning of the boot process:</p>
<pre class="terminal">sudo gedit /boot/grub/menu.lst</pre>
<p>You'll note that GRUB uses a different naming strategy for harddrives than Linux.</p>
<p>With GRUB it's: <tt>(hdN,n)</tt></p>
@ -191,21 +191,21 @@ Installing to its own partition offers some interesting possibilities:</p>
The first logical partition always have the number 4, regardless of the number of primary partitions.</p>
<p>If you're still unsure, check out the <a href="http://www.gnu.org/software/grub/manual/grub.html#Naming-convention">GRUB manual</a>.</p>
<p>As an example:</p>
<p><tt>/dev/sda7</tt> would be <tt>(hd0,6)</tt> in GRUB.</p>
<p>The entry in <tt>/boot/grub/menu.lst</tt> would then be:</p>
<p><span class="path">/dev/sda7</span> would be <tt>(hd0,6)</tt> in GRUB.</p>
<p>The entry in <span class="path">/boot/grub/menu.lst</span> would then be:</p>
<pre># Haiku on /dev/sda7
title Haiku
rootnoverify (hd0,6)
chainloader +1</pre>
<p><br /></p>
<p>Save, reboot, press <tt>ESC</tt> when GRUB starts and choose "Haiku" in the menu.</p>
<p>Save, reboot, press <span class="key">ESC</span> when GRUB starts and choose "Haiku" in the menu.</p>
<h1><a name="bfs_shell">Accessing images/partitions</a></h1>
<p>Using build profiles has another advantage: You can mount a VMWare image or the partition of a Haiku installation to transfer data. Navigate to <tt>haiku/trunk/</tt> and simply enter:</p>
<p>Using build profiles has another advantage: You can mount a VMWare image or the partition of a Haiku installation to transfer data. Navigate to <span class="path">haiku/trunk/</span> and simply enter:</p>
<pre class="terminal">sudo jam @disk mount</pre>
<p>or</p>
<pre class="terminal">sudo jam @vmware mount</pre>
<p>Now you're in the <tt>bfs_shell</tt>. Enter <tt>help</tt> to get a list of all supported commands:</p>
<p>Now you're in the <span class="cli">bfs_shell</span>. Enter <span class="cli">help</span> to get a list of all supported commands:</p>
<pre class="terminal">fssh:/&gt; help
supported commands:
cd - change current directory
@ -224,7 +224,7 @@ rm - remove files and directories
sync - syncs the file system</pre>
<p>It all works pretty much like in your normal bash shell (besides there's sadly no tab-completion).<br />
The one thing to remember: You have to prefix every local path (your Linux partition) with a "<tt>:</tt>".</p>
<p>Here's an example to copy the file <tt>.bash_history</tt> from Haiku to your Linux partition:</p>
<p>Here's an example to copy the file <span class="cli">.bash_history</span> from Haiku to your Linux partition:</p>
<pre class="terminal">fssh:/&gt; cd myfs/home
fssh:/myfs/home&gt; cp .bash_history :/home/humdinger/</pre>
<p>The other way around works the same:</p>

72
docs/userguide/en/keyboard-shortcuts.html
View File

@ -36,72 +36,72 @@
<div class="content">
<p>By default, Haiku's option key, to invoke commands from menus for example, is not the usual <tt>CTRL</tt> key, but <tt>ALT</tt> instead. This has historical reasons, because the BeOS was inspired somewhat by MacOS. After you get used to it, it actually feels better as e.g. <tt>ALT+C</tt> and <tt>ALT+V</tt> is reached more conveniently on the keyboard and these commands seamlessly integrate into the <acronym title="Bourne Again Shell">bash</acronym> shell of the Terminal, where <tt>CTRL+C</tt> quits the running process.</p>
<p>In any case, you can switch to the maybe more familiar <tt>CTRL</tt> key in the <a href="prefs-menu.html">Menu</a> preferences. The user guide will always describes the default configuration with option key being <tt>ALT</tt>.</p>
<p>By default, Haiku's option key, to invoke commands from menus for example, is not the usual <span class="key">CTRL</span> key, but <span class="key">ALT</span> instead. This has historical reasons, because the BeOS was inspired somewhat by MacOS. After you get used to it, it actually feels better as e.g. <span class="key">ALT</span>&#160;<span class="key">C</span> and <span class="key">ALT</span>&#160;<span class="key">V</span> is reached more conveniently on the keyboard and these commands seamlessly integrate into the <acronym title="Bourne Again Shell">bash</acronym> shell of the Terminal, where <span class="key">CTRL</span>&#160;<span class="key">C</span> quits the running process.</p>
<p>In any case, you can switch to the maybe more familiar <span class="key">CTRL</span> key in the <a href="prefs-menu.html">Menu</a> preferences. The user guide will always describes the default configuration with option key being <span class="key">ALT</span>.</p>
<h2><a id="general" name="general">General shortcuts</a></h2>
<p>Here's a table of many of the most commonly used shortcuts that are always available, even if there isn't a corresponding menu:</p>
<table summary="shortcuts" border="0" cellspacing="0" cellpadding="4">
<tr><td><tt>ALT+Fx</tt></td><td style="width:15px;"></td><td>Switches to <a href="workspaces.html">Workspace</a> X (<tt>Fx</tt> is the function key corresponding to that workspace).</td></tr>
<tr><td><tt>CTRL+TAB</tt></td><td></td><td>Hold down to bring up the <a href="twitcher.hml">Twitcher</a>.</td></tr>
<tr><td><tt>CTRL+ALT+DEL</tt></td><td></td><td>Opens the <a href="teammonitor.html">Team Monitor</a>.</td></tr>
<tr><td><tt>ALT+ESC</tt></td><td></td><td>Enters the menu bar (leave with <tt>ESC</tt>).</td></tr>
<tr><td><tt>ALT+C</tt></td><td></td><td>Copies selection to clipboard.</td></tr>
<tr><td><tt>ALT+X</tt></td><td></td><td>Cuts selection to clipboard.</td></tr>
<tr><td><tt>ALT+V</tt></td><td></td><td>Pastes the clipboard's contents.</td></tr>
<tr><td><tt>ALT+W</tt></td><td></td><td>Closes the current window.</td></tr>
<tr><td><tt>ALT+Q</tt></td><td></td><td>Closes the whole application.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">Fx</span></td><td style="width:15px;"></td><td>Switches to <a href="workspaces.html">Workspace</a> X (<span class="key">Fx</span> is the function key corresponding to that workspace).</td></tr>
<tr><td><span class="key">CTRL</span>&#160;<span class="key">TAB</span></td><td></td><td>Hold down to bring up the <a href="twitcher.hml">Twitcher</a>.</td></tr>
<tr><td><span class="key">CTRL</span>&#160;<span class="key">ALT</span>&#160;<span class="key">DEL</span></td><td></td><td>Opens the <a href="teammonitor.html">Team Monitor</a>.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">ESC</span></td><td></td><td>Enters the menu bar (leave with <span class="key">ESC</span>).</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">C</span></td><td></td><td>Copies selection to clipboard.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">X</span></td><td></td><td>Cuts selection to clipboard.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">V</span></td><td></td><td>Pastes the clipboard's contents.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">W</span></td><td></td><td>Closes the current window.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">Q</span></td><td></td><td>Closes the whole application.</td></tr>
</table>
<h2><a id="tracker-navigation" name="tracker-navigation">Shortcuts for Tracker navigation</a></h2>
<p>Additionally to the general shortcuts, here are more for navigating with Tracker:</p>
<table summary="shortcuts" border="0" cellspacing="0" cellpadding="4">
<tr><td><tt>ALT+CURSOR UP</tt></td><td style="width:15px;"></td><td>Opens the parent folder.</td></tr>
<tr><td class="onelinetop"><tt>ALT+CURSOR DOWN or RETURN</tt></td><td></td><td>Opens the selected folder.</td></tr>
<tr><td><tt>WIN-KEY</tt></td><td></td><td>Holding it while opening a folder will automatically close the parent folder. This also works when navigating with the mouse.</td></tr>
<tr><td><tt>right MENU-KEY</tt></td><td></td><td>Opens the Deskbar menu (leave with <tt>ESC</tt>)</td></tr>
<tr><td><tt>ALT+Z</tt></td><td></td><td>Undo last action. The undo history is only limited by the available memory. Note, that this only works for actions on the file itself, changed attributes and permission settings can't be undone. Also, once a file is removed from <i>Trash</i> it's gone for good.</td></tr>
<tr><td><tt>ALT+SHIFT+Z</tt></td><td></td><td>Redo the action you just reverted with <tt>ALT+Z</tt></td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">CURSOR UP</span></td><td style="width:15px;"></td><td>Opens the parent folder.</td></tr>
<tr><td class="onelinetop"><span class="key">ALT</span>&#160;<span class="key">CURSOR DOWN</span> or <span class="key">ENTER</span></td><td></td><td>Opens the selected folder.</td></tr>
<tr><td><span class="key">WIN-KEY</span></td><td></td><td>Holding it while opening a folder will automatically close the parent folder. This also works when navigating with the mouse.</td></tr>
<tr><td><span class="key">right MENU-KEY</span></td><td></td><td>Opens the Deskbar menu (leave with <span class="key">ESC</span>)</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">Z</span></td><td></td><td>Undo last action. The undo history is only limited by the available memory. Note, that this only works for actions on the file itself, changed attributes and permission settings can't be undone. Also, once a file is removed from <i>Trash</i> it's gone for good.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">SHIFT</span>&#160;<span class="key">Z</span></td><td></td><td>Redo the action you just reverted with <span class="key">ALT</span>&#160;<span class="key">Z</span></td></tr>
</table>
<h2><a id="terminal" name="terminal">Shortcuts in Terminal</a></h2>
<table summary="shortcuts" border="0" cellspacing="0" cellpadding="4">
<tr><td><tt>ALT+N</tt></td><td style="width:15px;"></td><td>Opens another Terminal session in a new
<tr><td><span class="key">ALT</span>&#160;<span class="key">N</span></td><td style="width:15px;"></td><td>Opens another Terminal session in a new
window.</td></tr>
<tr><td><tt>ALT+T</tt></td><td></td><td>Opens another Terminal session in a new
<tr><td><span class="key">ALT</span>&#160;<span class="key">T</span></td><td></td><td>Opens another Terminal session in a new
tab.</td></tr>
<tr><td><tt>ALT+1,2,3...</tt></td><td></td><td>Switches to the corresponding tab.</td></tr>
<tr><td><tt>ALT+G</tt></td><td></td><td>Switch to the next Terminal window.</td></tr>
<tr><td><tt>ALT +,-</tt></td><td></td><td>Increase/Decrease font size.</td></tr>
<tr><td><tt>ALT+RETURN</tt></td><td></td><td>Enter/leave fullscreen mode.</td></tr>
<tr><td class="onelinetop"><tt>SHIFT+CURSOR UP/DOWN</tt></td><td></td><td>Scrolls the Terminal
<tr><td><span class="key">ALT</span>&#160;<span class="key">1</span>, <span class="key">2</span>, <span class="key">3</span>...</td><td></td><td>Switches to the corresponding tab.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">G</span></td><td></td><td>Switch to the next Terminal window.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">+</span>, <span class="key">-</span></td><td></td><td>Increase/Decrease font size.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">ENTER</span></td><td></td><td>Enter/leave fullscreen mode.</td></tr>
<tr><td class="onelinetop"><span class="key">SHIFT</span>&#160;<span class="key">CURSOR UP/DOWN</span></td><td></td><td>Scrolls the Terminal
output up/down one line.</td></tr>
<tr><td><tt> SHIFT+PAGE UP/DOWN </tt></td><td></td><td> Scrolls the Terminal
<tr><td><span class="key"> SHIFT</span>&#160;<span class="key">PAGE UP/DOWN </span></td><td></td><td> Scrolls the Terminal
output up/down one page.</td></tr>
<tr><td><tt>TAB</tt></td><td></td><td>Tab-completion. After entering a few
letters, press <tt>TAB</tt> once to auto-complete a filename or path. If
<tr><td><span class="key">TAB</span></td><td></td><td>Tab-completion. After entering a few
letters, press <span class="key">TAB</span> once to auto-complete a filename or path. If
there are more than one match, it stops where the name starts to differ
and you have to provide some more letters to further distinguish them.
You can also press <tt>TAB</tt> twice to have all matches
You can also press <span class="key">TAB</span> twice to have all matches
listed.</td></tr>
<tr><td><tt>CURSOR UP/DOWN</tt></td><td></td><td>Moves up or down in a list of
<tr><td><span class="key">CURSOR UP/DOWN</span></td><td></td><td>Moves up or down in a list of
all previously entered commands.</td></tr>
<tr><td><tt>CTRL+R</tt></td><td></td><td>Bash history. All the commands you enter
are stored in the file <tt>~/.bash_history</tt>. Press <tt>CTRL+R</tt>
<tr><td><span class="key">CTRL</span>&#160;<span class="key">R</span></td><td></td><td>Bash history. All the commands you enter
are stored in the file <span class="path">~/.bash_history</span>. Press <span class="key">CTRL</span>&#160;<span class="key">R</span>
and start to enter a command and you'll be provided with the first match
from the bash history. Keep pressing <tt>CTRL+R</tt> until you find the
from the bash history. Keep pressing <span class="key">CTRL</span>&#160;<span class="key">R</span> until you find the
right command line and press enter to execute it.</td></tr>
<tr><td><tt>CTRL+C</tt></td><td></td><td>Stops the currently running
<tr><td><span class="key">CTRL</span>&#160;<span class="key">C</span></td><td></td><td>Stops the currently running
command.</td></tr>
<tr><td><tt>CTRL+D</tt></td><td></td><td>Closes the current Terminal
<tr><td><span class="key">CTRL</span>&#160;<span class="key">D</span></td><td></td><td>Closes the current Terminal
session.</td></tr>
</table>
<h2><a id="other-combos" name="other-combos">Other key combinations</a></h2>
<p>You can add or remove items to/from a selection by holding down a modifier key while clicking on a entry (or file in case of Tracker).</p>
<table summary="shortcuts" border="0" cellspacing="0" cellpadding="4">
<tr><td><tt>SHIFT</tt></td><td style="width:15px;"></td><td>This will select everything between the first selected item and the one you click on.</td></tr>
<tr><td><tt>ALT</tt></td><td></td><td>Adds or removes the item you're clicking on from the selection.</td></tr>
<tr><td><span class="key">SHIFT</span></td><td style="width:15px;"></td><td>This will select everything between the first selected item and the one you click on.</td></tr>
<tr><td><span class="key">ALT</span></td><td></td><td>Adds or removes the item you're clicking on from the selection.</td></tr>
</table>
<p>In a Tracker window, if you just start typing, Tracker scrolls to and selects the file that best fits your incremental search. If there's no file starting with your typed letters, files that contain the search string anywhere in their name or other displayed attributes are selected. This search is <i>not</i> case-sensitive.<br />
The letters you type appear at the bottom-left, where normally the number of items are listed. After a second it reverts back and you could start a new incremental search.</p>

4
docs/userguide/en/preferences.html
View File

@ -37,7 +37,7 @@
<div class="content">
<p>While a key philosophy of Haiku is to cut down on options and have sensible defaults instead, there are some things that have to be configured or can be set to individual preference. You find all panels in Deskbar's <i>Preferences</i> menu.</p>
<p>While a key philosophy of Haiku is to cut down on options and have sensible defaults instead, there are some things that have to be configured or can be set to individual preference. You find all panels in Deskbar's <span class="menu">Preferences</span> menu.</p>
<table summary="contents" border="0" cellpadding="2" cellspacing="0">
<tr><td style="width:24px;"><img src="../images/prefs-images/appearance-icon_16.png" alt="icon" width="16" height="16" /></td><td><a href="preferences/prefs-appearance.html">Appearance</a></td><td style="width:10px;">&#160;</td>
<td valign="top">Configure certain aspects of the graphical interface.</td></tr>
@ -58,7 +58,7 @@
<tr><td style="width:24px;"><img src="../images/prefs-images/media-icon_16.png" alt="icon" width="16" height="16" /></td><td><a href="preferences/prefs-media.html">Media</a></td><td>&#160;</td>
<td valign="top">Audio and video settings like volume and in/output devices.</td></tr>
<tr><td style="width:24px;"><img src="../images/prefs-images/menu-icon_16.png" alt="icon" width="16" height="16" /></td><td><a href="preferences/prefs-menu.html">Menu</a></td><td>&#160;</td>
<td valign="top">Configure the behaviour of menus and the command key (<tt>CTRL/ALT</tt>.</td></tr>
<td valign="top">Configure the behaviour of menus and the command key (<span class="key">CTRL</span>/<span class="key">/ALT</span>.</td></tr>
<tr><td style="width:24px;"><img src="../images/prefs-images/mouse-icon_16.png" alt="icon" width="16" height="16" /></td><td><a href="preferences/prefs-mouse.html">Mouse</a></td><td>&#160;</td>
<td valign="top">Configure your mouse.</td></tr>
<tr><td style="width:24px;"><img src="../images/prefs-images/network-icon_16.png" alt="icon" width="16" height="16" /></td><td><a href="preferences/prefs-network.html">Network</a></td><td>&#160;</td>

24
docs/userguide/en/preferences/prefs-appearance.html
View File

@ -36,38 +36,38 @@
<h1><img src="../../images/prefs-images/appearance-icon_64.png" alt="appearance-icon_64.png" width="64" height="64" />Appearance</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Appearance</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/system/app_server/appearance</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Appearance</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/system/app_server/appearance</span></td></tr>
</table>
<p>The Appearance preferences lets you change some aspects of Haiku's visuals.</p>
<h2><a id="colors" name="colors">Colors</a></h2>
<img src="../../images/prefs-images/appearance-colors.png" alt="appearance-colors.png" width="460" height="337" />
<p>In the first tab, <i>Colors</i>, you can change the colors of different parts of the user interface. The color well accepts drag&amp;drops from other programs, letting you drag colors over from e.g. <i>WonderBrush</i>, <i>Icon-O-Matic</i> or the <i>Backgrounds</i> panel.</p>
<p>In the first tab, <span class="menu">Colors</span>, you can change the colors of different parts of the user interface. The color well accepts drag&amp;drops from other programs, letting you drag colors over from e.g. <span class="app">WonderBrush</span>, <span class="app">Icon-O-Matic</span> or the <span class="app">Backgrounds</span> panel.</p>
<h2><a id="antialiasing" name="antialiasing">Antialiasing</a></h2>
<img src="../../images/prefs-images/appearance-antialiasing.png" alt="appearance-antialiasing.png" width="460" height="337" />
<p>The second tab, <i>Antialiasing</i>, provides different settings for how things are rendered on screen.</p>
<p>The second tab, <span class="menu">Antialiasing</span>, provides different settings for how things are rendered on screen.</p>
<h3>Glyph hinting</h3>
<p>An activated <i>Glyph hinting</i> aligns all letters in such a way that their vertical and horizontal edges rest exactly between two pixels. The result is a perfect contrast, especially when dealing with black on white. Text appears crisper. There's also a setting for "<i>Monospaced Fonts Only</i>" that's especially helpful with low resolution devices like netbooks. Small fonts can look pretty bad when hinting is turned on, but with this setting you still have the advantage of hinting for text editors and Terminal.</p>
<p>An activated <span class="menu">Glyph hinting</span> aligns all letters in such a way that their vertical and horizontal edges rest exactly between two pixels. The result is a perfect contrast, especially when dealing with black on white. Text appears crisper. There's also a setting for "<span class="menu">Monospaced Fonts Only</span>" that's especially helpful with low resolution devices like netbooks. Small fonts can look pretty bad when hinting is turned on, but with this setting you still have the advantage of hinting for text editors and Terminal.</p>
<p>See the difference hinting makes with these magnified screenshots:</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td style="text-align:center; font-style:italic"><img src="../../images/prefs-images/appearance-glyph-off.png" alt="appearance-glyph-off.png" width="296" height="207" /><br />Hinting: off</td><td style="width:15px;"></td><td style="text-align:center; font-style:italic"><img src="../../images/prefs-images/appearance-glyph-on.png" alt="appearance-glyph-on.png" width="296" height="207" /><br />Hinting: on</td></tr>
</table>
<p>It should be pointed out that all the <i>Magnify</i> windows on this page are of course renderend themselves with the different options as well. So, you get a realworld impression of the settings by comparing, for example, the bold yellow tab title or the text "33 x 15 @ 8 pixels/pixel".</p>
<p>It should be pointed out that all the <span class="app">Magnify</span> windows on this page are of course renderend themselves with the different options as well. So, you get a realworld impression of the settings by comparing, for example, the bold yellow tab title or the text "33 x 15 @ 8 pixels/pixel".</p>
<h3>Antialiasing type</h3>
<p>Another technique to improve rendering is <i>Antialiasing</i>, which supports all vector graphics as well as text. It smoothes lines by changing the color of certain pixels. There are two methods for that:</p>
<p><i>Greyscale</i> changes the intensity of pixels at the edge.<br />
<i>LCD subpixel</i> does an even better job, especially with (high resolution) LCD monitors. Instead of the intensity of a pixel, it changes its color which moves an edge by a fraction of a pixel, because LCD displays produce every pixel with a red, green and blue component.</p>
<p><span class="menu">Greyscale</span> changes the intensity of pixels at the edge.<br />
<span class="menu">LCD subpixel</span> does an even better job, especially with (high resolution) LCD monitors. Instead of the intensity of a pixel, it changes its color which moves an edge by a fraction of a pixel, because LCD displays produce every pixel with a red, green and blue component.</p>
<p>Again, the two different methods with magnified screenshots:</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td style="text-align:center; font-style:italic"><img src="../../images/prefs-images/appearance-glyph-off.png" alt="appearance-glyph-off.png" width="296" height="207" /><br />Greyscale, Hinting: off</td><td style="width:15px;"></td><td style="text-align:center; font-style:italic"><img src="../../images/prefs-images/appearance-subpixel.png" alt="appearance-subpixel.png" width="296" height="207" /><br />LCD subpixel, Hinting: off</td></tr>
</table>
<p>Subpixel based antialiasing adds a slight colored shine to objects. Something not everyone tolerates. In Haiku you can mix the two antialiasing methods and find the right setting for you by using a slider.</p>
<p><b>Note: </b>The subpixel based antialiasing in combination with the glyph hinting is subject of a software patent and is therefore not available by default. Depending on where in the world you live, you may get an unlocked version. Sorry about that. Talk with your representative.</p>
<div class="box-info">The subpixel based antialiasing in combination with the glyph hinting is subject of a software patent and is therefore not available by default. Depending on where in the world you live, you may get an unlocked version. Sorry about that. Talk with your representative.</div>
<p>If you do activate hinting plus LCD subpixel rendering by changing the source and recompiling, this is how it looks compared to hinting with Greyscale:</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td style="text-align:center; font-style:italic"><img src="../../images/prefs-images/appearance-glyph-on.png" alt="appearance-glyph-on.png" width="296" height="207" /><br />Greyscale, Hinting: on</td><td style="width:15px;"></td><td style="text-align:center; font-style:italic"><img src="../../images/prefs-images/appearance-glyph-on-subpixel.png" alt="appearance-glyph-on-subpixel.png" width="296" height="207" /><br />LCD subpixel, Hinting: on</td></tr>
@ -75,8 +75,8 @@
<p><br /></p>
<p>At the bottom of the panel are two buttons:</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Defaults</i></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><i>Revert</i></td><td>&#160;</td><td>brings back the settings that were active when you started the Appearance preferences.</td></tr>
<tr><td><span class="button">Defaults</span></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><span class="button">Revert</span></td><td>&#160;</td><td>brings back the settings that were active when you started the Appearance preferences.</td></tr>
</table>
</div>

24
docs/userguide/en/preferences/prefs-backgrounds.html
View File

@ -39,29 +39,29 @@
<h1><img src="../../images/prefs-images/backgrounds-icon_64.png" alt="backgrounds-icon_64.png"
width="64" height="64" />Backgrounds</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Backgrounds</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/system/app_server/workspaces</tt><br />
<tt>~/config/settings/Backgrounds settings</tt> - Stores the panel's window position.</td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Backgrounds</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/system/app_server/workspaces</span><br />
<span class="path">~/config/settings/Backgrounds settings</span> - Stores the panel's window position.</td></tr>
</table>
<p>You can set a color or an image as background for every folder and the Desktop for every workspace.</p>
<p><br /></p>
<img src="../../images/prefs-images/backgrounds.png" alt="backgrounds.png" width="539" height="282" />
<p>The top drop-down menu specifies if your changes are applied to the current workspace, all workspaces, a specific folder or as default for every new folder.</p>
<p>Below that you can assign an image or select <i>None</i> if you want simply a colored background.</p>
<p>Below that you can assign an image or select <span class="menu">None</span> if you want simply a colored background.</p>
<p>If you are using an image, you have to decide on the placement:</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td><i>Manual</i></td><td>&#160;</td><td>lets you specify the coordinates. You can drag the picture around in the preview to the left or enter <i>X</i> and <i>Y</i> manually.</td></tr>
<tr><td><i>Center</i></td><td>&#160;</td><td>centers the picture in the middle of the screen.</td></tr>
<tr><td class="onelinetop"><i>Scale to fit</i></td><td>&#160;</td><td>enlarges the picture with no regard to its aspect ratio until it fills the screen.</td></tr>
<tr><td><i>Tile</i></td><td>&#160;</td><td>fills the screen by repeating the picture.</td></tr>
<tr><td><span class="menu">Manual</span></td><td>&#160;</td><td>lets you specify the coordinates. You can drag the picture around in the preview to the left or enter <i>X</i> and <i>Y</i> manually.</td></tr>
<tr><td><span class="menu">Center</span></td><td>&#160;</td><td>centers the picture in the middle of the screen.</td></tr>
<tr><td class="onelinetop"><span class="menu">Scale to fit</span></td><td>&#160;</td><td>enlarges the picture with no regard to its aspect ratio until it fills the screen.</td></tr>
<tr><td><span class="menu">Tile</span></td><td>&#160;</td><td>fills the screen by repeating the picture.</td></tr>
</table>
<p>If you are using an image you can activate <i>Icon label outline</i> which will put an thin contour around an icon's label.</p>
<p>If you are using an image you can activate <span class="menu">Icon label outline</span> which will put an thin contour around an icon's label.</p>
<p>If an icon label's actual text is black or white depends on setting of the color picker. A dark color sets the text to white, a light color to black. So, if you assign a very bright image to the background, you should also set the color picker to a bright color in order to have icon labels readable in black. (Or use the outline option above.)<br />
The selected color is also reflected in the <a href="../workspaces.html#applet">Workspaces applet</a>, which ignores images as backgrounds.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Revert</i></td><td>&#160;</td><td>brings back the settings that were active when you started the Backgrounds preferences.</td></tr>
<tr><td><i>Apply</i></td><td>&#160;</td><td>sets your changes.</td></tr>
<tr><td><span class="button">Revert</span></td><td>&#160;</td><td>brings back the settings that were active when you started the Backgrounds preferences.</td></tr>
<tr><td><span class="button">Apply</span></td><td>&#160;</td><td>sets your changes.</td></tr>
</table>
</div>

44
docs/userguide/en/preferences/prefs-datatranslations.html
View File

@ -5,7 +5,7 @@
<head>
<!--
*
* Copyright 2008, Haiku. All rights reserved.
* Copyright 2008-2009, Haiku. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
@ -39,39 +39,39 @@
<h1><img src="../../images/prefs-images/datatranslations-icon_64.png" alt="datatranslations-icon_64.png"
width="64" height="64" />DataTranslations</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/DataTranslations</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/*</tt> - Every Translator creates it's own settings file here after you've changes its defaults.<br />
<tt>~/config/settings/system/DataTranslations settings</tt> - Stores the panel's window position.</td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/DataTranslations</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/*</span> - Every Translator creates it's own settings file here after you've changes its defaults.<br />
<span class="path">~/config/settings/system/DataTranslations settings</span> - Stores the panel's window position.</td></tr>
</table>
<p>Every application has the ability to open and save every file format for which there's a Translator installed. The settings for these Translators are configured in the DataTranslations preferences.</p>
<p><br /></p>
<img src="../../images/prefs-images/datatranslations.png" alt="datatranslations.png" width="580" height="370" />
<p>Depending on its capabilities, each Translator offers different settings. At least you'll get an <i>Info...</i> button that opens a window with the credits and the installation path.<br />
<p>Depending on its capabilities, each Translator offers different settings. At least you'll get an <span class="button">Info...</span> button that opens a window with the credits and the installation path.<br />
The following table gives an overview of the default Translators and their most useful options.</p>
<table summary="translators" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>BMP Images</i></td><td>24bit, uncompressed, no transparency</td></tr>
<tr><td><i>EXR Images</i></td><td><acronym title="Industrial Light &amp; Magic">ILM</acronym>'s high dynamic-range (HDR) format</td></tr>
<tr><td><i>GIF Images</i></td><td>8bit, lossless compression, transparency<br />
<tr><td><span class="menu">BMP Images</span></td><td>24bit, uncompressed, no transparency</td></tr>
<tr><td><span class="menu">EXR Images</span></td><td><acronym title="Industrial Light &amp; Magic">ILM</acronym>'s high dynamic-range (HDR) format</td></tr>
<tr><td><span class="menu">GIF Images</span></td><td>8bit, lossless compression, transparency<br />
You can reduce the filesize by limiting the number of used colors and the palette.<br />
You can write images with transparency, either by automatically using the alpha channel or by setting the RGB value that will be transparent by hand.</td></tr>
<tr><td><i>JPEG2000 Images</i></td><td>24bit, compressed, no transparency<br />
<tr><td><span class="menu">JPEG2000 Images</span></td><td>24bit, compressed, no transparency<br />
Here, you normally only care about the output quality.</td></tr>
<tr><td><i>JPEG Images</i></td><td>24bit, compressed, no transparency<br />
<tr><td><span class="menu">JPEG Images</span></td><td>24bit, compressed, no transparency<br />
Besides the output quality you can also set a smoothing that will lessen compression artefacts but can blur the picture a little.</td></tr>
<tr><td><i>PCX Images</i></td><td>24bit, uncompressed, no transparency, PC Paintbrush Exchange format</td></tr>
<tr><td><i>PNG Images</i></td><td>32bit, lossless compression, transparency</td></tr>
<tr><td><i>PPM Images</i></td><td>24bit, uncompressed, no transparency, Portable PixMap format</td></tr>
<tr><td><i>RAW Images</i></td><td>up to 48bit, uncompressed, no transparency</td></tr>
<tr><td><i>RTF Text Files</i></td><td>Formatted text<td></td></tr>
<tr><td><i>SGI Images</i></td><td>24bit, optional lossless compression, transparency</td></tr>
<tr><td><i>StyledEdit Files</i></td><td>Formatted text</td></tr>
<tr><td><i>TGA Images</i></td><td>32bit, optional lossless compression, transparency</td></tr>
<tr><td><i>TIFF Images</i></td><td>24bit, optional lossless compression, layers, transparency</td></tr>
<tr><td class="onelinetop"><i>WonderBrush Images</i></td><td>32bit, layers, transparency, vector/pixel data</td></tr>
<tr><td><span class="menu">PCX Images</span></td><td>24bit, uncompressed, no transparency, PC Paintbrush Exchange format</td></tr>
<tr><td><span class="menu">PNG Images</span></td><td>32bit, lossless compression, transparency</td></tr>
<tr><td><span class="menu">PPM Images</span></td><td>24bit, uncompressed, no transparency, Portable PixMap format</td></tr>
<tr><td><span class="menu">RAW Images</span></td><td>up to 48bit, uncompressed, no transparency</td></tr>
<tr><td><span class="menu">RTF Text Files</span></td><td>Formatted text<td></td></tr>
<tr><td><span class="menu">SGI Images</span></td><td>24bit, optional lossless compression, transparency</td></tr>
<tr><td><span class="menu">StyledEdit Files</span></td><td>Formatted text</td></tr>
<tr><td><span class="menu">TGA Images</span></td><td>32bit, optional lossless compression, transparency</td></tr>
<tr><td><span class="menu">TIFF Images</span></td><td>24bit, optional lossless compression, layers, transparency</td></tr>
<tr><td class="onelinetop"><span class="menu">WonderBrush Images</span></td><td>32bit, layers, transparency, vector/pixel data</td></tr>
</table>
<p><br /></p>
<p>Note: Screenshots, charts, black&amp;white drawings and other images with few used colors, as well as small pictures are best saved as GIF (up to 256 colors) or PNG (millions of colors). JPEG, for example, introduces compression artefacts without gain in smaller filesize.</p>
<div class="box-info">Screenshots, charts, black&amp;white drawings and other images with few used colors, as well as small pictures are best saved as GIF (up to 256 colors) or PNG (millions of colors). JPEG, for example, introduces compression artefacts without gain in smaller filesize.</div>
</div>

80
docs/userguide/en/preferences/prefs-e-mail.html
View File

@ -5,7 +5,7 @@
<head>
<!--
*
* Copyright 2008, Haiku. All rights reserved.
* Copyright 2008-2009, Haiku. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
@ -39,96 +39,96 @@
<h1><img src="../../images/prefs-images/e-mail-icon_64.png" alt="e-mail-icon_64.png"
width="64" height="64" />E-mail</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/E-mail</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Mail/*</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/E-mail</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Mail/*</span></td></tr>
</table>
<p>Haiku provides a system that retrieves e-mail regularly via a mail_daemon and saves each mail as a single text file. It parses the mail and fills its attributes with all necessary header information, like from, to, subject and its unread status. Now it can be queried by you or any application. This system also makes switching e-mail clients easy as all the data and your configuration stays the same.<br />
The configuration is done in the E-Mail preference panel.</p>
<h2><a id="creating" name="creating">Creating a new e-mail account</a></h2>
<p>Let's go through the process of setting up an e-mail account.<br />
You start by clicking the <i>Add</i> button to create a new, unnamed account. Then you declare the <i>Account Type</i> which is either <i>Receive Mail Only</i>, <i>Send Mail Only</i>, or the most usual type, <i>Send and Receive Mail</i>.</p>
You start by clicking the <span class="button">Add</span> button to create a new, unnamed account. Then you declare the <i>Account Type</i> which is either <span class="menu">Receive Mail Only</span>, <span class="menu">Send Mail Only</span>, or the most usual type, <span class="menu">Send and Receive Mail</span>.</p>
<p>Now you enter an <i>Account Name</i>, your <i>Real Name</i> and the <i>Return Address</i> where replies will be sent to.</p>
<h2><a id="incoming" name="incoming">Setting up incoming e-mail</a></h2>
<p>Click on <i>Incoming</i> under your account's name to set up how e-mails are received.</p>
<p>Click on <span class="menu">Incoming</span> under your account's name to set up how e-mails are received.</p>
<img src="../../images/prefs-images/e-mail-in.png" alt="e-mail-in.png" width="491" height="472" />
<p>From the drop-down menu you choose the protocol used by your provider. <i>IMAP</i> and <i>POP3</i> are supported.</p>
<p>Next is the <i>Mail Server</i> address for incoming mails. If your provider needs you to log into a specific port, you add that to the address, separated by a colon. For example, <tt>pop.your-provider.org:1400</tt>.</p>
<p>Then you enter your login information, <i>Username</i> and <i>Password</i>, and if necessary change the <i>Login Type</i> from the default <i>Plain Text</i> to <i>APOP</i> for authentication.</p>
<p>If you retrieve mails of this account from different computers, you may want to activate the option to <i>Leave mail on server</i> and only <i>Remove mail from server when deleted</i> locally.</p>
<p>The <i>New Mail Notification</i> offers different methods to announce the arrival of new mail. Try different settings to see what works best for you.</p>
<p>You can change the <i>Location</i> of your inbox (default: <tt>/boot/home/mail/in/</tt>), which is useful if you'd like to separate the mails from different accounts into their own folders. However, queries let you sort things out just as well.</p>
<p>Last on this page, you can opt to only <i>Partially download messages</i> that are larger than a certain size. This will only get the header and you can decide if you want to download the rest of the message plus possible attachments after seeing the subject and who sent it. Useful if you have a slow connection.</p>
<p>From the drop-down menu you choose the protocol used by your provider. <span class="menu">IMAP</span> and <span class="menu">POP3</span> are supported.</p>
<p>Next is the <span class="menu">Mail Server</span> address for incoming mails. If your provider needs you to log into a specific port, you add that to the address, separated by a colon. For example, <tt>pop.your-provider.org:1400</tt>.</p>
<p>Then you enter your login information, <i>Username</i> and <i>Password</i>, and if necessary change the <i>Login Type</i> from the default <span class="menu">Plain Text</span> to <span class="menu">APOP</span> for authentication.</p>
<p>If you retrieve mails of this account from different computers, you may want to activate the option to <span class="menu">Leave mail on server</span> and only <span class="menu">Remove mail from server when deleted</span> locally.</p>
<p>The <span class="menu">New Mail Notification</span> offers different methods to announce the arrival of new mail. Try different settings to see what works best for you.</p>
<p>You can change the <i>Location</i> of your inbox (default: <span class="path">/boot/home/mail/in/</span>), which is useful if you'd like to separate the mails from different accounts into their own folders. However, queries let you sort things out just as well.</p>
<p>Last on this page, you can opt to only <span class="menu">Partially download messages</span> that are larger than a certain size. This will only get the header and you can decide if you want to download the rest of the message plus possible attachments after seeing the subject and who sent it. Useful if you have a slow connection.</p>
<h2><a id="outgoing" name="outgoing">Setting up outgoing e-mail</a></h2>
<p>Click on <i>Outgoing</i> under your account's name to set up how e-mails are sent.</p>
<p>Click on <span class="menu">Outgoing</span> under your account's name to set up how e-mails are sent.</p>
<img src="../../images/prefs-images/e-mail-out.png" alt="e-mail-out.png" width="491" height="472" />
<p>As with incoming mail, you can also change the <i>Location</i> of your outbox (default: <tt>/boot/home/mail/out/</tt>).</p>
<p>As with incoming mail, you can also change the <i>Location</i> of your outbox (default: <span class="path">/boot/home/mail/out/</span>).</p>
<p>Next is the <i>SMTP Server</i> address for outgoing mails. As with the incoming server before, you can use a specific port if needed, e.g. <tt>mail.your-provider.org:1200</tt>.</p>
<p>If you need to login, you change the <i>Login Type</i> to <i>ESMTP</i> and enter username and password above. The other type is used for providers that need you to check for mail with <i>POP3 before SMTP</i> for identification.</p>
<p>If you need to login, you change the <i>Login Type</i> to <span class="menu">ESMTP</span> and enter username and password above. The other type is used for providers that need you to check for mail with <span class="menu">POP3 before SMTP</span> for identification.</p>
<h2><a id="filters" name="filters">Setting up e-mail filters</a></h2>
<p>If you want to filter your incoming email, you click on <i>E-Mail Filters</i> under your account's name to set up automatic sorting. You can add any number of filters that are applied one after the other. You can rearrange them by drag&amp;dropping them to their new position.<br />
Besides the <i>R5 Daemon Filter</i> that's used for backward compatibility, there are two other <i>Incoming Mail Filters</i> you can add.</p>
<p>If you want to filter your incoming email, you click on <span class="menu">E-Mail Filters</span> under your account's name to set up automatic sorting. You can add any number of filters that are applied one after the other. You can rearrange them by drag&amp;dropping them to their new position.<br />
Besides the <span class="menu">R5 Daemon Filter</span> that's used for backward compatibility, there are two other <span class="menu">Incoming Mail Filters</span> you can add.</p>
<h3>Spam Filter</h3>
<img src="../../images/prefs-images/e-mail-filter-spam.png" alt="e-mail-filter-spam.png" width="491" height="472" />
<p>The spam filter uses statistical methods to classify a mail as unwanted spam. It assigns a value between 0 and 1 to it and you can decide what are the limits for a genuine mail and what will be considered spam.<br />
You can have that spam rating added to the start of the subject.<br />
Also, the spam filter can learn from all incoming e-mail. Of course, you'll have to teach it by sorting out the false positives, mails that were mistakenly marked as spam. You'll find more on that when we discuss the application <i>Mail</i>.</p>
<p>Together with the following <i>Match Header</i> filter, you're able to automatically sort out detected spam mails.</p>
Also, the spam filter can learn from all incoming e-mail. Of course, you'll have to teach it by sorting out the false positives, mails that were mistakenly marked as spam. You'll find more on that when we discuss the application <span class="app">Mail</span>.</p>
<p>Together with the following <span class="menu">Match Header</span> filter, you're able to automatically sort out detected spam mails.</p>
<h3>Match Header</h3>
<img src="../../images/prefs-images/e-mail-filter-header.png" alt="e-mail-filter-header.png" width="491" height="472" />
<p>This filter compares a header to a search pattern and performs some action when it matches.<br />
With the first text field you specify which header to check against. These are available:</p>
<table summary="match header" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Name</i></td><td style="width:5px;">&#160;</td>
<tr><td><span class="menu">Name</span></td><td style="width:5px;">&#160;</td>
<td>the name of the sender</td></tr>
<tr><td><i>From</i></td><td>&#160;</td>
<tr><td><span class="menu">From</span></td><td>&#160;</td>
<td>the e-mail address of the sender</td></tr>
<tr><td><i>To</i></td><td>&#160;</td>
<tr><td><span class="menu">To</span></td><td>&#160;</td>
<td>your e-mail address (different for each e-mail account)</td></tr>
<tr><td><i>Reply To</i></td><td>&#160;</td>
<tr><td><span class="menu">Reply To</span></td><td>&#160;</td>
<td>the e-mail address replies are sent to</td></tr>
<tr><td><i>When</i></td><td>&#160;</td>
<tr><td><span class="menu">When</span></td><td>&#160;</td>
<td>the date and time the mail was received</td></tr>
<tr><td><i>Subject</i></td><td>&#160;</td>
<tr><td><span class="menu">Subject</span></td><td>&#160;</td>
<td>the subject line</td></tr>
<tr><td><i>Cc</i></td><td>&#160;</td>
<tr><td><span class="menu">Cc</span></td><td>&#160;</td>
<td>addresses of anyone receiving a carbon copy (Cc)</td></tr>
<tr><td><i>Account</i></td><td>&#160;</td>
<tr><td><span class="menu">Account</span></td><td>&#160;</td>
<td>the name of the e-mail's account</td></tr>
<tr><td><i>Status</i></td><td>&#160;</td>
<tr><td><span class="menu">Status</span></td><td>&#160;</td>
<td>The current status of the e-mail. Normally, this can be "Read", "Replied", "Sent", "Forwarded", "New", or anything you have designated yourself. However, unless you change it yourself in a filter, it will always be "New" when the mail_daemon fetched the mail.</td></tr>
<tr><td><i>Priority</i></td><td>&#160;</td>
<tr><td><span class="menu">Priority</span></td><td>&#160;</td>
<td>is set by the sender's e-mail program (e.g. "urgent")</td></tr>
<tr><td><i>Thread</i></td><td>&#160;</td>
<tr><td><span class="menu">Thread</span></td><td>&#160;</td>
<td>essentially the same as "Subject", but without things like Re: or Fwd:</td></tr>
<tr><td><i>Classification Group</i></td><td>&#160;</td>
<tr><td><span class="menu">Classification Group</span></td><td>&#160;</td>
<td>depending on what the spam filter classified it as, this will either be empty (if uncertain) or contain the word "Genuine" or "Spam"</td></tr>
<tr><td><i>Spam/Genuine Estimate</i></td><td>&#160;</td>
<tr><td><span class="menu">Spam/Genuine Estimate</span></td><td>&#160;</td>
<td>this is a numerical estimate that the spam filter assigned to the e-mail. They are shown in scientific notation, where 1.065e-12 translates to 1.065 divided by 10 to the 12th power, which in this case translates to 0.000000000001065.</td></tr>
</table>
<p>The second text field holds your search pattern. It accepts <a href="http://en.wikipedia.org/wiki/Regular_expression" class='external free' title="http://en.wikipedia.org/wiki/Regular expression" rel="nofollow">regular expressions</a> which gives it great flexibility, while unfortunately complicating things a bit. Read up on it a bit, it's well worth it and simple search patterns aren't <i>that</i> complicated at all.</p>
<p>With the drop-down menu below it, you assign an action when the pattern matches. You can move or delete a mail, set the status to "Read" or anything else or set the e-mail account you'll reply with.</p>
<h3>Outgoing Mail Filters</h3>
<p>At this moment, there's only one filter that deals with outgoing mail: <i>Fortune</i>.
<br />It will attach a randomly chosen funny or wise "fortune cookie" to the end of every mail before it's sent out. You can do a dry run by issuing the command <tt>fortune</tt> in a Terminal.</p>
<p>At this moment, there's only one filter that deals with outgoing mail: <span class="cli">fortune</span>.
<br />It will attach a randomly chosen funny or wise "fortune cookie" to the end of every mail before it's sent out. You can do a dry run by issuing the command <span class="cli">fortune</span> in a Terminal.</p>
<h2><a id="settings" name="settings">Setting up the mail_daemon</a></h2>
<p>Now that your incoming and outgoing mail servers (and maybe some filters, too), are configured, you have to tell the mail_server that does all the actual mail checking and fetching how to do its job.</p>
<img src="../../images/prefs-images/e-mail-settings.png" alt="e-mail-settings.png" width="491" height="472" />
<p>Under <i>Mail Checking</i> you configure the interval at which the account's mail server is probed for new mail.<br />
If you're on a dial-up connection, you may want to do that <i>Only When Dial-Up is Connected</i> and also <i>Schedule Outgoing Mail When Dial-Up is Disconnected</i> to avoid dialing automatically in regularly only to check for mail.</p>
<p>The mail_daemon has a status window which you can set to show up <i>Never</i>, <i>While Sending</i>, <i>While Sending and Receiving</i> or <i>Always</i>.</p>
<p>Make sure to <i>Start Mail Services on Startup</i> or there will be no mail_daemon running to do your bidding...</p>
If you're on a dial-up connection, you may want to do that <span class="menu">Only When Dial-Up is Connected</span> and also <span class="menu">Schedule Outgoing Mail When Dial-Up is Disconnected</span> to avoid dialing automatically in regularly only to check for mail.</p>
<p>The mail_daemon has a status window which you can set to show up <span class="menu">Never</span>, <span class="menu">While Sending</span>, <span class="menu">While Sending and Receiving</span> or <span class="menu">Always</span>.</p>
<p>Make sure to <span class="menu">Start Mail Services on Startup</span> or there will be no mail_daemon running to do your bidding...</p>
<img src="../../images/prefs-images/e-mail-mailbox.png" alt="e-mail-mailbox.png" width="271" height="200" />
<p><i>Edit Mailbox Menu...</i> will open the folder <tt>/boot/home/config/Mail/Menu Links/</tt>. All folders or queries (!) or their links put into this folder will appear in the context menu of the mailbox icon of the Mail Services in the Deskbar tray.</p>
<p>From that menu, you can also <i>Create New Message...</i>s, <i>Check For Mail Now</i> or <i>Edit Preferences...</i>.</p>
<p><span class="menu">Edit Mailbox Menu...</span> will open the folder <span class="path">/boot/home/config/Mail/Menu Links/</span>. All folders or queries (!) or their links put into this folder will appear in the context menu of the mailbox icon of the Mail Services in the Deskbar tray.</p>
<p>From that menu, you can also <span class="menu">Create New Message...</span>, <span class="menu">Check For Mail Now</span> or <span class="menu">Edit Preferences...</span>.</p>
<p>The mailbox icon itself shows if there are unread messages (status "New") when there are envelopes inside.</p>
</div>

8
docs/userguide/en/preferences/prefs-filetypes.html
View File

@ -39,10 +39,10 @@
<h1><img src="../../images/prefs-images/filetypes-icon_64.png" alt="filetypes-icon_64.png"
width="64" height="64" />FileTypes</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/FileTypes</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/FileTypes settings</tt><br />
<tt>~/config/settings/beos_mime/*</tt> - Stores all MIME types as folders.</td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/FileTypes</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/FileTypes settings</span><br />
<span class="path">~/config/settings/beos_mime/*</span> - Stores all MIME types as folders.</td></tr>
</table>
<p>Please refer to topic <a href="filetypes.html">Filetypes</a> and the workshop <a href="workshop-filetypes+attributes.html">Filetypes, Attributes, Index and Queries</a> that explains most of this preference panel.</p>

14
docs/userguide/en/preferences/prefs-fonts.html
View File

@ -38,21 +38,21 @@
<h1><img src="../../images/prefs-images/fonts-icon_64.png" alt="fonts-icon_64.png" width="64" height="64" />Fonts</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Fonts</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/system/app_server/fonts</tt><br />
<tt>~/config/settings/Font_settings</tt> - Stores the panel's window position.</td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Fonts</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/system/app_server/fonts</span><br />
<span class="path">~/config/settings/Font_settings</span> - Stores the panel's window position.</td></tr>
</table>
<p><br /></p>
<img src="../../images/prefs-images/fonts.png" alt="fonts.png" width="361" height="342" />
<p>Haiku defines three standard fonts for different purposes. You set plain, bold and fixed font types and sizes that will be used throughout the system.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Defaults</i></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><i>Revert</i></td><td>&#160;</td><td>brings back the settings that were active when you started the Fonts preferences.</td></tr>
<tr><td><span class="button">Defaults</span></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><span class="button">Revert</span></td><td>&#160;</td><td>brings back the settings that were active when you started the Fonts preferences.</td></tr>
</table>
<h2><a id="install" name="install">Installing new fonts</a></h2>
<p>You install new fonts by copying them into their respective user folder, i.e. <tt>/boot/common/fonts/</tt> or <tt>/boot/home/config/fonts/</tt> (see topic <a href="filesystem-layout.html">Filesystem layout</a>).</p>
<p>You install new fonts by copying them into their respective user folder, i.e. <span class="path">/boot/common/fonts/</span> or <span class="path">/boot/home/config/fonts/</span> (see topic <a href="filesystem-layout.html">Filesystem layout</a>).</p>
</div>

10
docs/userguide/en/preferences/prefs-keyboard.html
View File

@ -38,16 +38,16 @@
<h1><img src="../../images/prefs-images/keyboard-icon_64.png" alt="keyboard-icon_64.png" width="64" height="64" />Keyboard</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Keyboard</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Keyboard_settings</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Keyboard</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Keyboard_settings</span></td></tr>
</table>
<p><br /></p>
<img src="../../images/prefs-images/keyboard.png" alt="keyboard.png" width="231" height="249" />
<p>Set the repeat rate and the delay until a held down key starts to repeat. You can test your settings in the text field at the bottom.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Defaults</i></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><i>Revert</i></td><td>&#160;</td><td>brings back the settings that were active when you started the Keyboard preferences.</td></tr>
<tr><td><span class="button">Defaults</span></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><span class="button">Revert</span></td><td>&#160;</td><td>brings back the settings that were active when you started the Keyboard preferences.</td></tr>
</table>
</div>

16
docs/userguide/en/preferences/prefs-keymap.html
View File

@ -38,21 +38,21 @@
<h1><img src="../../images/prefs-images/keymap-icon_64.png" alt="keymap-icon_64.png" width="64" height="64" />Keymap</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Keymap</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Keymap/*</tt> - Location of user modified keymaps.<br />
<tt>~/config/settings/Key_map</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Keymap</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Keymap/*</span> - Location of user modified keymaps.<br />
<span class="path">~/config/settings/Key_map</span></td></tr>
</table>
<p><br /></p>
<img src="../../images/prefs-images/keymap.png" alt="keymap.png" width="681" height="287" />
<p>The Keymap window shows a representation of your keyboard. When you press a key, the corresponding key is inverted and the assigned symbol is entered into the text field at the top. From there you can copy and paste it into any document.<br />
Thus, the Keymap preferences are not only for configuring your local keymap, but are also useful when looking for a special symbol used in other languages. For example, you can switch the keymap to "French", find the "&ccedil;" and copy it into your mail to Fran&ccedil;ois. (Though you'll find the "cedil" also in other keymaps...")</p>
<p>Pressing modifier keys like <tt>SHIFT</tt> or <tt>AltGr</tt>, you'll find more special characters.</p>
<p>Pressing modifier keys like <span class="key">SHIFT</span> or <span class="key">AltGr</span>, you'll find more special characters.</p>
<p>Then there are the keys that are marked with a yellow outline. These are keys that can change the key you press after that. If you press a yellow key twice, those changeable keys are marked with a red outline. Examples are &eacute;, &ntilde;, &oacute; or &euml;.</p>
<p>You set the used font, which may or may not contain all symbols for a specific keymap from the <i>Font</i> menu.</p>
<p>You set the used font, which may or may not contain all symbols for a specific keymap from the <span class="menu">Font</span> menu.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Revert</i></td><td>&#160;</td><td>brings back the settings that were active when you started the Keymap preferences.</td></tr>
<tr><td><i>Use</i></td><td>&#160;</td><td>applies your changes.</td></tr>
<tr><td><span class="button">Revert</span></td><td>&#160;</td><td>brings back the settings that were active when you started the Keymap preferences.</td></tr>
<tr><td><span class="button">Use</span></td><td>&#160;</td><td>applies your changes.</td></tr>
</table>
</div>

10
docs/userguide/en/preferences/prefs-media.html
View File

@ -38,11 +38,11 @@
<h1><img src="../../images/prefs-images/media-icon_64.png" alt="media-icon_64.png" width="64" height="64" />Media</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Media</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Media/*</tt><br />
<tt>~/config/settings/System Audio Mixer</tt><br />
<tt>~/config/settings/MediaPrefs Settings</tt> - Stores the panel's window position.</td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Media</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Media/*</span><br />
<span class="path">~/config/settings/System Audio Mixer</span><br />
<span class="path">~/config/settings/MediaPrefs Settings</span> - Stores the panel's window position.</td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

16
docs/userguide/en/preferences/prefs-menu.html
View File

@ -38,19 +38,19 @@
<h1><img src="../../images/prefs-images/menu-icon_64.png" alt="menu-icon_64.png" width="64" height="64" />Menu</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Menu</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/system/app_server/appearance</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Menu</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/system/app_server/appearance</span></td></tr>
</table>
<p><br /></p>
<img src="../../images/prefs-images/menu.png" alt="menu.png" width="258" height="226" />
<p>You can change the font face and size used in menus, as well as the color of the menu/menubar.</p>
<p><i>Always Show Triggers</i> will always underline the letter for the keyboard shortcut of a menu item. If you don't activate this option, the underlining will only appear when...????</p>
<p>With the last items in this preference panel you set the system wide shortcut key. Either the Haiku default <tt>ALT</tt> or the <tt>CTRL</tt> key used on some other platforms.<br />
While it's useful to have always the same modifier key for shortcuts across different operating systems, don't dismiss Haiku's default too quickly. After you get used to it, it actually feels better as e.g. <tt>ALT+C</tt> and <tt>ALT+V</tt> is reached more conveniently on the keyboard and these commands seamlessly integrate into the <acronym title="Bourne Again Shell">bash</acronym> shell of the Terminal, where <tt>CTRL+C</tt> quits the running process.</p>
<p><span class="menu">Always Show Triggers</span> will always underline the letter for the keyboard shortcut of a menu item. If you don't activate this option, the underlining will only appear when...????</p>
<p>With the last items in this preference panel you set the system wide shortcut key. Either the Haiku default <span class="key">ALT</span> or the <span class="key">CTRL</span> key used on some other platforms.<br />
While it's useful to have always the same modifier key for shortcuts across different operating systems, don't dismiss Haiku's default too quickly. After you get used to it, it actually feels better as e.g. <span class="key">ALT</span>&#160;<span class="key">C</span> and <span class="key">ALT</span>&#160;<span class="key">V</span> is reached more conveniently on the keyboard and these commands seamlessly integrate into the <acronym title="Bourne Again Shell">bash</acronym> shell of the Terminal, where <span class="key">CTRL</span>&#160;<span class="key">C</span> quits the running process.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Defaults</i></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><i>Revert</i></td><td>&#160;</td><td>brings back the settings that were active when you started the Menu preferences.</td></tr>
<tr><td><span class="button">Defaults</span></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><span class="button">Revert</span></td><td>&#160;</td><td>brings back the settings that were active when you started the Menu preferences.</td></tr>
</table>
</div>

24
docs/userguide/en/preferences/prefs-mouse.html
View File

@ -38,30 +38,30 @@
<h1><img src="../../images/prefs-images/mouse-icon_64.png" alt="mouse-icon_64.png"width="64" height="64" />Mouse</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Mouse</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Mouse_settings</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Mouse</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Mouse_settings</span></td></tr>
</table>
<p><br /></p>
<img src="../../images/prefs-images/mouse.png" alt="mouse.png" width="444" height="341" />
<p>Set your type of mouse: 1, 2 or 3 button mouse. You can simulate the 2nd (=right) mouse button by holding down <tt>CTRL</tt> while left-clicking. For the 3rd (=middle) mouse button, it's <tt>CTRL+ALT</tt> and a left-click. A middle-click is also simulated by clicking left and right button together. Useful for notebooks, which mostly don't have a 3rd button.</p>
<p>Set your type of mouse: 1, 2 or 3 button mouse. You can simulate the 2nd (=right) mouse button by holding down <span class="key">CTRL</span> while left-clicking. For the 3rd (=middle) mouse button, it's <span class="key">CTRL</span>&#160;<span class="key">ALT</span> and a left-click. A middle-click is also simulated by clicking left and right button together. Useful for notebooks, which mostly don't have a 3rd button.</p>
<p>You can rearrange the mouse buttons by clicking on them and choose their new meaning from the drop-down menu.</p>
<p>With the sliders to the right, you adjust double-click speed, mouse speed and acceleration.</p>
<p><i>Focus follows mouse</i> means, that you don't have to click into a window to activate it. There are three modes:</p>
<p><span class="menu">Focus follows mouse</span> means, that you don't have to click into a window to activate it. There are three modes:</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Enabled</i></td><td>&#160;</td><td>The window under the mouse pointer is always activated automatically, but doesn't pop to the front.</td></tr>
<tr><td><i>Warping</i></td><td>&#160;</td><td>Choosing a window from Deskbar or the <a href="twitcher.html">Twitcher</a> will have the mouse pointer glide smoothly toward it.</td></tr>
<tr><td class="onelinetop"><i>Instant-Warping</i></td><td>&#160;</td><td>Choosing a window from Deskbar or the Twitcher will have the mouse pointer jump instantly toward it.</td></tr>
<tr><td><span class="menu">Enabled</span></td><td>&#160;</td><td>The window under the mouse pointer is always activated automatically, but doesn't pop to the front.</td></tr>
<tr><td><span class="menu">Warping</span></td><td>&#160;</td><td>Choosing a window from Deskbar or the <a href="twitcher.html">Twitcher</a> will have the mouse pointer glide smoothly toward it.</td></tr>
<tr><td class="onelinetop"><span class="menu">Instant-Warping</span></td><td>&#160;</td><td>Choosing a window from Deskbar or the Twitcher will have the mouse pointer jump instantly toward it.</td></tr>
</table>
<p>All settings are immediately applied.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Defaults</i></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><i>Revert</i></td><td>&#160;</td><td>brings back the settings that were active when you started the Mouse preferences.</td></tr>
<tr><td><span class="button">Defaults</span></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><span class="button">Revert</span></td><td>&#160;</td><td>brings back the settings that were active when you started the Mouse preferences.</td></tr>
</table>
</div>
<!--
<div class="bottomnav">
<p>
<a href="../preferences.html">Preferences</a>
@ -71,7 +71,7 @@
Next: <a href="prefs-network.html">Network</a>
</p>
</div>
-->
</body>
</html>

10
docs/userguide/en/preferences/prefs-network.html
View File

@ -38,17 +38,17 @@
<h1><img src="../../images/prefs-images/network-icon_64.png" alt="network-icon_64.png" width="64" height="64" />Network</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Network</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>/boot/beos/etc/resolv.conf</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Network</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">/boot/beos/etc/resolv.conf</span></td></tr>
</table>
<p><br /></p>
<img src="../../images/prefs-images/network.png" alt="network.png" width="259" height="290" />
<p>At the top, you choose which network adapter to configure.</p>
<p>Then you specify if you get your network settings dynamically from a server or router via <acronym title="Dynamic Host Configuration Protocol">DHCP</acronym> or if you're using static addresses. If it's the latter, you'll have to fill out IP Address, Netmask, Gateway and DNS Servers yourself. Otherwise the panel will show the addresses currently set with DHCP.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Revert</i></td><td>&#160;</td><td>brings back the settings that were active when you started the Network preferences.</td></tr>
<tr><td><i>Apply</i></td><td>&#160;</td><td>sets the entered configuration.</td></tr>
<tr><td><span class="button">Revert</span></td><td>&#160;</td><td>brings back the settings that were active when you started the Network preferences.</td></tr>
<tr><td><span class="button">Apply</span></td><td>&#160;</td><td>sets the entered configuration.</td></tr>
</table>
</div>

6
docs/userguide/en/preferences/prefs-printers.html
View File

@ -38,9 +38,9 @@
<h1><img src="../../images/prefs-images/printers-icon_64.png" alt="printers-icon_64.png"width="64" height="64" />Printers</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Printers</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/printers/*</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Printers</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/printers/*</span></td></tr>
</table>
<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>

14
docs/userguide/en/preferences/prefs-screen.html
View File

@ -38,18 +38,18 @@
<h1><img src="../../images/prefs-images/screen-icon_64.png" alt="screen-icon_64.png" width="64" height="64" />Screen</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Screen</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/system/app_server/workspaces</tt><br />
<tt>~/config/settings/kernel/drivers/vesa</tt> - Only when running in VESA mode.<br />
<tt>~/config/settings/Screen_data</tt> - Stores the panel's window position.</td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Screen</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/system/app_server/workspaces</span><br />
<span class="path">~/config/settings/kernel/drivers/vesa</span> - Only when running in VESA mode.<br />
<span class="path">~/config/settings/Screen_data</span> - Stores the panel's window position.</td></tr>
</table>
<p>Each of your workspaces can have its own resolution and color depth.</p>
<img src="../../images/prefs-images/screen.png" alt="screen.png" width="458" height="255" />
<p>The top drop-down menu specifies if your changes are applied only to the current or to all workspaces. Depending on your graphics card, the other two drop-down menus contain all supported resolution and depth settings.</p>
<p>After clicking on <i>Apply</i>, the graphics mode is changed and an alert appears, asking you to keep or cancel the changes. If you don't answer that alert, the graphics mode reverts after 12 seconds to the previous setting. Maybe you couldn't see the alert because your monitor didn't support the setting.</p>
<p>After clicking on <span class="button">Apply</span>, the graphics mode is changed and an alert appears, asking you to keep or cancel the changes. If you don't answer that alert, the graphics mode reverts after 12 seconds to the previous setting. Maybe you couldn't see the alert because your monitor didn't support the setting.</p>
<p>To the left, you can set the number of workspaces and open the <a href="prefs-backgrounds.html">Backgrounds</a> preferences.</p>
<p><i>Revert</i> brings back the setting that was active when you started the Screen preferences.</p>
<p><span class="button">Revert</span> brings back the setting that was active when you started the Screen preferences.</p>
</div>

8
docs/userguide/en/preferences/prefs-screensaver.html
View File

@ -38,9 +38,9 @@
<h1><img src="../../images/prefs-images/screensaver-icon_64.png" alt="screensaver-icon_64.png"
width="64" height="64" />ScreenSaver</h1>
<p><table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Screensaver</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/ScreenSaver_settings</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Screensaver</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/ScreenSaver_settings</span></td></tr>
</table>
</p>
<p>The panel of the ScreenSaver preferences is split into two tabs:
@ -62,7 +62,7 @@ The other, after how many minutes you need a password to unlock your machine.
<h2><a name="modules">Modules</a></h2>
<img src="../../images/prefs-images/screensaver-modules.png" alt="screensaver-modules.png" width="473" height="357">
<br />
<p>The second tab shows a list of all installed screen saver modules and their individual settings. You can test your settings with the <i>Test</i> button below the list and add modules with the <i>Add...</i> button beside it. Other ways to install new screen savers is by a simple drag&amp;drop into the list. Of course, you can also copy/delete a module's file in its respective user folder, i.e. <tt>/boot/common/add-ons/screensavers/</tt> or <tt>/boot/home/config/add-ons/screensavers/</tt> (see topic <a href="../filesystem-layout.html">Filesystem layout</a>).
<p>The second tab shows a list of all installed screen saver modules and their individual settings. You can test your settings with the <span class="button">Test</span> button below the list and add modules with the <span class="button">Add...</span> button beside it. Other ways to install new screen savers is by a simple drag&amp;drop into the list. Of course, you can also copy/delete a module's file in its respective user folder, i.e. <span class="path">/boot/common/add-ons/screensavers/</span> or <span class="path">/boot/home/config/add-ons/screensavers/</span> (see topic <a href="../filesystem-layout.html">Filesystem layout</a>).
</p>
</div>

15
docs/userguide/en/preferences/prefs-sounds.html
View File

@ -5,7 +5,7 @@
<head>
<!--
*
* Copyright 2008, Haiku. All rights reserved.
* Copyright 2008-2009, Haiku. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
@ -38,17 +38,18 @@
<h1><img src="../../images/prefs-images/sounds-icon_64.png" alt="sounds-icon_64.png" width="64" height="64" />Sounds</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Sounds</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Media/MMediaFilesManager</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Sounds</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Media/MMediaFilesManager</span></td></tr>
</table>
<p><br /></p>
<img src="../../images/prefs-images/sounds.png" alt="sounds.png" width="398" height="344" />
<p>You can assign sounds to certain events in the system. Just select the event from the list and choose a sound from the drop-down menu below.</p>
<p><i>None</i> will silence an event.<br />
<i>Other...</i> will open a file panel to find a new sound that isn't yet in the menu.</p>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td><span class="menu">None</span></td><td>&#160;</td><td>will silence an event.</td></tr>
<tr><td><span class="menu">Other...</span></td><td>&#160;</td><td>will open a file panel to find a new sound that isn't yet in the menu.</td></tr></table>
<p>You can use any format that's supported by the system. If <a href="../applications/apps-mediaplayer.html">MediaPlayer</a> can deal with it, so can any other program.<br />
You can "pre-hear" an event's sound by selecting it and using the <i>Play</i> and <i>Stop</i> buttons.</p>
You can "pre-hear" an event's sound by selecting it and using the <span class="button">Play</span> and <span class="button">Stop</span> buttons.</p>
</div>

18
docs/userguide/en/preferences/prefs-time.html
View File

@ -38,11 +38,11 @@
<h1><img src="../../images/prefs-images/time-icon_64.png" alt="time-icon_64.png" width="64" height="64" />Time</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Time</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/RTC_time_settings</tt><br />
<tt>~/config/settings/timezone</tt> - A link to the current timezone in <tt>/boot/beos/etc/timezones/*/*</tt><br />
<tt>~/config/settings/Time_settings</tt> - Stores the panel's window position.<br /></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Time</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/RTC_time_settings</span><br />
<span class="path">~/config/settings/timezone</span> - A link to the current timezone in <span class="path">/boot/beos/etc/timezones/*/*</span><br />
<span class="path">~/config/settings/Time_settings</span> - Stores the panel's window position.<br /></td></tr>
</table>
<p>The panel of the Time preferences is split into two tabs:</p>
@ -51,14 +51,14 @@
<p>On the left side, you can set the day of the month by simply clicking on it in the calendar. You change the month and year by clicking on it and using the up/down arrows to the right or the cursor keys on your keyboard.</p>
<p>Similarly, you set the time. There are two modes for the clock:</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Local</i></td><td>&#160;</td><td>to display your local time.</td></tr>
<tr><td><i>GMT</i></td><td>&#160;</td><td>to display Greenwich Mean Time.</td></tr>
<tr><td><span class="menu">Local Time</span></td><td>&#160;</td><td>to display your local time.</td></tr>
<tr><td><span class="menu">GMT</span></td><td>&#160;</td><td>to display Greenwich Mean Time.</td></tr>
</table>
<h2><a id="timezone" name="timezone">Timezone</a></h2>
<img src="../../images/prefs-images/time-timezone.png" alt="time-timezone.png" width="495" height="348" />
<p>Simply find and choose your location from the drop-down menu and the list of cities and press <i>Set Time Zone</i> to set your zone.</p>
<p><i>Revert</i> brings back the settings that were active when you started the Time preferences.</p>
<p>Simply find and choose your location from the drop-down menu and the list of cities and press <span class="button">Set Time Zone</span> to set your zone.</p>
<p><span class="button">Revert</span> brings back the settings that were active when you started the Time preferences.</p>
</div>

8
docs/userguide/en/preferences/prefs-tracker.html
View File

@ -38,12 +38,12 @@
<h1><img src="../../images/prefs-images/tracker-icon_64.png" alt="tracker-icon_64.png" width="64" height="64" />Tracker</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/Tracker</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/Tracker/TrackerSettings</tt></td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/Tracker</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/Tracker/TrackerSettings</span></td></tr>
</table>
<p><br /></p>
<p>The Tracker preference panel is also available from every Tracker window with the menu <i>Window | Preferences...</i>.<br />
<p>The Tracker preference panel is also available from every Tracker window with the menu <span class="menu">Window | Preferences...</span>.<br />
It's functions are discussed in the topic on <a href="../tracker.html#tracker-preferences">Tracker</a>.</p>
<!--

12
docs/userguide/en/preferences/prefs-virtualmemory.html
View File

@ -36,10 +36,10 @@
<h1><img src="../../images/prefs-images/virtualmemory-icon_64.png" alt="virtualmemory-icon_64.png" width="64" height="64" />VirtualMemory</h1>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Preferences</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/preferences/VirtualMemory</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/kernel/drivers/virtual_memory</tt><br />
<tt>~/config/settings/VM_data</tt> - Stores the panel's window position.</td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Preferences</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/preferences/VirtualMemory</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/kernel/drivers/virtual_memory</span><br />
<span class="path">~/config/settings/VM_data</span> - Stores the panel's window position.</td></tr>
</table>
<p>Virtual memory let's the system swap out memory to harddisk, if the RAM can be used more sensibly for other things. So, even if you have lots of RAM, providing virtual memory is never a bad idea.</p>
<img src="../../images/prefs-images/virtualmemory.png" alt="virtualmemory.png" width="335" height="285" />
@ -47,8 +47,8 @@
<p>Normally, the swap file's written to your boot partition. If you often run into disk thrashing due to the virtual memory system swapping memory in and out, you can try to use a separate harddisk for you swap file. Simply another partition on the same harddisk with your system/data won't help.<br />
Upgrading your RAM is of course the most effective way to go...</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><i>Defaults</i></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><i>Revert</i></td><td>&#160;</td><td>brings back the settings that were active when you started the VirtualMemory preferences.</td></tr>
<tr><td><span class="button">Defaults</span></td><td>&#160;</td><td>resets everything to default values.</td></tr>
<tr><td><span class="button">Revert</span></td><td>&#160;</td><td>brings back the settings that were active when you started the VirtualMemory preferences.</td></tr>
</table>
</div>

40
docs/userguide/en/queries.html
View File

@ -5,7 +5,7 @@
<head>
<!--
*
* Copyright 2008, Haiku. All rights reserved.
* Copyright 2008-2009, Haiku. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
@ -36,43 +36,43 @@
<div class="content">
<p>A query is a file search based on file attributes and can be performed within Tracker or in Terminal. Queries are saved in "<tt>/boot/home/queries/</tt>" and by default last seven days before being purged. Note, that these aren't static result lists of your search, but are the query formulas which trigger a new search whenever you open them.</p>
<p>A query is a file search based on file attributes and can be performed within Tracker or in Terminal. Queries are saved in <span class="path">/boot/home/queries/</span> and by default last seven days before being purged. Note, that these aren't static result lists of your search, but are the query formulas which trigger a new search whenever you open them.</p>
<h2><a id="find-window" name="find-window">The Find window</a></h2>
<p>You start a query by invoking the <i>Find...</i> menu either from the Deskbar menu or any Tracker window or the Desktop (which is actually a fullscreen Tracker window). The shortcut is <tt>ALT+F</tt>. You're presented with the Find window:</p>
<p>You start a query by invoking the <span class="menu">Find...</span> menu either from the Deskbar menu or any Tracker window or the Desktop (which is actually a fullscreen Tracker window). The shortcut is <span class="key">ALT</span>&#160;<span class="key">F</span>. You're presented with the Find window:</p>
<img src="../images/queries-images/basic-query.png" alt="basic-query.png" width="517" height="292" />
<ol>
<li><p>Select previous or saved queries or save the current query.</p></li>
<li><p>Narrow down your search from "All files and folders" to specific file
types.</p></li>
<li>Define the search method:<ul>
<li><i>by Name</i> - a basic search by filename</li>
<li><i>by Attribute</i> - an advanced search, you specify search terms for one or more attributes</li>
<li><i>by Formula</i> - an even more advanced search, you can fine-tune a complex query term</li></ul></li>
<li><span class="menu">by Name</span> - a basic search by filename</li>
<li><span class="menu">by Attribute</span> - an advanced search, you specify search terms for one or more attributes</li>
<li><span class="menu">by Formula</span> - an even more advanced search, you can fine-tune a complex query term</li></ul></li>
<li><p>Select which drives to search on.</p></li>
<li><p>Enter the search term.</p></li>
<li><p>The expander hides/unhides the additional options.</p></li>
<li><p>Uncheck the <i> Temporary</i> checkbox if you don't want this query self-destruct after 7 days.</p></li>
<li><p>Check if your query is supposed to <i>Include trash</i>.</p></li>
<li><p>Uncheck the <span class="menu">Temporary</span> checkbox if you don't want this query self-destruct after 7 days.</p></li>
<li><p>Check if your query is supposed to <span class="menu">Include trash</span>.</p></li>
<li><p>Optionally, enter a name for this query if you want to save it.</p></li>
<li><p>You can drag&amp;drop the icon to save the query.</p></li>
</ol>
<h2><a id="basic-query" name="basic-query">Basic queries - "by Name"</a></h2>
<p>If you simply want to find all files on your mounted disks that match a certain pattern, simply leave the search method at "<i>by Name</i>", enter the search term into the text box and press <tt>ENTER</tt>.</p>
<p>If you simply want to find all files on your mounted disks that match a certain pattern, simply leave the search method at "<span class="menu">by Name</span>", enter the search term into the text box and press <span class="key">ENTER</span>.</p>
<h2><a id="adv-query" name="adv-query">Advanced queries - "by Attribute"</a></h2>
<p>You can create more advanced queries by searching within the attributes of specific file types. For that to work, these attributes have to be indexed (see <a href="index.html">Index</a>).</p>
<img src="../images/queries-images/query-window.png" alt="query-window.png" width="441" height="172" />
<p>You start by setting the filetype from "<i>All files and folders</i>" to "<i>text | E-mail</i>" and change the search method to "<i>by Attribute</i>.</p>
<p>This adds a drop-down menu to the left of the textbox and the buttons "<i>Add</i> and <i>Remove</i> under that. From the menu you choose which attribute to query. With "<i>Add</i> and <i>Remove</i> you can query additional attributes or remove them again. These attributes can be logically linked with AND/OR.</p>
<p>You start by setting the filetype from "<span class="menu">All files and folders</span>" to "<span class="menu">text | E-mail</span>" and change the search method to "<span class="menu">by Attribute</span>.</p>
<p>This adds a drop-down menu to the left of the textbox and the buttons "<span class="button">Add</span> and <span class="button">Remove</span> under that. From the menu you choose which attribute to query. With "<span class="button">Add</span> and <span class="button">Remove</span> you can query additional attributes or remove them again. These attributes can be logically linked with AND/OR.</p>
<p>Let's do an email query as an example:</p>
<img src="../images/queries-images/query-window-filled.png" alt="query-window-filled.png" width="441" height="262" />
<p>This is your Find window when you're looking for all emails Clara Botter has sent to you in the last two months that had in the subject "vibraphone" or "skepticality".</p>
<h2><a id="more-adv-query" name="more-adv-query">Even more advanced queries - "by Formula"</a></h2>
<p>Typing in a formula query by hand is daunting and really quite unpractical. It still has its uses.</p>
<p>Take the above query by attribute of Clara's mails concerning vibraphones etc. If you have all the attributes and their search terms set, try switching to "<i>by Formula</i> mode and be overwhelmed by this one line query string:</p>
<p>Take the above query by attribute of Clara's mails concerning vibraphones etc. If you have all the attributes and their search terms set, try switching to "<span class="menu">by Formula</span> mode and be overwhelmed by this one line query string:</p>
<img src="../images/queries-images/formula-query.png" alt="formula-query.png" width="441" height="173" />
<p>Once more as text, edited for readability:</p>
<pre>(((((MAIL:from==&quot;*[cC][lL][aA][rR][aA] [bB][oO][tT][tT][eE][rR][sS]*&quot;)
@ -82,9 +82,9 @@ types.</p></li>
&amp;&amp;(BEOS:TYPE==&quot;text/x-email&quot;))</pre>
<p>What's the use?</p>
<ul>
<li>You could copy and paste the string into an email, forum or IRC for others to use or debug.</li>
<li>You can use this method to construct a query in <i>Attribute</i> mode and then switch to <i>Formula</i> mode, to comfortably generate a search string to use for a query in Terminal or a script.</li>
<li>You can fine tune your query by inserting parenthesis where needed, make parts case-sensitive or negate logical combinations by changing. e.g. "<tt>==</tt>" to "<tt>!=</tt>" for a NOT AND. All you need is a basic understanding of <a href="http://en.wikipedia.org/wiki/Regular_expression" class='external free' title="http://en.wikipedia.org/wiki/Regular expression" rel="nofollow">regular expressions</a> and maybe some scripting basics.</li>
<li><p>You could copy and paste the string into an email, forum or IRC for others to use or debug.</p></li>
<li><p>You can use this method to construct a query in <span class="menu">Attribute</span> mode and then switch to <span class="menu">Formula</span> mode, to comfortably generate a search string to use for a query in Terminal or a script.</p></li>
<li><p>You can fine tune your query by inserting parenthesis where needed, make parts case-sensitive or negate logical combinations by changing. e.g. "<tt>==</tt>" to "<tt>!=</tt>" for a NOT AND. All you need is a basic understanding of <a href="http://en.wikipedia.org/wiki/Regular_expression" class='external free' title="http://en.wikipedia.org/wiki/Regular expression" rel="nofollow">regular expressions</a> and maybe some scripting basics.</p></li>
</ul>
<h2><a id="result-window" name="result-window">The result window</a></h2>
@ -92,12 +92,12 @@ types.</p></li>
<img src="../images/queries-images/result-window.png" alt="result-window.png" width="704" height="359" />
<p>Besides the grey background, result windows work exactly like any other Tracker window. Some things are worth noting:</p>
<ul>
<li>You can open the folder a file resides in by double clicking on its path attribute.</li>
<li>With <i>File | Edit Query</i> or <tt>ALT+G</tt> you get back to your Find window to refine your query.</li>
<li>A query is live, i.e. if a file that matches your search criteria appears or disappears from your system, this change is reflected in your results in real-time.
<li><p>You can open the folder a file resides in by double clicking on its path attribute.</p></li>
<li><p>With <span class="menu">File | Edit Query</span> or <span class="key">ALT</span>&#160;<span class="key">G</span> you get back to your Find window to refine your query.</p></li>
<li><p>A query is live, i.e. if a file that matches your search criteria appears or disappears from your system, this change is reflected in your results in real-time.</p></li>
</ul>
<p>You can assign a sensible attribute layout for query results of a specific filetype. Open the folder containing files of the filetype you'd like to create a template for and arrange the attributes how you'd like to have query results presented. Copy this layout with <i>Attributes | Copy Attributes</i>.</p>
<p>Open <tt>/boot/home/config/settings/Tracker/DefaultQueryTemplates</tt>, create a new folder and rename it to <i>group/filetype</i>, replacing slashes with underscores, e.g."audio_x-mp3". Open the new folder and paste in the layout with <i>Attributes | Paste Attributes</i>.</p>
<p>You can assign a sensible attribute layout for query results of a specific filetype. Open the folder containing files of the filetype you'd like to create a template for and arrange the attributes how you'd like to have query results presented. Copy this layout with <span class="menu">Attributes | Copy Attributes</span>.</p>
<p>Open <span class="path">/boot/home/config/settings/Tracker/DefaultQueryTemplates</span>, create a new folder and rename it to <i>group/filetype</i>, replacing slashes with underscores, e.g."audio_x-mp3". Open the new folder and paste in the layout with <span class="menu">Attributes | Paste Attributes</span>.</p>
</div>

8
docs/userguide/en/teammonitor.html
View File

@ -36,12 +36,12 @@
<div class="content">
<p>With <tt>CTRL+ALT+DEL</tt> you invoke the Team Monitor which lists all currently running programs.</p>
<p>With <span class="key">CTRL</span>&#160;<span class="key">ALT</span>&#160;<span class="key">DEL</span> you invoke the Team Monitor which lists all currently running programs.</p>
<img src="../images/teammonitor-images/teammonitor.png" alt="teammonitor.png" width="385" height="342" />
<p>Programs that were launched by the system are blue, those started by the user black.<br />
Applications that are unresponsive, which is often a sign the program has crashed, are marked red. You can kill a program by selecting it and pressing the <i>Kill Application</i> button.</p>
<p>You can summon a Terminal with <tt>ALT+SHIFT+T</tt>.</p>
<p>If your Tracker or Deskbar crashed or froze, a new button appears (you may have to kill the offending team first): <i>Restart the Desktop</i> will restart Tracker and/or Deskbar for you.</p>
Applications that are unresponsive, which is often a sign the program has crashed, are marked red. You can kill a program by selecting it and pressing the <span class="button">Kill Application</span> button.</p>
<p>You can summon a Terminal with <span class="key">ALT</span>&#160;<span class="key">SHIFT</span>&#160;<span class="key">T</span>.</p>
<p>If your Tracker or Deskbar crashed or froze, a new button appears (you may have to kill the offending team first): <span class="button">Restart the Desktop</span> will restart Tracker and/or Deskbar for you.</p>
</div>
<!--

10
docs/userguide/en/tracker-add-ons.html
View File

@ -36,14 +36,14 @@
<div class="content">
<p>Applications can install add-ons so they can be invoked easily on a selection of files from Tracker. Only the add-ons that can handle a specific filetype are presented under <i>Add-Ons</i> from the context menu or the <i>File</i> menu of a Tracker window. Some add-ons don't necessarily need a file to work on and are thus always present.</p>
<p>Applications can install add-ons so they can be invoked easily on a selection of files from Tracker. Only the add-ons that can handle a specific filetype are presented under <span class="menu">Add-Ons</span> from the context menu or the <span class="menu">File</span> menu of a Tracker window. Some add-ons don't necessarily need a file to work on and are thus always present.</p>
<p>Tracker Add-Ons, or links to applications that can act as add-ons, can be installed in three different locations (see topic <a href="filesystem-layout.html">Filesystem layout</a>):</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td><tt>/boot/beos/system/add-ons/Tracker/</tt></td><td>&#160;&#160;&#160;</td><td> for system provided add-ons</td></tr>
<tr><td><tt>/boot/common/add-ons/Tracker/</tt></td><td>&#160;&#160;&#160;</td><td> for add-ons available to every user</td></tr>
<tr><td><tt>/boot/home/config/add-ons/Tracker/</tt></td><td>&#160;&#160;&#160;</td><td> for add-ons only available to yourself</td></tr>
<tr><td><span class="path">/boot/beos/system/add-ons/Tracker/</span></td><td>&#160;&#160;&#160;</td><td> for system provided add-ons</td></tr>
<tr><td><span class="path">/boot/common/add-ons/Tracker/</span></td><td>&#160;&#160;&#160;</td><td> for add-ons available to every user</td></tr>
<tr><td><span class="path">/boot/home/config/add-ons/Tracker/</span></td><td>&#160;&#160;&#160;</td><td> for add-ons only available to yourself</td></tr>
</table>
<p>The file name of an add-on can be suffixed with a dash and capital letter, and is then available via keyboard shortcut. For example, <i>Open Target Folder-T</i> opens with <tt>ALT+AltGr+T</tt> (at least with my keymap, you may have a different key combination).<br />
<p>The file name of an add-on can be suffixed with a dash and capital letter, and is then available via keyboard shortcut. For example, <span class="menu">Open Target Folder-T</span> opens with <span class="key">ALT</span>&#160;<span class="key">AltGr</span>&#160;<span class="key">T</span> (at least with my keymap, you may have a different key combination).<br />
Of course, you have to take care of possible shortcut collisions when deciding on a shortcut. You can't have the same for different add-ons.</p>
<h2><a id="system-add-ons" name="system-add-ons">Haiku's Tracker Add-Ons</a></h2>

71
docs/userguide/en/tracker.html
View File

@ -40,87 +40,86 @@
<p>Being an application like any other (the Desktop with its icons is really just a fullscreen window in the background), Tracker appears with its windows in the Deskbar and can be quit and restarted. The easiest way to quit and restart a crashed or frozen Tracker (or a wayward Deskbar) is to call the <a href="teammonitor.html">Team Monitor</a>.</p>
<h2><a id="mounting-volumes" name="mounting-volumes">Mounting Volumes</a></h2>
<p>In order to access a harddisk, CD, USB stick etc., you first have to mount the volume, that is, let the system know it's there. This is done with a right-click on the Desktop or an already mounted volume (like the boot disk) and choosing the volume from the <i>Mount</i> submenu.</p>
<p>In order to access a harddisk, CD, USB stick etc., you first have to mount the volume, that is, let the system know it's there. This is done with a right-click on the Desktop or an already mounted volume (like the boot disk) and choosing the volume from the <span class="menu">Mount</span> submenu.</p>
<img src="../images/tracker-images/mount-settings.png" alt="drill-down.png" width="581" height="290" />
<p>There are also <i>Mount Settings</i> so you don't have to mount everything manually after every bootup.<br />
<p>There are also <span class="menu">Mount Settings</span> so you don't have to mount everything manually after every bootup.<br />
The above settings will mount all disks on bootup that were mounted previously and will automatically mount any storage device you connect/insert.</p>
<p><span style="font-weight:bold; font-size:larger; color:red">Warning:</span><br />
<span style="font-weight:bold; color:red">Before you disconnect e.g. a harddrive or USB stick, make sure you have successfully unmounted the volume. This guarantees that all data transfer has finished. Otherwise you may lose data or corrupt the disk!</span></p>
<div class="box-warning">Before you disconnect e.g. a harddrive or USB stick, make sure you have successfully unmounted the volume. This guarantees that all data transfer has finished. Otherwise you may lose data or corrupt the disk!</div>
<h2><a id="navigating" name="navigating">Navigating</a></h2>
<p>Moving through your folders is one of Trackers main purposes, just like the file managers on other platforms. Haiku's Tracker has some unique features that will help you doing that efficiently.</p>
<p>Instead of double-clicking your way down folder after folder, there's a better way to drill down:</p>
<img src="../images/tracker-images/drill-down.png" alt="drill-down.png" width="603" height="303" />
<p>Right-click onto a folder, and at the top of the usual context menu you'll find a submenu of the current folder that let's you navigate down a level. Just move down the hierarchy until you find the file or folder you're looking for and click on it to open it. The above shows the contents of the folder <tt>/boot/beos/system/</tt>.<br /><br /></p>
<p>Right-click onto a folder, and at the top of the usual context menu you'll find a submenu of the current folder that let's you navigate down a level. Just move down the hierarchy until you find the file or folder you're looking for and click on it to open it. The above shows the contents of the folder <span class="path">/boot/beos/system/</span>.<br /><br /></p>
<p>A similar method can be used from any Tracker window:</p>
<img src="../images/tracker-images/window-drill-down.png" alt="window-drill-down.png" width="502" height="359" />
<p>Click on the area in the lower left, where the number of items are listed, and you'll get submenus for every level above you current folder. From there you can drill down through the folders as usual.</p>
<p>Note, that the Desktop is always the topmost level as that is where Tracker shows mounted volumes. So, if you want to go to another disk, you first have to navigate to the top (Desktop) and cross over to your other disk from there.</p><br />
<p>You'll get the same submenu-navigating when you drag a file over a folder. After a short while of hovering, a submenu pops up and you can drill down to your destination. If you initiated the drag with the right mousebutton, you can choose between copying, moving or linking the file when you release the mouse.</p><br />
<p>By default, when you double-click a folder, Tracker opens a new window while leaving the parent window open. This can quickly lead to an overcrowded desktop.<br />
You can prevent that by holding down the left <tt>WIN</tt> key, which automatically closes the parent window.<br />
You can prevent that by holding down the left <span class="key">WIN</span> key, which automatically closes the parent window.<br />
This is also true for keyboard navigation. For more on that, see topic <a href="keyboard-shortcuts">Shortcuts and key combinations</a>.</p>
<h2><a id="appearance" name="appearance">Appearance</a></h2>
<img src="../images/tracker-images/window-menu.png" alt="window-menu.png" width="382" height="259" />
<p>Tracker windows offer three different viewing modes from the <i>Window</i> menu:</p>
<p>Tracker windows offer three different viewing modes from the <span class="menu">Window</span> menu:</p>
<ul>
<li><b>Icon View</b> (<tt>ALT+1</tt>) - Big icons, you can change the size from the submenu.</li>
<li><b>Mini Icon View</b> (<tt>ALT+2</tt>) - Small icons.</li>
<li><b>List View</b> (<tt>ALT+3</tt>) - A detailed list of your files enabling you to show/hide available <i>attributes</i>. (See topic <a href="attributes.html">Attributes</a>.)</li>
<li><p><b>Icon View</b> (<span class="key">ALT</span>&#160;<span class="key">1</span>) - Big icons, you can change the size from the submenu.</p></li>
<li><p><b>Mini Icon View</b> (<span class="key">ALT</span>&#160;<span class="key">2</span>) - Small icons.</p></li>
<li><p><b>List View</b> (<span class="key">ALT</span>&#160;<span class="key">3</span>) - A detailed list of your files enabling you to show/hide available <i>attributes</i>. (See topic <a href="attributes.html">Attributes</a>.)</p></li>
</ul>
<p>The <i>Window</i> menu offers a number of other functions:</p>
<p>The <span class="menu">Window</span> menu offers a number of other functions:</p>
<ul>
<li><b>Resize Window</b> (<tt>ALT+Y</tt>) - Resizes the window to its ideal size.</li>
<li><b>Clean Up</b> (<tt>ALT+K</tt>) - Aligns all icons to an invisible grid. Hold down <tt>SHIFT</tt> and the menu becomes <i>Clean Up All</i> which additionally sorts all icons alphabetically.</li>
<li><b>Select...</b> (<tt>SHIFT+ALT+A</tt>) - Select files according to a regular expression.</li>
<li><p><b>Resize Window</b> (<span class="key">ALT</span>&#160;<span class="key">Y</span>) - Resizes the window to its ideal size.</p></li>
<li><p><b>Clean Up</b> (<span class="key">ALT</span>&#160;<span class="key">K</span>) - Aligns all icons to an invisible grid. Hold down <span class="key">SHIFT</span> and the menu becomes <span class="menu">Clean Up All</span> which additionally sorts all icons alphabetically.</p></li>
<li><p><b>Select...</b> (<span class="key">SHIFT</span>&#160;<span class="key">ALT</span>&#160;<span class="key">A</span>) - Select files according to a regular expression.</p></li>
</ul>
<p>Sometimes you just want to rearrange a few icons without doing a complete <i>Clean Up</i> (<tt>ALT+K</tt>). In that case, you select these icons and start to drag them to their new location. Before you drop them there, keep <tt>ALT</tt> pressed until you've released the mouse button. This will align the icons to the invisible grid.</p>
<p>Sometimes you just want to rearrange a few icons without doing a complete <span class="menu">Clean Up</span> (<span class="key">ALT</span>&#160;<span class="key">K</span>). In that case, you select these icons and start to drag them to their new location. Before you drop them there, keep <span class="key">ALT</span> pressed until you've released the mouse button. This will align the icons to the invisible grid.</p>
<p>The rest of the functions are pretty self-explanatory, leaving the Tracker preferences.</p>
<h3><a id="tracker-preferences" name="tracker-preferences">Tracker preferences</a></h3>
<p><i>Window | Preferences...</i> opens a panel that offers a number of settings that, where not obvious, should become clear once tried out. Since all settings are applied live, you'll immediately see the changes.
<p><span class="menu">Window | Preferences...</span> opens a panel that offers a number of settings that, where not obvious, should become clear once tried out. Since all settings are applied live, you'll immediately see the changes.
<br />So, in short, the not so obvious settings:</p>
<ul>
<li><b>Desktop</b> - Decide if all mounted disks appear directly on the Desktop or in a window after clicking a single Disk icon sitting on the Desktop.</li>
<li><b>Windows</b> - You can set <i>Single Window Navigation</i>, i.e. a double-clicked folder doesn't open in its own window, but inside the already open window instead, replacing the view of it's parent folder. This is not the same as clicking while holding the <tt>WIN</tt> key, as described above, because you'll lose the per window saved position and size.
<li><p><b>Desktop</b> - Decide if all mounted disks appear directly on the Desktop or in a window after clicking a single Disk icon sitting on the Desktop.</p></li>
<li><p><b>Windows</b> - You can set <span class="menu">Single Window Navigation</span>, i.e. a double-clicked folder doesn't open in its own window, but inside the already open window instead, replacing the view of it's parent folder. This is not the same as clicking while holding the <span class="key">WIN</span> key, as described above, because you'll lose the per window saved position and size.
<br /><br />
<img src="../images/tracker-images/tracker-preferences-navigator.png" alt="tracker-preferences-navigator.png" width="608" height="413" />
<br />
<p>Before you switch Tracker to Single Window Navigation mode, because that may feel more familiar to you, we recommend giving the menu based browsing a try first, as that may actually work much faster for you after getting used to. On the other hand, single window browsing offers a <i>Navigator</i> where you can enter or copy&amp;paste a path name and use back, forward and up buttons.</p></li>
<li><b>Date and Time</b> - Set date and time formats.</li>
<li><b>Trash</b> - Set the behaviour when deleting a file.</li>
<li><b>Volume Icons</b> - Set the colour of an optional indicator of free space that's shown besides a disk's icon.</li>
<li><p><b>Date and Time</b> - Set date and time formats.</p></li>
<li><p><b>Trash</b> - Set the behaviour when deleting a file.</p></li>
<li><p><b>Volume Icons</b> - Set the colour of an optional indicator of free space that's shown besides a disk's icon.</p></li>
</ul>
<p>This panel, by the way, is also available as <i>Tracker</i> from Deskbar's <i>Preferences</i>.</p>
<p>This panel, by the way, is also available as <span class="app">Tracker</span> from Deskbar's <span class="menu">Preferences</span>.</p>
<h2><a id="working-with-files" name="working-with-files">Working with files</a></h2>
<p>When invoked on a selected file, most of the <i>File</i> menu commands are also offered in the context menu by right-clicking that file.</p>
<p>As usual the usage of the commands is pretty clear.</p>
<p>When invoked on a selected file, most of the <span class="menu">File</span> menu commands are also offered in the context menu by right-clicking that file.</p>
<p>As usual the commands are pretty clear.</p>
<ul>
<li><b>Find...</b> - Find a file or folder. See topic <a href="Query.html">Query</a> for more info.</li>
<li><b>New...</b> - Create a new folder or any other file based on a <i>template</i>.
<li><p><b>Find...</b> - Find a file or folder. See topic <a href="Query.html">Query</a> for more info.</p></li>
<li><p><b>New...</b> - Create a new folder or any other file based on a <i>template</i>.
<br /><br />
<img src="../images/tracker-images/new-menu.png" alt="new-menu.png" width="627" height="219" />
<br />
<p>Choosing <i>Edit Templates...</i> opens the folder <tt>/boot/home/config/settings/Tracker/Tracker New Templates</tt>. Creating a file in that folder will offer its filetype with the file's name and other attributes as template in the <i>New...</i> menu. Here, there's a file "Text" with the filetype <tt>text/plain</tt>. See topic <a href="filetypes.html">Filetypes</a> for more info.</p></li>
<li><b>Open With...</b> - A submenu offers all applications that can handle this filetype.
<p>Choosing <span class="menu">Edit Templates...</span> opens the folder <span class="path">/boot/home/config/settings/Tracker/Tracker New Templates</span>. Creating a file in that folder will offer its filetype with the file's name and other attributes as template in the <span class="menu">New...</span> menu. Here, there's a file "Text" with the filetype <tt>text/plain</tt>. See topic <a href="filetypes.html">Filetypes</a> for more info.</p></li>
<li><p><b>Open With...</b> - A submenu offers all applications that can handle this filetype.
<br /><br />
<img src="../images/tracker-images/open-with.png" alt="open-with.png" width="303" height="343" />
<br />
<p>The preferred application that would open the file when double-clicked, is checkmarked. This submenu lists first those applications that can handle the exact filetype, in this case it's a text file, the type <tt>text/plain</tt>. Next come all applications that can handle that supertype in general, here <tt>text/*</tt>. Last in the list are those that can deal with any file. If you don't click on an app in the submenu, but on the <i>Open With...</i> entry instead, a panel opens:</p>
<p>The preferred application that would open the file when double-clicked, is checkmarked. This submenu lists first those applications that can handle the exact filetype, in this case it's a text file, the type <tt>text/plain</tt>. Next come all applications that can handle that supertype in general, here <tt>text/*</tt>. Last in the list are those that can deal with any file. If you don't click on an app in the submenu, but on the <span class="menu">Open With...</span> entry instead, a panel opens:</p>
<br /><br />
<img src="../images/tracker-images/open-with-preferred.png" alt="open-with-preferred" width="539" height="262" />
<p>Here you'll again find the programs that were listed in the submenu. By selecting one and clicking the <i>Open and Make Preferred</i> button, you changed the preferred application for every file of that filetype, here <tt>text/plain</tt>.</p></li>
<li><b>Get Info</b>
<p>Here you'll again find the programs that were listed in the submenu. By selecting one and clicking the <span class="button">Open and Make Preferred</span> button, you changed the preferred application for every file of that filetype, here <tt>text/plain</tt>.</p></li>
<li><p><b>Get Info</b>
<br /><br />
<img src="../images/tracker-images/get-info.png" alt="get-info" width="326" height="302" />
<p>The panel presents info on the selected file and lets you set the default application and, after you expanded that part of the panel, permissions and owner. Clicking on the path will open it in a Tracker window.</p></li>
<li><b>Edit Name</b>, <b>Duplicate</b> and <b>Move to Trash</b> - lets you rename or duplicate a file or put the selected file(s) to the trash.</li>
<li><b>Move to</b>, <b>Copy to</b> and <b>Create Link</b> - lets you move, copy or link the selected file(s) using the submenu navigating method. Holding <tt>SHIFT</tt> while invoking the menu offers the option to create a relative link.</li>
<li><b>Cut</b>, <b>Copy</b> and <b>Paste</b> - lets you cut, copy and paste files using the clipboard. By holding <tt>SHIFT</tt> while invoking the menu you can <b>Copy/Cut more</b> files, maybe from another folder that you can paste somewhere else later. Also, while holding <tt>SHIFT</tt> you can paste the copied files in the clipboard as links.</li>
<li><b>Identify</b> - will sniff out and set the type of a file if it didn't have one before, e.g. if you transferred a file with <i>wget</i> which doesn't set a filetype itself. Holding <tt>SHIFT</tt> while invoking the menu changes the item to identify the filetype and correct it if it was false before.</li>
<li><b>Add-Ons</b> - offers you every generic Tracker add-on and those that can handle the selected file(s). See topic <a href="tracker-add-ons.html">Tracker Add-ons</a> for more information.</li>
<li><p><b>Edit Name</b>, <b>Duplicate</b> and <b>Move to Trash</b> - lets you rename or duplicate a file or put the selected file(s) to the trash.</p></li>
<li><p><b>Move to</b>, <b>Copy to</b> and <b>Create Link</b> - lets you move, copy or link the selected file(s) using the submenu navigating method. Holding <span class="key">SHIFT</span> while invoking the menu offers the option to create a relative link.</p></li>
<li><p><b>Cut</b>, <b>Copy</b> and <b>Paste</b> - lets you cut, copy and paste files using the clipboard. By holding <span class="key">SHIFT</span> while invoking the menu you can <b>Copy/Cut more</b> files, maybe from another folder that you can paste somewhere else later. Also, while holding <span class="key">SHIFT</span> you can paste the copied files in the clipboard as links.</p></li>
<li><p><b>Identify</b> - will sniff out and set the type of a file if it didn't have one before, e.g. if you transferred a file with <span class="cli">wget</span> which doesn't set a filetype itself. Holding <span class="key">SHIFT</span> while invoking the menu changes the item to identify the filetype and correct it if it was false before.</p></li>
<li><p><b>Add-Ons</b> - offers you every generic Tracker add-on and those that can handle the selected file(s). See topic <a href="tracker-add-ons.html">Tracker Add-ons</a> for more information.</p></li>
</ul>
<h2><a id="transaction-status" name="transaction-status">Transaction status</a></h2>

4
docs/userguide/en/twitcher.html
View File

@ -38,8 +38,8 @@
<p>The Twitcher is a task switcher to jump between running applications and their windows.</p>
<img src="../images/twitcher-images/twitcher.png" alt="twitcher.png" width="284" height="96" />
<p>Just tap <tt>CTRL+TAB</tt> quickly to switch between the current and the last application/window. Or press <tt>CTRL+TAB</tt> and hold the <tt>CTRL</tt> key to go through all running applications by repeatedly hitting <tt>TAB</tt> or <tt>CURSOR LEFT/RIGHT</tt>. If you need to get to a specific window of a program, move to its icon as described and then go through its open windows with the <tt>CURSOR UP/DOWN</tt> keys.</p>
<p>It's also possible to invoke the Twitcher with <tt>CTRL+TAB</tt> and then use the mouse to choose the application/window you'll jump to when releasing the <tt>CTRL</tt> key.</p>
<p>Just tap <span class="key">CTRL</span>&#160;<span class="key">TAB</span> quickly to switch between the current and the last application/window. Or press <span class="key">CTRL</span>&#160;<span class="key">TAB</span> and hold the <span class="key">CTRL</span> key to go through all running applications by repeatedly hitting <span class="key">TAB</span> or <span class="key">CURSOR LEFT/RIGHT</span>. If you need to get to a specific window of a program, move to its icon as described and then go through its open windows with the <span class="key">CURSOR UP/DOWN</span> keys.</p>
<p>It's also possible to invoke the Twitcher with <span class="key">CTRL</span>&#160;<span class="key">TAB</span> and then use the mouse to choose the application/window you'll jump to when releasing the <span class="key">CTRL</span> key.</p>
</div>
<!--

60
docs/userguide/en/workshop-filetypes+attributes.html
View File

@ -39,8 +39,8 @@
<p>This is a workshop to show the use of <a href="attributes.html">Attributes</a>, <a href="queries.html">Queries</a>, the <a href="index.html">Index</a> and custom <a href="filetypes.html">Filetypes</a>. As an example, we build a database to keep track of our DVD library.</p>
<h2><a id="preparations" name="preparations">Preparations</a></h2>
<p>Let's first decide what filetype and attributes would serve our needs. Originally, I wanted to use a Bookmark file with a link to the movie's IMdB page, but Haiku doesn't have a "bookmarkable" browser like BeOS' <i>NetPositive</i> at the moment, so I came up with this: The file itself will be a JPEG image for the movie cover.<br />
To that we add a couple of attributes. Here we have to decide if we want to query it later (then we have to add it to the index) and if so, what type of attribute it should be. Numbers (int, float) can be evaluated differently than text (</>/= vs. is/contains/starts with).</p>
<p>Let's first decide what filetype and attributes would serve our needs. Originally, I wanted to use a Bookmark file with a link to the movie's IMdB page, but Haiku doesn't have a "bookmarkable" browser like BeOS' <span class="app">NetPositive</span> at the moment, so I came up with this: The file itself will be a JPEG image for the movie cover.<br />
To that we add a couple of attributes. Here we have to decide if we want to query it later (then we have to add it to the index) and if so, what type of attribute it should be. Numbers (int, float) can be evaluated differently than text (&lt;/=/&gt; vs. is/contains/starts with).</p>
<p>Here's are the attributes I'd like to see for my DVDs:</p>
<ul>
<li>Movie title</li>
@ -54,13 +54,13 @@ To that we add a couple of attributes. Here we have to decide if we want to quer
</ul>
<h2><a id="custom-filetype" name="custom-filetype">Creating a custom filetype</a></h2>
<p>Start the <i>Filetypes</i> preferences, and click on the <i>Add...</i> button below the hierarchical list on the left. A small dialog opens and you specify in which MIME Group your new filetype will reside. You can also create a completely new group. Let's put it into "<i>applications</i>" and set the "Internal Name" to <i>DVDdb</i>.</p>
<p>Start the <span class="app">Filetypes</span> preferences, and click on the <span class="button">Add...</span> button below the hierarchical list on the left. A small dialog opens and you specify in which MIME Group your new filetype will reside. You can also create a completely new group. Let's put it into "<i>applications</i>" and set the "Internal Name" to <i>DVDdb</i>.</p>
<img src="../images/workshop-filetypes+attributes-images/filetypes-new-file-type.png" alt="filetypes-new-file-type.png" width="559" height="432" />
<p>Now, a panel for your new DVDdb filetype opens:</p>
<img src="../images/workshop-filetypes+attributes-images/filetypes-dvddb.png" alt="filetypes-dvddb.png" width="559" height="432" />
<h3><a id="icon" name="icon">Icon</a></h3>
<p>Double-click the icon well to open <i>Icon-O-Matic</i> to design an icon for your filetype. You can also drag&amp;drop an icon from the icon well of another type, maybe as starting point for a modified version.</p>
<p>Double-click the icon well to open <span class="app">Icon-O-Matic</span> to design an icon for your filetype. You can also drag&amp;drop an icon from the icon well of another type, maybe as starting point for a modified version.</p>
<h3><a id="file-recognition" name="file-recognition">File Recognition</a></h3>
<p>You can add suffixes like .txt, .jpg, .mp3 to recognize files by their extention. Useful when working with files from systems without MIME typing. We don't need that for our example.</p>
@ -74,35 +74,35 @@ To that we add a couple of attributes. Here we have to decide if we want to quer
<h3><a id="pref_app" name="pref_app">Preferred Application</a></h3>
<p>This drop-down menu shows a list of all applications that can handle this particular filetype. From here you can choose which program should open this specific file when it's double-clicked.</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
<tr><td><i>Select...</i></td><td>&#160;</td><td>opens a file dialog where you choose the application to open with this filetype. Here, we set <i>Showimage</i> to display the DVD's cover.</td></tr>
<tr><td class="onelinetop"><i>Same as...</i></td><td>&#160;</td><td>opens a file dialog where you choose any file that already has the preferred application set that you're looking for.</td></tr>
<tr><td><span class="button">Select...</span></td><td>&#160;</td><td>opens a file dialog where you choose the application to open with this filetype. Here, we set <span class="app">ShowImage</span> to display the DVD's cover.</td></tr>
<tr><td class="onelinetop"><span class="button">Same as...</span></td><td>&#160;</td><td>opens a file dialog where you choose any file that already has the preferred application set that you're looking for.</td></tr>
</table>
<h3><a id="extra_attribute" name="extra_attribute">Extra Attributes</a></h3>
<p>Here we enter all the custom attributes we decided on in our preparations. Clicking the <i>Add...</i> button opens a panel:</p>
<p>Here we enter all the custom attributes we decided on in our preparations. Clicking the <span class="button">Add...</span> button opens a panel:</p>
<img src="../images/workshop-filetypes+attributes-images/filetype-extra-attribute.png" alt="filetype-extra-attribute.png" width="614" height="447" />
<ul>
<li><p><i>Attribute Name</i> - Appears e.g. as the column heading in Tracker windows.</p></li>
<li><p><i>Internal Name</i> - Is used for indexing and querying the attribute.</p></li>
<li><i>Type</i> - Defines the value the attribute can hold and therefore how it can be queried.<ul>
<li><i>String</i> for normal text</li>
<li><i>Boolean</i> for binary data: 0 or 1</li>
<li><i>Integer</i> for integer numbers with different ranges:<ul>
<li><i>8 bit</i>: +- 255</li>
<li><i>16 bit</i>: +- 65,535</li>
<li><i>32 bit</i>: +- 4,294,967,295</li>
<li><i>64 bit</i>: +- 18,446,744,073,709,551,615</li></ul></li>
<li><i>Float</i> for floatingpoint numbers, single precision</li>
<li><i>Double</i> for floatingpoint numbers, double precision</li>
<li><i>Time</i> for time and date format</li>
<li><span class="menu">String</span> for normal text</li>
<li><span class="menu">Boolean</span> for binary data: 0 or 1</li>
<li><span class="menu">Integer</span> for integer numbers with different ranges:<ul>
<li><span class="menu">8 bit</span>: +- 255</li>
<li><span class="menu">16 bit</span>: +- 65,535</li>
<li><span class="menu">32 bit</span>: +- 4,294,967,295</li>
<li><span class="menu">64 bit</span>: +- 18,446,744,073,709,551,615</li></ul></li>
<li><span class="menu">Float</span> for floatingpoint numbers, single precision</li>
<li><span class="menu">Double</span> for floatingpoint numbers, double precision</li>
<li><span class="menu">Time</span> for time and date format</li>
</ul>
</ul>
<ul>
<li><i>Visible</i> - This checkbox determines if the attribute is visible in a Tracker window at all. Since the Tracker will be the interface to our DVD database, we check it and define its appearance with:<ul>
<li><i>Display As</i> - Leave on "Default". In the future more option will become available, e.g. a bar or stars for a rating etc.</li>
<li><i>Editable</i> - Determines if the attribute shall be editable in Tracker.</li>
<li><i>Width</i> - The default width of that attributes column in a Tracker window.</li>
<li><i>Alignment</i> - The attribute can be displayed left, center, or right aligned.</li>
<li><span class="menu">Display As</span> - Leave on "Default". In the future more option will become available, e.g. a bar or stars for a rating etc.</li>
<li><span class="menu">Editable</span> - Determines if the attribute shall be editable in Tracker.</li>
<li><span class="menu">Width</span> - The default width of that attributes column in a Tracker window.</li>
<li><span class="menu">Alignment</span> - The attribute can be displayed left, center, or right aligned.</li>
</ul></li></ul>
<p>Now, insert all the info for our attributes:</p>
<table summary="DVDdb Attributes" cellpadding="10" border="1">
@ -134,24 +134,24 @@ So, what will we be searching in the future? We probably won't ask "What's in th
mkindex -t string DVDdb:genre
mkindex -t string DVDdb:cast
mkindex -t int DVDdb:rating</pre>
<p>The <tt>-t</tt> option defines the type of attribute, which is "string" for all but the rating, which is an integer number.</p>
<p>The <span class="cli">-t</span> option defines the type of attribute, which is "string" for all but the rating, which is an integer number.</p>
<h2><a id="filling-data" name="filling-data">Filling in the data</a></h2>
<p>Now, everything's set and we can begin putting some data into our base.<br />
Since our basic file is a cover image, we go to some online resource like IMdB, look for our first movie and save the cover or movie poster in a new folder where we want to keep our DVDdb files.</p>
<p>Opening that folder we see a typical Tracker window with one JPEG in it. Right-clicking it, we change its filetype to <tt>application/DVDdb</tt> with the <i>Filetype Addon</i>. There's more info on this in the <a href="filetypes.html">Filetypes</a> document.</p>
<p>Now, we activate all our DVDdb attributes from the <i>Attributes</i> menu of the Tracker window and rearrange the columns to our taste:</p>
<p>Opening that folder we see a typical Tracker window with one JPEG in it. Right-clicking it, we change its filetype to <tt>application/DVDdb</tt> with the <span class="app">Filetype Addon</span>. There's more info on this in the <a href="filetypes.html">Filetypes</a> document.</p>
<p>Now, we activate all our DVDdb attributes from the <span class="menu">Attributes</span> menu of the Tracker window and rearrange the columns to our taste:</p>
<img src="../images/workshop-filetypes+attributes-images/filetypes-dvddb-empty.png" alt="filetypes-dvddb-empty.png" width="861" height="257" />
<p>By clicking on a yet empty attribute (or pressing <tt>ALT+E</tt>) we enter editing mode and fill each attribute. With <tt>TAB</tt> and <tt>SHIFT+TAB</tt> you can navigate between attributes.</p>
<p>In our example, we usually start with a downloaded JPG cover and change its type to applications/DVDdb. There's another elegant way to produce a file to work with. Just copy an empty file of our filetype to <tt>/boot/home/config/settings/Tracker/Tracker New Templates</tt> and rename it to DVDdb.</p>
<p>Right-clicking into a Tracker window, you'll find a new entry under <i>New...</i> besides the default "New folder".</p>
<p>By clicking on a yet empty attribute (or pressing <span class="key">ALT</span>&#160;<span class="key">E</span>) we enter editing mode and fill each attribute. With <span class="key">TAB</span> and <span class="key">SHIFT</span>&#160;<span class="key">TAB</span> you can navigate between attributes.</p>
<p>In our example, we usually start with a downloaded JPG cover and change its type to applications/DVDdb. There's another elegant way to produce a file to work with. Just copy an empty file of our filetype to <span class="path">/boot/home/config/settings/Tracker/Tracker New Templates</span> and rename it to DVDdb.</p>
<p>Right-clicking into a Tracker window, you'll find a new entry under <span class="menu">New...</span> besides the default "New folder".</p>
<h2><a id="query-db" name="query-db">Querying the database</a></h2>
<p>Several hours of grunt work later, we have a nice little database that you can query to find all your Christina Ricci movies that have a 7+ rating... :)</p>
<p>You can assign a sensible attribute layout for query results of a specific filetype.<br />
Open the folder containing your DVDdb files and arrange the attributes how you'd like to have query results presented. Copy this layout with <i>Attributes | Copy Attributes</i>.</p>
<p>Open <tt>/boot/home/config/settings/Tracker/DefaultQueryTemplates</tt>, create a new folder and rename it to <i>group/filetype</i>, replacing slashes with underscores; in our case "applications_DVDdb".</p>
<p>Open the new folder and paste in the layout with <i>Attributes | Paste Attributes</i>. Voilà:</p>
Open the folder containing your DVDdb files and arrange the attributes how you'd like to have query results presented. Copy this layout with <span class="menu">Attributes | Copy Attributes</span>.</p>
<p>Open <span class="path">/boot/home/config/settings/Tracker/DefaultQueryTemplates</span>, create a new folder and rename it to <i>group/filetype</i>, replacing slashes with underscores; in our case "applications_DVDdb".</p>
<p>Open the new folder and paste in the layout with <span class="menu">Attributes | Paste Attributes</span>. Voilà:</p>
<img src="../images/workshop-filetypes+attributes-images/query-dvddb.png" alt="query-dvddb.png" width="757" height="462" />
</div>

16
docs/userguide/en/workspaces.html
View File

@ -40,21 +40,21 @@
<h2><img src="../images/desktop-applets-images/workspaces-icon_64.png" alt="workspaces-icon_64.png" width="64" height="64" /><a name="applet">The Workspaces Applet</a></h2>
<table summary="quickinfo" border="0" cellspacing="0" cellpadding="2">
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>Desktop Applets</i></td></tr>
<tr><td>Location:</td><td></td><td><tt>/boot/beos/apps/Workspaces</tt></td></tr>
<tr><td>Settings:</td><td></td><td><tt>~/config/settings/system/app_server/workspaces</tt><br />
<tt>~/config/settings/Workspaces_settings</tt> - Stores the panel's window position.</td></tr>
<tr><td>Deskbar:</td><td style="width:15px;"></td><td><span class="menu">Desktop Applets</span></td></tr>
<tr><td>Location:</td><td></td><td><span class="path">/boot/beos/apps/Workspaces</span></td></tr>
<tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/system/app_server/workspaces</span><br />
<span class="path">~/config/settings/Workspaces_settings</span> - Stores the panel's window position.</td></tr>
</table>
<p><br /></p>
<img src="../images/workspaces-images/workspaces.png" alt="workspaces.png" width="457" height="230" />
<p>You find the Workspaces applet with the other <i>Desktop Applets</i> in the Deskbar. It shows a miniature version of all workspaces. There are several options available from the context menu of the applet's window, which are all pretty self-explaining. Since the applet is a Replicant, you can resize the window as desired and then drag&amp;drop it by its handle onto the desktop (make sure "<i>Show Replicants</i>" is activated in the Deskbar menu).</p>
<p>You find the Workspaces applet with the other <span class="menu">Desktop Applets</span> in the Deskbar. It shows a miniature version of all workspaces. There are several options available from the context menu of the applet's window, which are all pretty self-explaining. Since the applet is a Replicant, you can resize the window as desired and then drag&amp;drop it by its handle onto the desktop (make sure "<span class="menu">Show Replicants</span>" is activated in the Deskbar menu).</p>
<h2><a id="switching" name="switching">Switching workspaces</a></h2>
<p>You can switch between workspaces by either clicking into the Workspaces applet or by using the keyboard shortcut <tt>ALT+Fx</tt>, where "x" is the workspace number. Also, clicking on an application or one of its windows in the Deskbar will send you to the workspace it's in.</p>
<p>You can switch back and forth between two workspaces with <tt>ALT+~</tt> (which, depending on the keymap you're using, is the key below <tt>ESC</tt>, which you have to hit twice to get a <tt>~</tt>).</p>
<p>You can switch between workspaces by either clicking into the Workspaces applet or by using the keyboard shortcut <span class="key">ALT</span>&#160;<span class="key">Fx</span>, where "x" is the workspace number. Also, clicking on an application or one of its windows in the Deskbar will send you to the workspace it's in.</p>
<p>You can switch back and forth between two workspaces with <span class="key">ALT</span>&#160;<span class="key">~</span> (which, depending on the keymap you're using, is the key below <span class="key">ESC</span>, which you have to hit twice to get a <tt>~</tt>).</p>
<h2><a id="moving" name="moving">Moving windows between workspaces</a></h2>
<p>To move a window, you grab it in the Workspaces applet and simply drag it to another workspace. This has the advantage, that you can move it without leaving your current desktop. Of course, that only works well when there aren't too many windows in a workspace and your target isn't obscured by other windows. Another possibility is to grab a window by its tab and just holding on to it while switching workspaces with <tt>ALT+Fx</tt>.</p>
<p>To move a window, you grab it in the Workspaces applet and simply drag it to another workspace. This has the advantage, that you can move it without leaving your current desktop. Of course, that only works well when there aren't too many windows in a workspace and your target isn't obscured by other windows. Another possibility is to grab a window by its tab and just holding on to it while switching workspaces with <span class="key">ALT</span>&#160;<span class="key">Fx</span>.</p>
</div>

BIN
docs/userguide/images/alert_info_16.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 496 B

BIN
docs/userguide/images/alert_info_32.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.2 KiB

BIN
docs/userguide/images/alert_info_64.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.1 KiB

BIN
docs/userguide/images/alert_stop_16.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 511 B

BIN
docs/userguide/images/alert_stop_32.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

BIN
docs/userguide/images/alert_stop_64.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.9 KiB

BIN
docs/userguide/images/alert_warning_16.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 508 B

BIN
docs/userguide/images/alert_warning_32.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.0 KiB

BIN
docs/userguide/images/alert_warning_64.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.4 KiB

8
docs/welcome/en/bugreports.html
View File

@ -41,12 +41,12 @@ Please follow these guidelines to create helpful bug reports:</p>
<li><p>Mention which revision from <acronym title="Subversion, the source code management system we use">SVN</acronym> you are running. You can find this information in '<i>About This System...</i>' from the Deskbar menu.</p></li>
<li><p>Describe the problem you are experiencing. Try to be as accurate as you can: describe the actual behavior, and the behavior you expected.</p></li>
<li><p>Describe what steps you need to perform in order to expose the bug. This will help developers reproduce the bug.</p></li>
<li><p>Attach as much information as you have. If it is a GUI bug, or a bug in one of the applications, try to make a screen shot (the <tt>PRINT</tt> key files a <acronym title="Portable Network Graphics image format">PNG</acronym> into <tt>/boot/home/</tt>).</p>
<p>If it is a hardware problem, include a copy of the <tt>syslog</tt> file (just query for "<tt>syslog</tt>" to find it).</p>
<p>Also interesting when dealing with hardware issues, is the output of <tt>listdev</tt> and <tt>sysinfo</tt>. This will pipe the output into text files that you can attach to your bugreport or email:</p>
<li><p>Attach as much information as you have. If it is a GUI bug, or a bug in one of the applications, try to make a screen shot (the <span class="key">PRINT</span> key files a <acronym title="Portable Network Graphics image format">PNG</acronym> into <span class="path">/boot/home/</span>).</p>
<p>If it is a hardware problem, include a copy of the <span class="cli">syslog</span> file (just query for "<tt>syslog</tt>" to find it).</p>
<p>Also interesting when dealing with hardware issues, is the output of <span class="cli">listdev</span> and <span class="cli">sysinfo</span>. This will pipe the output into text files that you can attach to your bugreport or email:</p>
<pre class="terminal">listdev > listdev-output.txt
sysinfo > sysinfo-output.txt</pre></li>
<li><p>When an application crashed, you should invoke the debugger from the alert that pops up. Entering "<tt>bt</tt>" into the launched debug Terminal, you create a "backtrace" that you should copy into your bugreport.</p></li>
<li><p>When an application crashed, you should invoke the debugger from the alert that pops up. Entering <span class="cli">bt</span> into the launched debug Terminal, you create a "backtrace" that you should copy into your bugreport.</p></li>
</ul></li>
<li><p>After the bug has been reported, a developer will look at your bug and try to classify it. Remember, we are all volunteers, and as such, sometimes a bug report might go unanswered for a while. Adding new information when it becomes available usually helps getting a bug picked up quicker, but do not try to 'bump' the bug up by adding non-descriptive comments.</p></li>
<li><p>Remember, reporting a bug is not something you spend a little time on and then you are done. If you reported a bug, then you are part of the Haiku development process. Developers might come up with questions while they are trying to fix your bug. Please stay around to answer these. Consider your participation 'done' when the bug is marked as 'fixed'. Together we can improve Haiku, bit by bit.</p></li>

4
docs/welcome/welcome.html
View File

@ -34,7 +34,7 @@
<p>Thank you very much for checking out Haiku! This is our first public release. We hope to attract new developers to our project and give future users a chance to check out Haiku. We realize that this <i>alpha release</i> does not yet fully live up to the goals that we have set for ourselves and doesn't offer all the features and well-rounded end-user experience planned for the final R1 version. However, we hope that this release lets you discover Haiku's great potential and that you share our excitement.</p>
<h2><a id="bugreport" name="bugreport">Beware of Bugs</a></h2>
<p>We were working very hard to fix all possibly show stopping bugs, however, being an alpha release, there are bound to be plenty left undiscovered. We discourage using alpha versions as a production system. <i>Your data could very well be altered, mangled or downright destroyed.</i></p>
<p>We were working very hard to fix all possibly show stopping bugs, however, being an alpha release, there are bound to be plenty left undiscovered. <b>We discourage using alpha versions as a production system. Your data could very well be altered, mangled or downright destroyed.</b></p>
<p>One of the main reasons for releasing an alpha version is to attract more people to test the system and discover bugs or provide suggestions for future enhancements. Please file bugs and enhancements in our bug tracker after using its search function to avoid duplicates.</p>
<ul>
@ -50,7 +50,7 @@
</ul>
<h2><a id="software" name="software">Installing more software</a></h2>
<p>Because of our binary and source compatibility, many BeOS applications run on Haiku. After downloading a package, simply unzip it (double clicking should open <i>Expander</i>) to a folder in <tt>/boot/apps/</tt> and start the application from there.</p>
<p>Because of our binary and source compatibility, many BeOS applications run on Haiku. After downloading a package, simply unzip it (double clicking should open <span class="app">Expander</span>) to a folder in <span class="path">/boot/apps/</span> and start the application from there.</p>
<p>Popular software repositories are:</p>
<ul>