diff options
Diffstat (limited to 'docs/manual/C/xfce4-panel.html')
| -rw-r--r-- | docs/manual/C/xfce4-panel.html | 206 |
1 files changed, 0 insertions, 206 deletions
diff --git a/docs/manual/C/xfce4-panel.html b/docs/manual/C/xfce4-panel.html deleted file mode 100644 index dcfd7f13..00000000 --- a/docs/manual/C/xfce4-panel.html +++ /dev/null @@ -1,206 +0,0 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Xfce 4 Panel</title><link rel="stylesheet" href="../xfce.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="#xfce4-panel" title="Xfce 4 Panel"><link rel="next" href="#panel-intro" title="Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="xfce4-panel"></a>Xfce 4 Panel</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Jasper</span> <span class="surname">Huijsmans</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:jasper@xfce.org">jasper@xfce.org</a>></code></p></div></div></div></div></div><div><span xmlns="http://www.w3.org/TR/xhtml1/transitional" class="releaseinfo"> - This manual describes <strong xmlns="" class="application"><code>xfce4-panel</code></strong> version 4.4.0. - Last updated: December 2006 - <br></br></span></div><div><p class="copyright">Copyright © 2006 Jasper Huijsmans</p></div><div><div class="legalnotice"><a name="legalnotice"></a><p> - This document is provided under the terms of the GNU GPL, version - 2 or (at your option) any later version. - </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#panel-intro">Introduction</a></span></dt><dd><dl><dt><span class="sect2"><a href="#panel-getting-started">Getting Started</a></span></dt><dt><span class="sect2"><a href="#panel-getting-started-mouse">Mouse Actions</a></span></dt><dt><span class="sect2"><a href="#panel-getting-started-configure">Customizing the Panel</a></span></dt></dl></dd><dt><span class="sect1"><a href="#panel-getting-started-items">Panel Items</a></span></dt><dd><dl><dt><span class="sect2"><a href="#launcher-item-dialog">Add New Items</a></span></dt><dt><span class="sect2"><a href="#launcher-item">Launcher</a></span></dt><dt><span class="sect2"><a href="#other-items">Other Items</a></span></dt><dt><span class="sect2"><a href="#xfce-goodies">Xfce Goodies</a></span></dt></dl></dd><dt><span class="sect1"><a href="#panel-manager">Panel Manager</a></span></dt><dd><dl><dt><span class="sect2"><a href="#panel-selector">Select Panel</a></span></dt><dt><span class="sect2"><a href="#panel-appearance">Appearance</a></span></dt><dt><span class="sect2"><a href="#panel-position">Position</a></span></dt><dt><span class="sect2"><a href="#panel-monitor">Select Monitor</a></span></dt></dl></dd><dt><span class="sect1"><a href="#panel-advanced">Advanced Configuration</a></span></dt><dd><dl><dt><span class="sect2"><a href="#panel-config-files">Configuration Files</a></span></dt><dt><span class="sect2"><a href="#panel-data-files">Data Files</a></span></dt><dt><span class="sect2"><a href="#panel-kiosk">Kiosk Mode</a></span></dt></dl></dd><dt><span class="sect1"><a href="#panel-copyright">About <strong class="application"><code>xfce4-panel</code></strong></a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="panel-intro"></a>Introduction</h2></div></div></div><p> - The Xfce 4 panel is part of the <a href="http://www.xfce.org" target="_top">Xfce 4 Desktop Environment</a> and features program - launchers, panel menus, a clock, a graphical pager 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. - </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-getting-started"></a>Getting Started</h3></div></div></div><p> - The panel will usually be started as part of your Xfce session. For - convenience, Xfce provides the <strong class="application"><code>startxfce4</code></strong> - script. The command for the panel is <strong class="application"><code>xfce4-panel</code></strong>. - </p><p> - When you first start the panel you will see a bar appearing at the top - of the screen and a smaller one at the bottom. Both panels are managed - by the same <strong class="application"><code>xfce4-panel</code></strong> program. You can add and remove panels from the - <a href="#panel-manager" target="_top">Panel Manager</a>. - </p><div class="figure"><a name="default-top-panel-fig"></a><p class="title"><b>Figure 1. Default Top Panel</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/default_top_panel.png" alt="The default top panel configuration."></div></div></div></div><br class="figure-break"><div class="figure"><a name="default-bottom-panel-fig"></a><p class="title"><b>Figure 2. Default Bottom Panel</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/default_bottom_panel.png" alt="The default bottom panel configuration."></div></div></div></div><br class="figure-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-getting-started-mouse"></a>Mouse Actions</h3></div></div></div><p> - The Xfce Panel makes extensive use of left and right mouse buttons. Left - clicking performs the default action of an item and right-clicking - brings up a context menu. Ctrl + left click may generally be used as - alternative for a right-click. Note that this manual assumes the use of a - right-handed mouse configuration. - </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-getting-started-configure"></a>Customizing the Panel</h3></div></div></div><p> - Right-clicking on an item will pop up a menu from which you can - configure the item, move it to a new location, or remove it from the - panel. The menu also allows you to configure the panel(s) or add new - items. - </p><div class="figure"><a name="item-popup-fig"></a><p class="title"><b>Figure 3. Item Popup Menu</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/item_popup.png" alt="Popup menu of a launcher item."></div></div></div></div><br class="figure-break"></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="panel-getting-started-items"></a>Panel Items</h2></div></div></div><p> - 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. - </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="launcher-item-dialog"></a>Add New Items</h3></div></div></div><p> - When you choose the 'Add Items' option from the right-click mouse menu of - a panel item, a dialog is opened showing all available panel items. Some - items can appear only once on the panel, e.g. the system tray, and they - will appear greyed out when another instance is already present. A search - box allows you to type a filter term to limit the number of choices in - the list. - </p><div class="figure"><a name="add-item-dialog-fig"></a><p class="title"><b>Figure 4. Add Item Dialog</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/add_item_dialog.png" alt="Dialog with all available panel items."></div></div></div></div><br class="figure-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="launcher-item"></a>Launcher</h3></div></div></div><p>The most common panel item is the launcher item. It allows you to - start programs from the panel. The properties dialog allows you to edit - or add one or more programs. - </p><p> - The first entry in the list is shown on the panel. When more programs - are added they are shown in a menu that can be accessed by clicking the - small arrow button that will appear next to the main launcher icon. - </p><p> - Every item has several options you can edit: name, comment (tooltip), - icon and command. You can select whether the command should be run in a - terminal and whether the program supports startup notification. This - last option allows the window manager to show an hourglass while the - program is loading. - </p><div class="figure"><a name="launcher-fig"></a><p class="title"><b>Figure 5. Launcher Item Properties</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/launcher_properties.png" alt="Shows properties dialog for a launcher item."></div></div></div></div><br class="figure-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="other-items"></a>Other Items</h3></div></div></div><p> - Besides launchers the panel comes with several other items. We will - shortly list them here. As always, the best way to find out if they may - be useful is to try them. - </p><div class="variablelist"><dl><dt><span class="term">Xfce Clock</span></dt><dd><p> - Simple clock item. You can choose between LED, digital and analog - mode. - </p></dd><dt><span class="term">Graphical Pager</span></dt><dd><p> - Shows a miniature view of the workspaces and even allows you to - move windows to another workspace by dragging the mini-window in - the pager. You can change workspaces by using the mouse scroll - wheel when the mouse is over the pager. - </p></dd><dt><span class="term">Task List</span></dt><dd><p> - Shows running applications in a button with icon and application - name. Clicking on the button will focus or minimize the - application. There's also a right-click menu with more window - actions. - </p></dd><dt><span class="term">Window List</span></dt><dd><p> - Shows running applications in a popup menu. Optionally shows - active application on the panel. - </p></dd><dt><span class="term">Icon Box</span></dt><dd><p> - A third alternative to show running applications, in this case - using a button with only an icon. - </p></dd><dt><span class="term">System Tray</span></dt><dd><p> - Allows applications to show a so called notification or status - icon. This is used for example by some media players and instant - messaging clients. - </p></dd><dt><span class="term">Show Desktop Button</span></dt><dd><p> - When clicked it will show the desktop by minimizing all programs. - Clicking again will restore the windows to their previous state. - </p></dd><dt><span class="term">Action Buttons</span></dt><dd><p> - Show one or two small buttons that execute a special system action. - Two actions are available: quit the session and lock the screen. - </p></dd><dt><span class="term">Separator</span></dt><dd><p> - A separator item shows a line or an empty space between two other - items. Can optionally expand to fill all available space; this can - be used on a full width panel to have items on both ends of the - panel and empty space in between. - </p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfce-goodies"></a>Xfce Goodies</h3></div></div></div><p> - Many more plugins for the Xfce Panel are available from the - <a href="http://goodies.xfce.org" target="_top">Xfce Goodies</a> - project. - </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="panel-manager"></a>Panel Manager</h2></div></div></div><p> - The Panel Manager can be opened from the Xfce Settings Manager or from the - right-click menu on one of the panel items. - </p><div class="figure"><a name="panel-manager-fig"></a><p class="title"><b>Figure 6. Panel Manager</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/panel_manager.png" alt="Panel Manager dialog."></div></div></div></div><br class="figure-break"><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-selector"></a>Select Panel</h3></div></div></div><p> - The currently active panel is selected by default or the one that was - last active if there is no active panel. You can choose another panel - from the option menu. Next to this menu are two buttons to add a new - panel or remove the current panel. - </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-appearance"></a>Appearance</h3></div></div></div><div class="variablelist"><dl><dt><span class="term">Size</span></dt><dd><p> - Choose the size in pixels for the panel. This is the height - for horizontal panels and the width for vertical panels. - </p></dd><dt><span class="term">Transparency</span></dt><dd><p> - If your system and the window manager support it, you can set the - transparency level of the panel. You can also choose if you would - like the panel to become fully visible when the mouse moves over - it. - </p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-position"></a>Position</h3></div></div></div><p> - There are two ways to choose the position of a panel: use a fixed - position or make a panel freely moveable. - </p><div class="variablelist"><dl><dt><span class="term">Fixed Position</span></dt><dd><p> - A panel can be placed in one of twelve positions on the edge of - the screen. You can choose whether the panel should be stretched - to fit the entire width or height of the screen. When the autohide - option is selected the panel will collapse to a thin line and - reappear when the mouse is moved over it. - </p></dd><dt><span class="term">Freely Moveable</span></dt><dd><p> - A freely moveable panel has one or two move handles by which you - can drag the panel anywhere on the screen. You can select the - orientation and where to put a move handle (on one or both sides - of the panel). - </p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-monitor"></a>Select Monitor</h3></div></div></div><p> - If you use a Xinerama or multihead setup, you can choose on which - monitor you would like the panel to appear. - </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="panel-advanced"></a>Advanced Configuration</h2></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-config-files"></a>Configuration Files</h3></div></div></div><p> - Xfce uses the Basedir Specification as defined on - <a href="http://freedesktop.org" target="_top">Freedesktop.org</a> 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. - </p><div class="variablelist"><dl><dt><span class="term">${XDG_CONFIG_HOME}</span></dt><dd><p> - The first base directory to look for configuration - files. By default this is set to <code class="filename">~/.config/</code>. - </p></dd><dt><span class="term">${XDG_CONFIG_DIRS}</span></dt><dd><p> - A list of system directories that contain configuration data. By - default the panel will look in <code class="filename">${sysconfdir}/xdg/</code> and - <code class="filename">/etc/xdg/</code>. The value of - ${sysconfdir} depends on how the program was build and will often be - <code class="filename">/etc/</code> for binary packages. - </p></dd><dt><span class="term"><basedir>/xfce4/panel/panels.xml</span></dt><dd><p> - This is the location of the xml configuration file that describes - the contents of the panel, relative to the base directories metioned - above. - </p></dd><dt><span class="term"><basedir>/xfce4/kiosk/kioskrc</span></dt><dd><p> - Kiosk Mode configuration file. See <a href="#panel-kiosk" target="_top">below</a> for an explanation. - </p></dd></dl></div><p> - None of the configuration files, except <code class="filename">kioskrc</code>, are - designed to be edited by hand; in fact the changes will be overwritten if - you edit them while the panel is running. - </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-data-files"></a>Data Files</h3></div></div></div><p> - The Xfce Panel will look under the data directories specified by the - Basedir Specification for data files, such as panel plugin description - files. - </p><div class="variablelist"><dl><dt><span class="term">${XDG_DATA_HOME}</span></dt><dd><p> - The first base directory to look for panel plugin files. By - default this is set to <code class="filename">~/.local/share/</code>. - </p></dd><dt><span class="term">${XDG_DATA_DIRS}</span></dt><dd><p> - A list of system directories that contain data files. By default - this is <code class="filename">/usr/share</code> and - <code class="filename">/usr/local/share</code>. - </p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-kiosk"></a>Kiosk Mode</h3></div></div></div><p> - 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 - <code class="filename">${sysconfdir}/xdg/xfce4/kiosk/kioskrc</code>. - </p><p> - 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: - </p><pre class="programlisting"> -[xfce4-panel] -CustomizePanel=%powerusers,foo -</pre><p> - This allows only users in the group powerusers and the user foo to - customize their panels. - </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="panel-copyright"></a>About <strong class="application"><code>xfce4-panel</code></strong></h2></div></div></div><p> - The maintainers of <strong class="application"><code>xfce4-panel</code></strong> are Jasper Huijsmans - <code class="email"><<a href="mailto:jasper@xfce.org">jasper@xfce.org</a>></code> and Nick Schermer - <code class="email"><<a href="mailto:nick@xfce.org">nick@xfce.org</a>></code>. For more information about Xfce and its - components, visit the - <a href="http://www.xfce.org" target="_top">Xfce web site</a>. - </p><p> - To report a bug or make a suggestion regarding this application or this - manual, please use the bug tracking system at - <a href="http://bugzilla.xfce.org/" target="_top">http://bugzilla.xfce.org/</a>. - </p><p> - If you have questions about the use or installation of this package, please - ask on the - <a href="http://foo-projects.org/mailman/listinfo/xfce" target="_top">xfce</a> mailing list. Development discussion takes - place on the - <a href="http://foo-projects.org/mailman/listinfo/xfce4-dev" target="_top">xfce4-dev</a> mailing list. - </p><p> - <strong class="application"><code>xfce4-panel</code></strong> 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. - </p><p> - 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. - </p></div></div></body></html> |