Before diving into all the applications that come with Haiku, let's have a more detailed look at how to install and uninstall programs you downloaded somewhere, for example from a site mentioned on the Welcome page.
@@ -137,11 +139,11 @@ Otherwise, uninstalling is simply done by deleting the application's folder.- Contents - - Previous: Workshop - - Next: Desktop Applets + « Workshop + :: + Contents + :: + Desktop Applets »

- Applications - - Next: CDPlayer + Applications + :: + CDPlayer »
ActivityMonitor
-
+
Icons are attributes
Icons are stored as an attribute with their file. However, that doesn't mean that every file has to have this attribute to appear with an icon in a Tracker window: data files inherit their icon from their filetype. To globally change the filetype's icon you use the FileTypes preferences. If you only want to add a special icon to an individual file, you use the FileType Add-On on it instead. See topic Filetypes for more information.
-
+
Creating icons with Icon-O-Matic
Icon-O-Matic is Haiku's icon editor that can save your work as HVIF, SVG or PNG. The icon can also be directly attached as attribute to an existing file or exported as a resource or source file used by developers. Since the application was tailored to the optimized HVIF format, its usage reflects the inner workings of this format.
Other than your normal vector graphics software, you don't deal with separate objects that each include all their specific properties like path, stroke width, stroke and fill color etc. Rather, you assemble your objects ("shapes") from shared paths and colors ("styles") and set certain properties. This re-using of elements is one secret of HVIF's efficiency. Although that imposes some constraints on the icon designer, there are a few advantages, too.
@@ -121,7 +121,7 @@ For example, by re-using a path, several objects can be modified together by man
-
+
Path
A path consists of several points which are connected with lines or Bezier curves. To add or change points, make sure, the path is selected in the path list.
@@ -185,7 +185,7 @@ width="16" height="16" />
-
+
Shape
A shape groups together one or more paths with a style. Practically, it's the object that you'll actually see on the canvas. The grouping is done with the checkboxes in front of the paths and styles: Just select your shape and tick off the desired path(s) and a style.
A shape defines how a path and style is applied, e.g. if the object is filled or only stroked (which is done by using Transformers on the shape, we'll get to that later). Also, a shape can be moved, rotated or resized without touching the used path. That way, you can re-use a single path and get different, but related, shapes.
@@ -259,7 +259,7 @@ For example, if Shape 1 were to be shown below 48px and Shape 2 from 48px upward
-
+
Style
A style can either be a solid color or some type of gradient.
Besides the predefined colors under , you can mix your own by clicking on the current color. Also, note the slider under the color spectrum which sets the alpha-channel (transparency).
-
+
Transformer
A shape can have Transformers which change its appearance. The effects, however, are more subtle than a truck turning into a battle robot...
@@ -300,7 +300,7 @@ Of course you can move these indicators to change the gradient to your liking. Y
-
+
Saving an icon
There's your usual menu bar at the top,
, , . The usage is pretty much self-explaining, so we'll only look at how to save your work.@@ -319,7 +319,7 @@ Of course you can move these indicators to change the gradient to your liking. Y will save in a special Icon-O-Matic format that retains additional information like the names of paths, shapes and styles. These will be stripped from the actual icon once you export it to save space. It's a good idea to back-up your work like this, because without named objects everything's named "<path>/<shape>/<style>" which makes specific changes tedious.
-
+
Tips & Tricks
A few things you should keep in mind when working with Icon-O-Matic and some general tips for its usage:
-
@@ -335,7 +335,7 @@ Of course you can move these indicators to change the gradient to your liking. Y
diff --git a/userguide/en/applications/apps-mediaplayer.html b/userguide/en/applications/apps-mediaplayer.html
index 75675d45..9c5e45d9 100644
--- a/userguide/en/applications/apps-mediaplayer.html
+++ b/userguide/en/applications/apps-mediaplayer.html
@@ -21,16 +21,16 @@
- Type Name - Appears e.g. in the Attribute menu of Tracker windows and the "Kind" attribute of a file. @@ -100,7 +102,7 @@ To that we add a couple of attributes. Here we have to decide if we want to quer

- Applications - - Previous: Mail - - Next: MidiPlayer + « Mail + :: + Applications + :: + MidiPlayer »

- Applications - - Previous: MediaPlayer - - Next: PackageInstaller + « MediaPlayer + :: + Applications + :: + PackageInstaller »

- Applications - - Previous: MidiPlayer - - Next: People + « MidiPlayer + :: + Applications + :: + People »

- Applications - - Previous: BeZilla Browser - - Next: Vision + « BeZilla Browser + :: + Applications + :: + Vision »

- Applications - - Previous: PackageInstaller - - Next: PoorMan + « PackageInstaller + :: + Applications + :: + PoorMan »
- Applications - - Previous: PackageInstaller - - Next: PoorMan + « PackageInstaller + :: + Applications + :: + PoorMan »

- Applications - - Previous: People - - Next: Screenshot + « People + :: + Applications + :: + Screenshot »

- Applications - - Previous: PoorMan - - Next: Showimage + « PoorMan + :: + Applications + :: + Showimage »
- Applications - - Previous: PoorMan - - Next: Showimage + « PoorMan + :: + Applications + :: + Showimage »

- Applications - - Previous: Screenshot - - Next: SoundRecorder + « Screenshot + :: + Applications + :: + SoundRecorder »

- Applications - - Previous: Showimage - - Next: StyledEdit + « Showimage + :: + Applications + :: + StyledEdit »

- Applications - - Previous: SoundRecorder - - Next: Terminal + « SoundRecorder + :: + Applications + :: + Terminal »
- Applications - - Previous: SoundRecorder - - Next: Terminal + « SoundRecorder + :: + Applications + :: + Terminal »

- Applications - - Previous: StyledEdit - - Next: TextSearch + « StyledEdit + :: + Applications + :: + TextSearch »
- Applications - - Previous: StyledEdit - - Next: TextSearch + « StyledEdit + :: + Applications + :: + TextSearch »

- Applications - - Previous: Terminal - - Next: TV + « Terminal + :: + Applications + :: + TV »


- Applications - - Previous: Pe - - Next: VLC media player + « Pe + :: + Applications + :: + VLC media player »

- Applications - - Previous: Vision - - Next: WonderBrush + « Vision + :: + Applications + :: + WonderBrush »

- Applications - - Previous: VLC media player + « VLC media player + :: + Applications

Attributes are data fields that belong to a file but aren't part of that file, e.g. they are not computed into the file size and can be copied or changed without touching the file itself. The system uses these attributes to store e.g. file size, file type or date of the last modification. This is similar to other operating systems and their filesystems.
What's different is that you can add any kind of attribute to any file and display it or make it editable in a Tracker window. You just have to define the kind of attribute you want to add to a file type (e.g. string, integer or time) and give it a name and description.
The file itself doesn't even need any contents at all. Take a look at these People files for example:
@@ -127,11 +129,11 @@ If you do want to copy the attributes plus the data of the file itself, you can diff --git a/userguide/en/bash-scripting.html b/userguide/en/bash-scripting.html index 8c3ca7a2..be868089 100644 --- a/userguide/en/bash-scripting.html +++ b/userguide/en/bash-scripting.html @@ -21,21 +21,23 @@
- Contents - - Previous: Preferences -
"Scripting" is the technique of automating procedures by stringing together commands and saving it all as text files, so called "scripts". Every time you run such a script, the commands are processed one after the other just like they would if you entered them into the Terminal by hand.
Scripts can range from simply executing a few commands in a specific order to sophisticated pieces of code that solve complex tasks.
- Contents - - Previous: Preferences -

- Contents - - Previous: Installing Haiku - - Next: Filesystem layout + « Installing Haiku + :: + Contents + :: + Filesystem layout »
Haiku's Boot Loader can help 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).
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 Disable user add-ons option that's mentioned below, will start Haiku without loading user installed components, e.g. a driver.
To enter the Boot Loader options, you have to press the SPACE BAR right at the beginning of the boot process. It's easy to miss so you best keep hitting the key until it shows up.
@@ -76,11 +78,11 @@ The different symbols roughly correspond to these boot stages:- Contents - - Previous: Installing Haiku - - Next: Filesystem layout + « Installing Haiku + :: + Contents + :: + Filesystem layout »

@@ -32,7 +32,8 @@
Welcome to the Haiku User Guide
+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 bugreport or get in touch on the documentation mailing list.
Index |
@@ -46,12 +45,14 @@ |
The Deskbar is the little panel that by default is located in the upper right corner of the screen. It's Haiku's version of Windows' taskbar with its Start button. It contains the Deskbar menu from where you can start applications and preferences, a tray with a clock and other tools below that and a list of currently running programs at the bottom.

You can move the Deskbar to any corner or as a bar along the upper or lower border of the screen by gripping the knobbly area on the left side of the tray and drag&drop it into the new position. You can also fold it into a more compact layout by drag&dropping the knobbly area onto the Deskbar menu.
-
+
The Deskbar Menu
A menu opens when you click on the Deskbar's top:

-
+
The Tray

Among other things, the tray is housing the clock. Left-click it to toggle between date and time. Right-click it to hide/show it or launch the Time preferences to set it.
@@ -96,7 +97,7 @@ Here you can also launch a calendar that also appears, when you hold down the le
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. ProcessController is another example that uses its icon in the tray to provide information (CPU/memory usage) and to offer a context menu.
-
+
The list of running programs

You can change to a specific running application by clicking on its entry in the Deskbar and choosing (one of) its windows, from the submenu. By right-clicking you can minimize or close a window or the entire application.
@@ -107,11 +108,11 @@ Here you can also launch a calendar that also appears, when you hold down the le- Contents - - Previous: Tracker Add-Ons - - Next: Filetypes + « Tracker Add-Ons + :: + Contents + :: + Filetypes »

- Contents - - Previous: Applications - - Next: Preferences + « Applications + :: + Contents + :: + Preferences »
Haiku provides a few useful tools that can be installed on the Desktop or the Deskbar via their Replicants.
![]() | LaunchBox | @@ -53,11 +55,11 @@ diff --git a/userguide/en/desktop-applets/desktop-applets-launchbox.html b/userguide/en/desktop-applets/desktop-applets-launchbox.html index 43db2770..1af68db0 100644 --- a/userguide/en/desktop-applets/desktop-applets-launchbox.html +++ b/userguide/en/desktop-applets/desktop-applets-launchbox.html @@ -21,14 +21,14 @@ |
![]() | Appearance | @@ -78,16 +79,18 @@ |

- Preferences - - Next: Backgrounds + Preferences + :: + Backgrounds »
- Preferences - - Next: Backgrounds + Preferences + :: + Backgrounds »

- Preferences - - Previous: Appearance - - Next: DataTranslations + « Appearance + :: + Preferences + :: + DataTranslations »
- Preferences - - Previous: Appearance - - Next: DataTranslations + « Appearance + :: + Preferences + :: + DataTranslations »

- Preferences - - Previous: Backgrounds - - Next: E-mail + « Backgrounds + :: + Preferences + :: + E-mail »
- Preferences - - Previous: Backgrounds - - Next: E-mail + « Backgrounds + :: + Preferences + :: + E-mail »

- Preferences - - Previous: DataTranslations - - Next: FileTypes + « DataTranslations + :: + Preferences + :: + FileTypes »
-
+
Creating a new e-mail account
Let's go through the process of setting up an e-mail account.
You start by clicking the button to create a new, unnamed account. This opens a panel where you fill in your account info:
If your account is from a major e-mail provider, Haiku already knows all technical details like server IP addresses and the following information is already filled in automatically. If that is not the case, just follow this guide and fill in the details to your e-mail account accordingly.
-
+
Setting up incoming e-mail
Click on
under your account's name to set up how e-mails are received.
Last on this page, you can opt to only
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.
-
+
Setting up outgoing e-mail
Click on
under your account's name to set up how e-mails are sent.
If you need to login, you change the Login Type to
and enter username and password above. The other type is used for providers that need you to check for mail with for identification.
-
+
Setting up e-mail filters
If you want to filter your incoming email, you click on
Besides the that's used for backward compatibility, there are two other you can add.
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 fortune in a Terminal.
-
+
Setting up the mail_daemon
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.


- Preferences - - Previous: Sounds - - Next: Tracker + « Sounds + :: + Preferences + :: + Tracker »
- Preferences - - Previous: Sounds - - Next: Tracker + « Sounds + :: + Preferences + :: + Tracker »

- Preferences - - Previous: Time - - Next: VirtualMemory + « Time + :: + Preferences + :: + VirtualMemory »
- Preferences - - Previous: Time - - Next: VirtualMemory + « Time + :: + Preferences + :: + VirtualMemory »

- Preferences - - Previous: Tracker + « Tracker + :: + Preferences

A query is a file search based on file attributes and can be performed within Tracker or in Terminal. Queries are saved in /boot/home/queries/ and by default last seven days before being purged. Note, these aren't static result lists of your search, but are the query formulas which trigger a new search whenever you open them.
Even better, you don't have to double-click to re-do a query. You can drill down a saved query just like any folder by right-clicking on it and navigating through the submenus.
-
+
The Find window
You start a query by invoking the ALT F. You're presented with the Find window:
menu either from the Deskbar menu or any Tracker window or the Desktop (which is actually a fullscreen Tracker window). The shortcut is
-
+
Basic queries - "by Name"
If you simply want to find all files on your mounted disks that match a certain pattern, simply leave the search method at "ENTER.
", enter the search term into the text box and press
-
+
Advanced queries - "by Attribute"
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.

This is your Find window when you're looking for all emails Clara Botters has sent to you in the last two months that had in the subject "vibraphone" or "skepticality".
-
+
Even more advanced queries - "by Formula"
Typing in a formula query by hand is daunting and really quite unpractical. It still has its uses.
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 "
@@ -109,7 +111,7 @@ types. " mode and be overwhelmed by this one line query string:
-
+
The result window
After you start a search, the Find window will be replaced by a result window. Here is an example that queried for "server":


With CTRL ALT DEL you invoke the Team Monitor which lists all currently running programs.

Programs that were launched by the system are blue, those started by the user black.
@@ -47,11 +49,11 @@ Applications that are unresponsive, which is often a sign the program has crashe
diff --git a/userguide/en/tracker-add-ons.html b/userguide/en/tracker-add-ons.html
index 76e2844c..b943efab 100644
--- a/userguide/en/tracker-add-ons.html
+++ b/userguide/en/tracker-add-ons.html
@@ -21,21 +21,23 @@

- Contents - - Previous: Tracker - - Next: Keyboard shortcuts + « Tracker + :: + Contents + :: + Keyboard shortcuts »
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
from the context menu or the menu of a Tracker window. Some add-ons don't necessarily need a file to work on and are thus always present.Tracker Add-Ons, or links to applications that can act as add-ons, can be installed in three different locations (see topic Filesystem layout):
The Tracker is the graphical interface to all your files. It let's you create new files and folders or find, launch or rename as well as copy or delete existing ones.
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 Team Monitor.
-
+
Mounting Volumes
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
submenu. You find the same menu in the Deskbar.
-
+
Navigating
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.
You can prevent that by holding down the OPT key, which automatically closes the parent window.
@@ -87,7 +89,7 @@ If you do the above while dragging a file with you, it will be moved to where yo
In the above example, there are many files starting with "Haiku logo", rendering simpler approaches to typing ahead quite useless. In Haiku however, typing "web" jumps right to its first occurence in "Haiku logo - website". The characters you enter appear in the bottom left corner where you normally find the item count of all files in the folder. A second after entering a character, the display jumps back to normal and you're ready for a new type ahead search.
-
+
Appearance

Tracker windows offer three different viewing modes from the
@@ -124,7 +126,7 @@ If you do the above while dragging a file with you, it will be moved to where yo menu:This panel, by the way, is also available as Tracker from Deskbar's .
-
+
Working with files
When invoked on a selected file, most of the
menu commands are also offered in the context menu by right-clicking that file.As usual the commands are pretty clear.
@@ -155,7 +157,7 @@ If you do the above while dragging a file with you, it will be moved to where yo
-
+
Transaction status
When you copy, move or delete files, Tracker shows its progress with a status window. If you initiate more than one transaction, each job gets its own status display.

- Contents - - Previous: Team Monitor - - Next: Tracker Add-Ons + « Team Monitor + :: + Contents + :: + Tracker Add-Ons »

- Contents - - Previous: Workspaces - - Next: Team Monitor + « Workspaces + :: + Contents + :: + Team Monitor »
The Twitcher is a task switcher to jump between running applications and their windows.

Just tap CTRL TAB to switch between the current and the last application/window. Tapping CTRL TAB very quickly will switch between all applications. Or press and hold CTRL TAB to go through all running applications by repeatedly hitting TAB or ←/→. 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 ↑/↓ keys.
@@ -52,11 +54,11 @@ diff --git a/userguide/en/workshop-filetypes+attributes.html b/userguide/en/workshop-filetypes+attributes.html index bc5e62bd..4af379af 100644 --- a/userguide/en/workshop-filetypes+attributes.html +++ b/userguide/en/workshop-filetypes+attributes.html @@ -21,16 +21,16 @@
- Contents - - Previous: Queries - - Next: Applications + « Queries + :: + Contents + :: + Applications »
This is a workshop to show the use of Attributes, Queries, the Index and custom Filetypes. As an example, we build a database to keep track of our DVD library.
-
+
Preparations
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' NetPositive at the moment, so I came up with this: The file itself will be a JPEG image for the movie cover.
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).
-
+
Creating a custom filetype
Start the Filetypes preferences, and click on the 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 "applications" and set the "Internal Name" to DVDdb.


-
+
Icon
Double-click the icon well to open Icon-O-Matic to design an icon for your filetype. You can also drag&drop an icon from the icon well of another type, maybe as starting point for a modified version.
-
+
File Recognition
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.
-
+
Description
-
+
Preferred Application
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.
-
+
Extra Attributes
Here we enter all the custom attributes we decided on in our preparations. Clicking the
button opens a panel:
-
+
Indexing
Before we start entering data in our little DVD database, we should add certain attributes to the Index. Only indexed attributes can use Haiku's fast Queries.
So, what will we be searching in the future? We probably won't ask "What's in the B4 coordinate in my shelf?" or "Does the IMdB URL or the plot of the movie contain the word 'pope-shenooda'?".
The -t option defines the type of attribute, which is "string" for all but the rating, which is an integer number.
-
+
Filling in the data
Now, everything's set and we can begin putting some data into our base.
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.
Right-clicking into a Tracker window, you'll find a new entry under
besides the default "New folder".
-
+
Querying the database
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... :)
You can assign a sensible attribute layout for query results of a specific filetype.
@@ -196,11 +198,11 @@ Open the folder containing your DVDdb files and arrange the attributes how you'd
- Contents - - Previous: Queries - - Next: Applications + « Queries + :: + Contents + :: + Applications »

- Contents - - Previous: Haiku's GUI - - Next: The Twitcher + « Haiku's GUI + :: + Contents + :: + The Twitcher »
Workspaces are virtual desktops, complete with their own resolution, color depth and background. Up to 32 of these workspaces can be set from the Screen preferences.
The Workspaces Applet
@@ -64,7 +66,7 @@ Also, clicking on an application or one of its windows in the Deskbar will send
The Workspaces applet provides some additional functionality when clicking on a window while holding certain modifier keys:
CTRL | Brings the the window to the foreground. | |
CTRLSHIFT | Minimizes the window. | |
CTRL SHIFT | Minimizes the window. | |
OPT | Sends the window to the back. |
- Contents - - Previous: Haiku's GUI - - Next: The Twitcher + « Haiku's GUI + :: + Contents + :: + The Twitcher »

@@ -32,7 +32,8 @@
Welcome to Haiku's User Guide
+If you're interested in helping with a translation, get in touch on the Documentation mailing list.
Right now, the User Guide is available in these languages:
-
diff --git a/welcome/en/bugreports.html b/welcome/en/bugreports.html
index 74634355..40d912c6 100644
--- a/welcome/en/bugreports.html
+++ b/welcome/en/bugreports.html
@@ -21,16 +21,17 @@

Reporting bugs
+Since our developers are unable to test every hardware combination, nor every different way of interacting with the operating system, we are relying on you to give us some input on how things work at your end. Since this is a very early product, it is very likely that you will encounter bugs. We thank you for taking the time to report these.
To keep our bugtracker effective, it's essential to abide by the Bug Tracker Etiquette. Besides, please follow these guidelines to create helpful bug reports:
-
@@ -55,7 +56,7 @@ sysinfo > sysinfo-output.txt
