diff options
author | Jasper Huijsmans <jbhuijsmans@home.nl> | 2005-09-27 19:59:01 +0000 |
---|---|---|
committer | Jasper Huijsmans <jbhuijsmans@home.nl> | 2005-09-27 19:59:01 +0000 |
commit | 6866ad63d86482f3523b4a13c9bc2060bad61c9c (patch) | |
tree | 8b4cf21a55d79966c510b7740222358240b08f61 /doc/C/xfce4-panel.xml | |
parent | 530e87a61474c77856632afc51f6872e42b08f94 (diff) |
Move old trunk4_3_old
(Old svn revision: 17862)
Diffstat (limited to 'doc/C/xfce4-panel.xml')
-rw-r--r-- | doc/C/xfce4-panel.xml | 864 |
1 files changed, 864 insertions, 0 deletions
diff --git a/doc/C/xfce4-panel.xml b/doc/C/xfce4-panel.xml new file mode 100644 index 00000000..95f555cd --- /dev/null +++ b/doc/C/xfce4-panel.xml @@ -0,0 +1,864 @@ +<?xml version='1.0'?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ + <!ENTITY manrevision "1.2"> + <!ENTITY date "November 2004"> + <!ENTITY appversion "4.2"> + <!ENTITY app "<application>xfce4-panel</application>"> +]> + +<article id="xfce4-panel" lang="en"> + +<!-- Header --> +<articleinfo> + + <title>Xfce 4 Panel</title> + + <copyright> + <year>2004</year> <holder>Jasper Huijsmans</holder> + </copyright> + +<!-- translators: uncomment this: + + <copyright> + <year>2002</year> <holder>ME-THE-TRANSLATOR (Latin + translation)</holder> + </copyright> + + --> + +<!-- I don't know about this + <legalnotice id="legalnotice"> + <para> + This document is provided under the terms of the GNU GPL, version + 2 or (at your option) any later version. + </para> + </legalnotice> +--> + <authorgroup> + + <author> + <firstname>Jasper</firstname> <surname>Huijsmans</surname> + <affiliation> + <address><email>jasper@xfce.org</email></address> + </affiliation> + </author> + +<!-- This is appropriate place for other contributors: translators, +maintainers, etc. Commented out by default. + + <othercredit role="translator"> + <firstname>Latin</firstname> <surname>Translator 1</surname> + <affiliation> + <orgname>Latin Translation Team</orgname> + <address><email>translator@gnome.org</email> </address> + </affiliation> <contrib>Latin translation</contrib> + </othercredit> +--> + + </authorgroup> + + <!-- + <revhistory> + <revision> + <revnumber>0.4</revnumber> + <date>May 2003</date> + <authorinitials>jbh</authorinitials> + </revision> + <revision> + <revnumber>0.3</revnumber> + <date>February 2003</date> + <authorinitials>jbh</authorinitials> + </revision> + </revhistory> + --> + + <releaseinfo>This manual describes &app; version &appversion;. + Last updated: &date; + </releaseinfo> + +</articleinfo> + + <!-- extra space --> + <para> </para> + +<sect1 id="panel-intro"> + <title>Introduction</title> + + <para> + The Xfce 4 panel is part of the <ulink url="http://www.xfce.org" + type="html">Xfce 4 Desktop Environment</ulink> and features program + launchers, panel menus, a clock, a desktop switcher and more. Many + aspects of the panel can be configured through graphical dialogs. This + manual should provide you with all necessary information on how to adjust + the panel to your liking. + </para> + +</sect1> + + <!-- extra space --> + <para> </para> + +<sect1 id="panel-getting-started"> + <title>Getting Started</title> + + <para>You will usually start the panel as part of your Xfce session, using + the <application>startxfce4</application> script. The command that will be + run for the panel is &app;. + </para> + + <para> + When you start the panel you will see a bar appearing at the bottom + of your screen, looking like this: + </para> + + <figure id="default-panel-fig"> + <title>Default Xfce panel</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/default_panel.png" format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/default_panel.eps" format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>The Xfce Panel default configuration: several launchers, + a new mail monitor, a clock and a desktop pager; also includes + an opened panel menu. + </phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + <para> + The figure shows the default panel configuration with one open panel + menu. Hovering the mouse over an item will show a tooltip. The Xfce + Panel makes extensive use of left and right mouse buttons. Left clicking + performs the default action of an item, while right-clicking usually + brings up a context menu. Shift + left click may commonly be used + instead of a right-click. Note that this manual assumes the use of a + right-handed mouse. + </para> + + <para>There is a move handle on each side of the panel. You can use it to + drag the panel anywhere on the edges of the screen. Dragging over half + of the screen will move the panel to the opposite screen edge. Clicking + with the right mouse button on one of them shows a popup menu ... + Go on, try it ;-) + </para> + + <figure id="handle-popup-fig"> + <title>Move handle popup menu</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/handle-popup.png" format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/handle-popup.eps" format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>Move handle popup menu.</phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + <para>The area between the move handles contains panel items. The available + items are are described in the + "<ulink url="#panel-items">Panel Items</ulink>" section. Most items + perform an action when clicked. Right-clicking on an item will popup a + menu from which you can open a properties dialog, remove the item or + add a new item. Items can also be added from the right-click menu on one + of the move handles (see above). + </para> + + <figure id="item-popup-fig"> + <title>Item popup menu</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/item-popup.png" format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/item-popup.eps" format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>Item popup menu.</phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + <para>When you want to add an item, a dialog is opened showing all + available panel items. Some items can appear only once in the panel, + e.g. the system tray, and they will appear greyed out when one is + already present. + </para> + + <figure id="add-item-dialog-fig"> + <title>Add item dialog</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/add-item-dialog.png" format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/add-item-dialog.eps" format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>Dialog with available panel items</phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + <para> + Global panel preferences can be changed from the Xfce 4 Settings + Manager, which can be started either from a panel launcher, or by running + <application>xfce-settings-show</application>. + See "<ulink url="#panel-settings">Panel Preferences</ulink>" for an + explanation of the available options. + </para> + +</sect1> + + <!-- extra space --> + <para> </para> + +<sect1 id="panel-items"> + <title>Panel Items</title> + + <para> + The Xfce 4 panel has the possibility to load external plugins as well + as builtin ones. In this section we will only describe panel items that + are installed with the panel. + </para> + + <para> + The properties dialog for a panel item can be opened from the + right-click menu on the item. Each type of panel item has its own + configuration dialog. Every dialog offers at least these options: + </para> + + <itemizedlist> + <listitem>Change the position of the item on the panel.</listitem> + <listitem>Remove the item. </listitem> + <listitem>Close the dialog. </listitem> + </itemizedlist> + + + <sect2 id="launcher-item"> + <title>Launcher</title> + + <para>The most common panel item is the launcher item. It allows you to + start programs from the panel. The properties dialog offers the + following options: + </para> + + <variablelist> + <varlistentry> + <term>Icon</term> + <listitem><para>The icons used by the panel will follow the icon theme + you choose from the + <ulink url="xfce-mcs-plugins.html#ui-settings">user interface + settings dialog</ulink>. Of course you can also choose a custom + icon, either by browsing the file system from the button next + to the entry or by dragging an image on the preview area from + a file manager.</para></listitem> + </varlistentry> + + <varlistentry> + <term>Command</term> + <listitem><para>You can type the command to run or browse the file + system. There is an option to start in a terminal and one to use + startup notification. This last option means that the window manager + can show an hourglass while the program is loading. But, the + application has to support it as well. Programs build with Gtk 2.2 + should support it.</para></listitem> + </varlistentry> + + <varlistentry> + <term>Tooltip</term> + <listitem><para>The panel item will show this tooltip if you hold the + mouse over it.</para></listitem> + </varlistentry> + + <varlistentry> + <term>Menu</term> + <listitem><para>A launcher can have a panel menu attached to it. When + this option is selected a small button with an arrow will appear + next to the item. Look <ulink url="#subpanels">here</ulink> for more + info on panel menus. The position of the menu button can be changed + from the global settings dialog.</para></listitem> + </varlistentry> + </variablelist> + + <figure id="launcher-fig"> + <title>Launcher item</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/launcher-properties.png" + format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/launcher-properties.eps" + format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>Shows properties dialog for launcher item.</phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + + </sect2> + + <sect2 id="clock-item"> + <title>Xfce Clock</title> + + <para>The Xfce Clock has a number of options to change the way it looks. + There are three clock types available: analog, digital and LED. + There is an option to show seconds and for the digital and LED clock + types you can choose whether the clock will be in 24 hour mode, 12 + hour mode, or 12 hour mode with AM/PM indication. The clock shows the + current date as a tooltip. Clicking on the clock will not perform any + action. + </para> + + <figure id="clock-fig"> + <title>Clock item</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/clock-properties.png" + format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/clock-properties.eps" + format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>Shows properties dialog for clock item.</phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + + </sect2> + + <sect2 id="mailcheck-item"> + <title>Mail checker</title> + + <para>The mail checker monitors a mailbox for incoming mail. The + mailbox can be in mbox or Maildir format. + </para> + + <para>The mailbox icon will follow + your icon theme. You can choose the location of the mailbox, the + command to run when you click on the button and the interval between + checks. The command has the same options as the launcher item command + (see <ulink url="#launcher-item" type="html">above</ulink>). + You can also choose a command to run when new mail arrives. + </para> + + <figure id="mailcheck-fig"> + <title>Mail checker item</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/mailcheck-properties.png" + format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/mailcheck-properties.eps" + format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>Shows properties dialog for mail checker item.</phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + <para>For advanced usage you can also provide a remote POP3 mailbox if + you use the following format for the mailbox entry: + <option>pop3://user:password@server:port</option>. If you omit the port + it will default to 110. + </para> + + <para>Note that this feature is still experimental. Before using it, make + sure you have a good network connection, because when the mail check + fails it can block the panel. + </para> + + </sect2> + + <sect2 id="switcher-item"> + <title>Desktop Switcher and Graphical Pager</title> + + <para>The panel provides two items that deal with virtual desktops. A + CDE-like desktop switcher, that shows buttons with the desktop name + and a graphical pager that shows a miniature view of the desktops and + even allows you to move windows to another workspace by dragging the + mini-window in the pager. The graphical pager also allows you to + change workspaces by using the mouse scrollwheel. + </para> + + <para>For the graphical pager you can set the number of rows to use, or + columns when the panel is in vertical mode.</para> + + <figure id="pager-fig"> + <title>Graphical pager</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/pager-properties.png" + format="PNG"/> + </imageobject> + <textobject> + <phrase>Shows properties dialog for the graphical pager. + </phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + </sect2> + + <sect2 id="systembuttons-item"> + <title>System Buttons</title> + + <para>A systembuttons item shows one or two buttons which can perform + special system actions. The buttons follow your panel icon theme. + There are four buttons available:</para> + + <variablelist> + <varlistentry> + <term>Lock</term> + <listitem><para>Runs the <application>xflock4</application> script that + will attempt to lock the screen using either xscreensaver or if + that fails xlock.</para></listitem> + </varlistentry> + <varlistentry> + <term>Exit</term> + <listitem><para>This will popup a logout dialog to end your Xfce + session.</para></listitem> + </varlistentry> + <varlistentry> + <term>Info</term> + <listitem><para>The info button will show the + <emphasis>About Xfce 4</emphasis> dialog.</para></listitem> + </varlistentry> + <varlistentry> + <term>Setup</term> + <listitem><para>Pressing the setup button will open the Xfce settings + manager dialog, from which you have access to the settings for all + Xfce components as well as some system settings, such as mouse + behaviour and user interface settings.</para></listitem> + </varlistentry> + </variablelist> + + <figure id="systembuttons-fig"> + <title>Systembuttons item</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/systembuttons-properties.png" + format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/systembuttons-properties.eps" + format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>Shows properties dialog for systembuttons item. + </phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + + </sect2> + + <sect2 id="separator-item"> + <title>Separator</title> + + <para>This item simply adds a separator line to the panel. It has no + options to set except its position. + </para> + + <para>Note that it may be a bit hard to popup the right-click menu, + because you only have a small area to click on. + </para> + + <figure id="nooptions-fig"> + <title>Item without options</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/nooptions-properties.png" + format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/nooptions-properties.eps" + format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>Shows properties dialog for item without options. + </phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + </sect2> + + <!-- extra space --> + <para> </para> + +</sect1> + +<sect1 id="subpanels"> + <title>Panel Menus</title> + + <para>Panel launcher items can have a menu associated with it, which can + be opened by clicking on the small arrow button next to the item. The + actual position of these popup buttons is configurable from the global + preferences dialog. You can also open the menu by pressing the launcher + button and holding it down. After a short delay the menu will open. + </para> + + <para>Use the 'Add launcher' item at the top of a panel menu to add + a new item or drag an executable to this item from a file manager. + To remove items from a panel menu use the 'Remove' button in the + properties dialog. + </para> + + <para>A special feature of panel menus is that they can be detached from the + panel and live in their own window. To detach a menu click on the small + line at the bottom of the menu (see the <ulink + url="#default-panel-fig">screenshot</ulink> of the default panel). + </para> + + <para>The properties dialog for a menu item is opened immediately + when clicking the right mouse button. The dialog itself is very similar + to the dialog for launcher type panel items. + </para> + + <figure id="menuitem-fig"> + <title>Menu Item</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/menuitem-properties.png" + format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/menuitem-properties.eps" + format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>Shows properties dialog for menu items. + </phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + +</sect1> + + <!-- extra space --> + <para> </para> + +<sect1 id="panel-settings"> + <title>Panel Preferences</title> + + <para>The properties dialog for the Xfce 4 Panel can be opened from + the Xfce 4 Settings Manager or from the right-click menu on one of the + panel move handles. + </para> + + <figure id="panel-settings-fig"> + <title>Panel Settings</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="images/panel-settings.png" + format="PNG"/> + </imageobject> + <!-- + <imageobject> + <imagedata fileref="images/panel-settings.eps" + format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>Shows properties dialog for global panel preferences. + </phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + + <sect2 id="panel-apearance"> + <title>Appearance</title> + + <variablelist> + <varlistentry> + <term>Size</term> + <listitem> + <para>There are four panel sizes available: small, + medium big and huge. Medium is the default. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Orientation</term> + <listitem> + <para>The Xfce 4 Panel can be set to a vertical orientation as well + as the standard horizontal layout. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Popup position</term> + <listitem> + <para>This option change the position of the buttons that open + a panel menu. It can be above, below, to the left or to the + right of their associated panel item. + </para> + </listitem> + </varlistentry> + </variablelist> + + </sect2> + + <sect2 id="panel-behaviour"> + <title>Behaviour</title> + + <variablelist> + + <!-- + <varlistentry> + <term>Always on top</term> + <listitem> + <para>If you choose the always on top option, the panel frame will + always appear above other windows, and maximized windows won't + cover the panel area. + </para> + </listitem> + </varlistentry> + --> + + <varlistentry> + <term>Autohide</term> + <listitem> + <para>If you choose autohide, the panel will collapse to a thin bar. + Moving the mouse over it will unhide the panel. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + +</sect1> + + <!-- extra space --> + <para> </para> + +<sect1 id="panel-advanced"> + <title>Advanced</title> + + <sect2 id="panel-files"> + <title>Files and Environment Variables</title> + + <para>Xfce now uses the Basedir Specification as defined on <ulink + url="http://freedesktop.org">Freedesktop.org</ulink> to locate its + data and configuration files. This means that file locations will + be specified as a path relative to the directories described in + the specification. + </para> + + <variablelist> + <varlistentry> + <term>${XDG_CONFIG_HOME}</term> + <listitem><para>The first base directory to look for configuration + files. By default this is set to <filename + role="directory">~/.config/</filename>.</para></listitem> + </varlistentry> + + <varlistentry> + <term>${XDG_CONFIG_DIRS}</term> + <listitem><para>A list of system directories that contain configuration + data. By default the panel will look in <filename + role="directory">${sysconfdir}/xdg/</filename> and + <filename role="directory">/etc/xdg/</filename>. The value of + ${sysconfdir} depends on how the program was build and will often be + <filename role="directory">/etc/</filename> for binary + packages.</para></listitem> + </varlistentry> + + <varlistentry> + <term><basedir>/xfce4/panel/contents.xml</term> + <listitem><para>This is the location of the xml configuration file + that describes the contents of the panel, relative to the base + directories metioned above.</para></listitem> + </varlistentry> + + <varlistentry> + <term><basedir>/xfce4/mcs_settings/panel.xml</term> + <listitem><para>This is the relative location of the global panel + settings. This file is managed by the settings manager, rather than + by the panel itself.</para></listitem> + </varlistentry> + + <varlistentry> + <term><basedir>/xfce4/kiosk/kioskrc</term> + <listitem><para>Kiosk Mode configuration file. See <ulink + url="#panel-kiosk">next section</ulink> for an explanation. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><basedir>/xfce4/transparency</term> + <listitem> + <para>Transparency configuration. Further explanation is given in + <ulink url="#panel-transparency">this section</ulink> below. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para>None of the configuration files, except + <filename>kioskrc</filename> and <filename>transparency</filename>, are + designed to be edited by hand; in fact the changes will be overwritten + if you edit them while the panel and the settings manager are running. + </para> + + </sect2> + + <sect2 id="panel-kiosk"> + <title>Kiosk Mode</title> + + <para>The panel now has support for Kiosk Mode, that will prevent users + from making changes to their panel configuration. To use it you have to + edit or create the file + <filename>${sysconfdir}/xdg/xfce4/kiosk/kioskrc</filename>. + </para> + + <para>The best way to explain the format of this file is by using an + example. The xfce4-panel section of your kioskrc might look like this: + </para> + +<programlisting> +[xfce4-panel] +CustomizePanel=%powerusers,foo +</programlisting> + + <para>This allows only users in the group powerusers and the user foo to + customize their panels. + </para> + + </sect2> + + <sect2 id="panel-transparency"> + <title>Transparency</title> + + <para>Please, note that transparency only works with an X server that + supports the Composite extension, like XOrg >= 6.8.0 and the + composite extension has been enabled in the configuration file and + the window manager supports it (e.g. + <application>xfwm4</application> has to be compiled with + <option>--enable-compositor</option>). + </para> + + <para>By default the panel will be transparent unless the autohide option + has been set. When the mouse moves over the panel, the transparency will + be temporarily removed. + </para> + + <para>You can create the file + <filename><basedir>/xfce4/transparency</filename> if + you want to change the transparency value for the panel (or + the iconbox). Create the file and add a line with the format + <emphasis><option>panel=<value></option></emphasis>, where + value is a number between 0 and 100. Setting it to 0 effectively turns + transparency off. + </para> + + <para>For example, a transparency file may look like this:</para> + +<programlisting>panel=25 +iconbox=0</programlisting> + + </sect2> + +</sect1> + + <!-- extra space --> + <para> </para> + +<sect1 id="panel-copyright"> + <title>About &app;</title> + + <para>&app; was written by Jasper Huijsmans + (<email>jasper@xfce.org</email>). To find more information, please visit + the <ulink url="http://www.xfce.org" type="http">Xfce web site</ulink>. + </para> + + <para>To report a bug or make a suggestion regarding this application or + this manual, use the bug tracking system at <ulink + url="http://bugzilla.xfce.org/" + type="http">http://bugzilla.xfce.org/</ulink>. + </para> + + <para>If you have questions about the use or installation of this package, + please ask on the <ulink + url="http://lunar-linux.org/mailman/listinfo/xfce" + type="http">xfce</ulink> mailing list. Development discussion takes + place on the <ulink + url="http://lunar-linux.org/mailman/listinfo/xfce4-dev" + type="http">xfce4-dev</ulink> mailing list. + </para> + + <para>&app; is distributed under the terms of the + GNU General Public License as published by the Free Software Foundation; + either version 2 of the License, or (at your option) any later version. + </para> + + <para>You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. + </para> + +</sect1> + +</article> |