diff --git a/docs/userguide/bootloader-images/boot-screen.png b/docs/userguide/bootloader-images/boot-screen.png new file mode 100644 index 0000000000..e561d499d7 Binary files /dev/null and b/docs/userguide/bootloader-images/boot-screen.png differ diff --git a/docs/userguide/contents.html b/docs/userguide/contents.html index 5327ce07bc..ffed77be5b 100644 --- a/docs/userguide/contents.html +++ b/docs/userguide/contents.html @@ -23,10 +23,18 @@

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.

- - +
Filesystem layout
+ + + - + + +
Boot LoaderSet safe boot options to solve configuration problems.
Filesystem layout Understand the filesystem hierarchy and get familiar with important file locations and folders.
Haiku's GUI
Haiku's GUI Learn about the basic elements of the graphical user interface.
Workspaces
  • The Workspaces Applet
    • @@ -40,13 +48,17 @@ Below, you'll find the documentation of the most important aspects of Haiku. Nat
Tracker Learn all about navigating, working with files and folders and how to configure Haiku's file manager.
Shortcuts and key combinationsThe most common shortcuts to speed up your workflow.
Deskbar
  • The Deskbar Menu
  • The Tray
    • diff --git a/docs/userguide/deskbar.html b/docs/userguide/deskbar.html index 395d6d7104..2885858ade 100644 --- a/docs/userguide/deskbar.html +++ b/docs/userguide/deskbar.html @@ -64,8 +64,9 @@

    configure.png

    In this panel you set how many recent documents, folders and applications are shown in the Deskbar, or if you show them at all. -

    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. -This part of the panel is just a representation of the folder /boot/home/config/be. You can just as well link or copy files and folders directly in Tracker to configure your Deskbar. +

    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.
    +This part of the panel is just a representation of the folder /boot/home/config/be. You can just as well link or copy files and folders directly in Tracker to configure your Deskbar.
    +Another method is to simply drag a file or folder and drop it where you want it into the Deskbar.

    The Tray

    @@ -76,7 +77,7 @@ Here you can also launch a calendar that also appears, when you hold down the le

    The list of running programs

    -list-of-apps.png.png +list-of-apps.png

    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.

    If you activated Expanders in the Deskbar settings, you can show/hide the list of windows directly under an application's entry.

    In front of every application's windows is a symbol providing info on its state. A bright symbol means a window is visible, a dark one that it's minimized. Three lines in front of a symbol shows that it's not on the current workspace. diff --git a/docs/userguide/filesystem-layout-images/achtung-system.png b/docs/userguide/filesystem-layout-images/achtung-system.png new file mode 100644 index 0000000000..174c15d69f Binary files /dev/null and b/docs/userguide/filesystem-layout-images/achtung-system.png differ diff --git a/docs/userguide/filesystem-layout-images/achtung-user.png b/docs/userguide/filesystem-layout-images/achtung-user.png new file mode 100644 index 0000000000..dd660f65d1 Binary files /dev/null and b/docs/userguide/filesystem-layout-images/achtung-user.png differ diff --git a/docs/userguide/filetypes.html b/docs/userguide/filetypes.html index 2c47f6044c..931b626884 100644 --- a/docs/userguide/filetypes.html +++ b/docs/userguide/filetypes.html @@ -37,8 +37,8 @@

    The Preferred Application

    -

    This dropdown 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.

    -

    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 dropdown menu, you'll again find the buttons Select... and Same As... which do the similar thing described under "The File Type" above.

    +

    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.

    +

    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.

    The Icon

    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 Filetype Add-On of a file that contains an icon and drag&drop it into your file's icon well. Or you double-click the icon well and create or edit your own icon in Icon-O-Matic.

    diff --git a/docs/userguide/gui.html b/docs/userguide/gui.html index 657e851b31..7155869155 100644 --- a/docs/userguide/gui.html +++ b/docs/userguide/gui.html @@ -15,6 +15,8 @@

    Contents     + Previous: Filesystem layout +     Next: Workspaces

    @@ -23,13 +25,9 @@

    Haiku's graphical user interface is an integral part of the system. Unlike Unix-based operating systems, there's no separate window manager and booting just into a command line shell is not possible. Haiku's focus being on the desktop user, this is just not considered necessary.

    As you probably have experience with other graphical environments, let's skip over the standards like menus, right-click context menus, drag&drop etc. Let's have a look at the few unique aspects of Haiku's GUI instead.

    -


    -

    Before we start with that, there's one more thing you'll probably run into quite quickly: By default, Haiku's option key, to invoke commands from menus for example, is not the usual CTRL key, but ALT 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. ALT+C and ALT+V is reached more conveniently on the keyboard and these commands seemlessly integrate into the bash shell of the Terminal. -

    In any case, you can switch to the maybe more familiar CTRL key in the Menu preferences.

    -
    -gui.png


    +gui.png +
    There are only a few things in Haiku's GUI that aren't obvious and deserve an explanation.

    [1] The Deskbar is Haiku's "Start" menu and taskbar, if you will. See topic Deskbar.
    @@ -39,7 +37,34 @@ There are only a few things in Haiku's GUI that aren't obvious and deserve an ex [3] The close button.
    [4] The "alternative size" button (expands window to full screen in most applications).
    [5] The resize button. Dragging anywhere else on a window's border will move the window.
    -

    That's pretty much all there is to Haiku's GUI widgets in general. You'll find more information in Getting to know the system. +

    + +

    Open and save panels

    +

    When opening or saving a file from any application, a panel like this opens:

    +open-save.png +
    +

    It has all the usual things: A list of files of the current folder to choose from, in case of a save panel, a text field to enter a filename and a drop-down menu for different file formats and their settings.
    +You can enter parent folders with the drop-down menu above the file listing. +

    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. +

    + +

    Keyboard shortcuts

    +

    You can use many of the shortcuts also used in Tracker. Besides the commands that are also available through the File menu, there are a few not that obvious: +

    + + + + +
    ALT+CURSOR-UP Open parent folder.
    ALT+CURSOR-DOWN or RETURN Open selected folder.
    ALT+D Takes you to your Desktop.
    ALT+H Takes you to your Home folder.
    +

    + +

    Favorites and recent folders

    +

    +The menu Favorites 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.

    +favorites.png +
    +

    To add a Favorite, you simply navigate to your destination and choose Favorites | Add Current Folder. From now on it will appear in every open/save panel. To remove a Favorite, choose Favorites | Configure Favorites... and delete its entry.
    +All Favorites are kept in /boot/home/config/settings/Tracker/Go/. So you might as well add and remove links to files and folders there directly.

    @@ -48,6 +73,8 @@ There are only a few things in Haiku's GUI that aren't obvious and deserve an ex

    Contents     + Previous: Filesystem layout +     Next: Workspaces

    diff --git a/docs/userguide/queries.html b/docs/userguide/queries.html index df55a385e5..12a5b93758 100644 --- a/docs/userguide/queries.html +++ b/docs/userguide/queries.html @@ -60,11 +60,11 @@ types.
    query-window.png

    You start by setting the filetype from "All files and folders" to "text | E-mail" and change the search method to "by Attribute. -

    This adds a dropdown menu to the left of the textbox and the buttons "Add and Remove under that. From the menu you choose which attribute to query. With "Add and Remove you can query additional attributes or remove them again. These attributes can be logically linked with AND/OR. +

    This adds a drop-down menu to the left of the textbox and the buttons "Add and Remove under that. From the menu you choose which attribute to query. With "Add and Remove you can query additional attributes or remove them again. These attributes can be logically linked with AND/OR.

    Let's do an email query as an example:

    -query-winsow-filled.png +query-window-filled.png

    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".

    @@ -86,20 +86,19 @@ types.

    What's the use?

    • You could copy and paste the string into an email, forum or IRC for others to use or debug.
      • -
    • You can use this method to construct a query in "Attribute mode and then switch to "Formula mode, to comfortably generate a search string to use for a query in Terminal or a script.
      • -
    • You can fine tune your query by inserting paranthesis where needed, make parts case-sensitive or negate logical combinations by changing. e.g. "==" to "!=" for a NOT AND. All you need is a basic understanding of regular expressions and maybe some scripting basics.
      • +
    • You can use this method to construct a query in Attribute mode and then switch to Formula mode, to comfortably generate a search string to use for a query in Terminal or a script.
      • +
    • You can fine tune your query by inserting parenthesis where needed, make parts case-sensitive or negate logical combinations by changing. e.g. "==" to "!=" for a NOT AND. All you need is a basic understanding of regular expressions and maybe some scripting basics.

    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":

    result-window.png -

    Besides the grey backgound, result windows work exactly like any other Tracker window. Some things are worth noting: +

    Besides the grey background, result windows work exactly like any other Tracker window. Some things are worth noting:

    • You can open the folder a file resides in by double clicking on its path attribute.
    • With File | Edit Query or ALT+G you get back to your Find window to refine your query.
      • -
    • 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 resuls in -realtime. +
    • 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.

    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 Attributes | Copy Attributes.

    Open /boot/home/config/settings/Tracker/DefaultQueryTemplates, create a new folder and rename it to group/filetype, replacing slashes with underscores, e.g."audio_x-mp3". diff --git a/docs/userguide/teammonitor.html b/docs/userguide/teammonitor.html index 6ca1b304d6..f3e9899171 100644 --- a/docs/userguide/teammonitor.html +++ b/docs/userguide/teammonitor.html @@ -28,6 +28,7 @@

    Programs that were launched by the system are blue, those started by the user black.
    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 Kill Application button. +

    You can summon a Terminal with ALT+SHIFT+T.

    If your Tracker or Deskbar crashed or froze, a new button appears (you may have to kill the offending team first): Restart the Desktop will restart Tracker and/or Deskbar for you.

    diff --git a/docs/userguide/tracker-add-ons.html b/docs/userguide/tracker-add-ons.html index 54cc50f57e..0122d0e84e 100644 --- a/docs/userguide/tracker-add-ons.html +++ b/docs/userguide/tracker-add-ons.html @@ -17,7 +17,7 @@     Previous: Tracker     - Next: Deskbar + Next: Keyboard shortcuts

    @@ -62,7 +62,7 @@ Of course, you have to take care of possible shortcut collisions when deciding o     Previous: Tracker     - Next: Deskbar + Next: Keyboard shortcuts

    diff --git a/docs/userguide/tracker.html b/docs/userguide/tracker.html index c77030e4d0..857687ea51 100644 --- a/docs/userguide/tracker.html +++ b/docs/userguide/tracker.html @@ -32,7 +32,7 @@

    drill-down.png
    -

    There are also Mount Settings so you don't have to mount everything manually after every bootup.
    +

    There are also Mount Settings so you don't have to mount everything manually after every bootup.
    The above settings will mount all disks on bootup that were mounted previously and will automatically mount any storage device you connect/insert.

    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!     @@ -44,25 +44,20 @@ The above settings will mount all disks on bootup that were mounted previously a

    drill-down.png
    -

    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 /boot/beos/system/. +

    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 /boot/beos/system/.

    A similar method can be used from any Tracker window:

    window-drill-down.png
    -

    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. +

    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.

    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.


    +

    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. +


    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 left WIN key, which automatically closes the parent window.
    -This is also true for keyboard navigation.

    -

    Keyboard navigation

    -

    A few shortcuts are essential: -

    • ALT+CURSOR-UP - Open parent folder.
      • -
    • ALT+CURSOR-DOWN or RETURN - Open selected folder.
      • -
    • ALT+W - Close window.
      • -
    • ALT+ESC - Enter menu bar (leave with ESC).
      • -
    • right MENU-KEY - Open Deskbar menu (leave with ESC).
    +This is also true for keyboard navigation. For more on that, see topic Shortcuts and key combinations.

    Appearance

    @@ -71,7 +66,7 @@ This is also true for keyboard navigation.

    Tracker windows offer three different viewing modes from the Window menu:

    • Icon View (ALT+1) - Big icons, you can change the size from the submenu.
    • Mini Icon View (ALT+2) - Small icons.
      • -
    • List View (ALT+3) - A detailed list of your files enabling you to show/hide available attributes. (See topic File Attributes.)
    +
  • List View (ALT+3) - A detailed list of your files enabling you to show/hide available attributes. (See topic Attributes.)

The Window menu offers a number of other functions:

  • Resize Window (ALT+Y) - Resizes the window to its ideal size.
  • Clean Up (ALT+K) - Aligns all icons to an invisible grid. Hold down SHIFT and the menu becomes Clean Up All which additionally sorts all icons alphabetically.
    • @@ -87,8 +82,8 @@ This is also true for keyboard navigation.

  • Windows - You can set Single Window Navigation, 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 WIN key, as described above, because you'll lose the per window saved position and size.

    tracker-preferences-navigator.png -

    -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 Navigator where you can enter or copy&paste a path name and use back, forward and up buttons.

    • +
    +

    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 Navigator where you can enter or copy&paste a path name and use back, forward and up buttons.

  • Date and Time - Set date and time formats.
  • Trash - Set the behaviour when deleting a file.
  • Volume Icons - Set the colour of an optional indicator of free space that's shown besides a disk's icon.
    • @@ -102,10 +97,12 @@ Before you switch Tracker to Single Window Navigation mode, because that may fee
  • New... - Create a new folder or any other file based on a template.

    new-menu.png +

    Choosing Edit Templates... opens the folder /boot/home/config/settings/Tracker/Tracker New Templates. Creating a file in that folder will offer its filetype with the file's name and other attributes as template in the New... menu. Here, there's a file "Text" with the filetype text/plain. See topic Filetypes for more info.

  • Open With... - A submenu offers all applications that can handle this filetype.

    open-with.png +

    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 text/plain. Next come all applications that can handle that supertype in general, here text/*. 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 Open With... entry instead, a panel opens:

    open-with-preferred @@ -118,7 +115,7 @@ Before you switch Tracker to Single Window Navigation mode, because that may fee

  • Edit Name, Duplicate and Move to Trash - lets you rename or duplicate a file or put the selected file(s) to the trash.
  • Move to, Copy to and Create Link - lets you move, copy or link the selected file(s) using the submenu navigating method. Holding SHIFT while invoking the menu offers the option to create a relative link.
  • Cut, Copy and Paste - lets you cut, copy and paste files using the clipboard. By holding SHIFT while invoking the menu you can Copy/Cut more files, maybe from another folder that you can paste somewhere else later. Also, while holding SHIFT you can paste the copied files in the clipboard as links.
    • -
  • Identify - will sniff out and set the type of a file if it didn't have one before, e.g. if you transfered a file with wget which doesn't set a filetype itself. Holding SHIFT while invoking the menu changes the item to identify the filetype and correct it if it was false before.
    • +
  • Identify - 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 wget which doesn't set a filetype itself. Holding SHIFT while invoking the menu changes the item to identify the filetype and correct it if it was false before.
  • Add-Ons - offers you every generic Tracker add-on and those that can handle the selected file(s). See topic Tracker Add-ons for more information.

@@ -127,7 +124,7 @@ Before you switch Tracker to Single Window Navigation mode, because that may fee


-

To the right are two buttons to pause or stop a transaction entirely. Sometimes it can be useful to temporarily pause a large transaction. For example, you may need to quickly launch a large application. Copying large amounts of data chokes your harddisk’s IO bandwidth and thus delays your workflow. +

To the right are two buttons to pause or stop a transaction entirely. Sometimes it can be useful to temporarily pause a large transaction. For example, you may need to quickly launch a large application. Copying large amounts of data chokes your harddisk's IO bandwidth and thus delays your workflow.

diff --git a/docs/userguide/workshop-filetypes+attributes.html b/docs/userguide/workshop-filetypes+attributes.html index 65d9fcd3ff..5bb678b526 100644 --- a/docs/userguide/workshop-filetypes+attributes.html +++ b/docs/userguide/workshop-filetypes+attributes.html @@ -67,7 +67,7 @@ To that we add a couple of attributes. Here we have to decide if we want to quer

Preferred Application

-

This dropdown 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. +

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.

Select... opens a file dialog where you choose the application to open with this filetype. Here, we set Showimage to display the DVD's cover. Same as... opens a file dialog where you choose any file that already has the preferred application set that you're looking for. diff --git a/docs/userguide/workspaces.html b/docs/userguide/workspaces.html index cf8315656b..fb26e4b39a 100644 --- a/docs/userguide/workspaces.html +++ b/docs/userguide/workspaces.html @@ -28,14 +28,16 @@

The Workspaces Applet

workspaces.png -

You find the Workspaces applet with the other Desktop Applets 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&drop it by its handle onto the desktop (make sure "Show Replicants" is activated in the Deskbar menu).

+

You find the Workspaces applet with the other Desktop Applets 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&drop it by its handle onto the desktop (make sure "Show Replicants" is activated in the Deskbar menu). +

Switching workspaces

You can switch between workspaces by either clicking into the Workspaces applet or by using the keyboard shortcut ALT+Fx, 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. +

You can switch back and forth between two workspaces with ALT+~ (which, depending on the keymap you're using, is the key below ESC, which you have to hit twice to get a ~).

Moving windows between workspaces

-

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 on 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 ALT+Fx. +

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 ALT+Fx.