Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision |
start [2014/03/14 11:01] – [Getting Started] nick | start [2023/02/04 03:09] – kevinbowen |
---|
~~NOTOC~~ | ~~NOTOC~~ |
| {{ :xfce-64x64.png?nolink|}} |
| ====== Xfce 4.18 Documentation ====== |
| |
====== Xfce Docs ====== | This website provides user documentation for the latest stable version of the Xfce desktop environment. Go to [[..:4.16:|Xfce 4.16]] for the previous version. |
| |
<note>The manuals on this website are written for the latest stable release of the module. At this moment this means the manuals apply to Xfce 4.8 and 4.10.</note> | * **[[#Core Modules|Core Modules]]** |
| * **[[#Applications|Applications]]** |
| * **[[#External Plugins|External Plugins]]** |
| |
| ---- |
| |
<note warning>The documentation on this website is still a "[[contribute:documentation|work in progress]]".</note> | |
===== Getting Started ===== | ===== Getting Started ===== |
| |
[[xfce:getting-started|Starting with Xfce]]\\ | * **[[xfce:getting-started|Getting Started with Xfce]]** -- Starting point for anyone who wants to use Xfce |
This document gives an overview of the Xfce Desktop Environment and explains how to perform several common tasks. It is meant to be a starting point for anyone who wants to use Xfce and it includes pointers to other sources of information. | * **[[:faq|Frequently Asked Questions]]** -- General questions relating to Xfce and their answers |
| * **[[xfce:building|Building Xfce]]** -- Instructions on how to compile Xfce from source |
[[xfce:building|Building Xfce]]\\ | * **[[contribute:|How to Contribute]]** -- Detailed information for new contributors |
It is always recommended to use the packages provided by your distribution, however if you have special needs or you want a detailed description on compiling Xfce yourself, you can find it in this article. | * **[[:contribute:bugs:start:|Bug Reporting and Fixing]]** |
| |
[[/start?do=index|Sitemap]]\\ | |
The sitemap of this wiki gives a good overview of the pages available. | |
| |
[[faq|Frequently Asked Question]]\\ | |
Tips and tricks that apply to all Xfce (and GTK+) applications. | |
| |
[[contribute:|How to contribute]]\\ | |
Detailed information for new contributors can be found in this section. A more general introduction can be found at the [[http://www.xfce.org/getinvolved|Get Involved]] page on the main website. | |
| |
===== Core Modules ===== | ---- |
| |
[[xfce:xfce4-appfinder:|Application Finder (xfce4-appfinder)]]\\ | ===== Documentation for Xfce Applications ===== |
Application to quickly run applications and commands. | |
| |
[[xfce:xfdesktop:|Desktop Manager (xfdesktop)]] ([[[xfce:xfdesktop:4.11:|4.11]])\\ | ==== Core Modules ==== |
Sets the background color or image with optional application menu or icons for minimized applications or launchers, devices and folders. | |
| |
[[xfce:exo:|Helper Applications]]\\ | * **[[xfce:xfce4-appfinder:|Application Finder (xfce4-appfinder)]]** -- Application to quickly run applications and commands |
Manage preferred applications and edit .desktop files. | * **[[xfce:xfconf:|Configuration Storage System (xfconf)]]** -- D-Bus-based configuration storage system |
| * **[[xfce:xfdesktop:|Desktop Manager (xfdesktop)]]** -- Configure the desktop background image, icons, launchers and folders |
| * **[[xfce:xfce4-dev-tools:|Development Tools (xfce4-dev-tools)]]** -- A set of scripts and m4/autoconf macros that ease build system maintenance. |
| * **[[xfce:exo:|Helper Applications (exo)]]** -- Manage preferred applications and edit .desktop files |
| * **[[xfce:thunar:|File Manager (thunar)]]** -- The fast and easy to use file manager for the Xfce Desktop |
| * **[[xfce:garcon:|Menu Library (garcon)]]** -- Library used for menu implementation |
| * **[[xfce:xfce4-panel:|Panel (xfce4-panel)]]** -- Application launchers, window buttons, applications menu, workspace switcher and more |
| * **[[xfce:xfce4-power-manager:|Power Manager (xfce4-power-manager)]]** -- Manage power sources and power consumption of devices |
| * **[[xfce:xfce4-session:|Session Manager (xfce4-session)]]** -- Save the state of your desktop and restore it on the next startup |
| * **[[xfce:xfce4-settings:|Settings Manager (xfce4-settings)]]** -- The Settings daemon which persists many Xfce settings |
| * **[[xfce:tumbler:|Thumbnail Service (tumbler)]]** -- A D-Bus service for applications to request thumbnails for various URI schemes and MIME types |
| * **[[xfce:libxfce4util:|Utility Sharing Library (libxfce4util)]]** -- Library used to share commonly used non-GTK+ utilities among the Xfce applications |
| * **[[xfce:libxfce4ui:|Widget Sharing Library (libxfce4ui)]]** -- Used to share commonly used Xfce widgets among the Xfce applications |
| * **[[xfce:libxfce4windowing:|Widget Abstraction Library for X11 & Wayland (libxfce4windowing)]]** -- Used to present windowing concepts (screens, toplevel windows, workspaces, etc.) in a windowing-system-independent manner. |
| * **[[xfce:thunar:thunar-volman|Volume Manager (thunar-volman)]]** -- Automatic management of removable devices in Thunar |
| * **[[xfce:xfwm4:|Window Manager (xfwm4)]]** -- Handles the placement of windows on the screen |
| |
[[xfce:thunar:|File Manager (thunar)]]\\ | [[|Back to Top]] |
The fast and easy to use file manager for the Xfce Desktop. | |
| |
[[xfce:xfce4-panel:|Panel (xfce4-panel)]]\\ | ---- |
Program launchers, window buttons, applications menu, workspace switcher and more. | |
| |
[[xfce:xfce4-power-manager:|Power Manager (xfce4-power-manager)]]\\ | ==== Applications ==== |
Manages the power sources on the computer and the devices that can be controlled to reduce their power consumption. | |
| |
[[xfce:xfce4-session:|Session Manager (xfce4-session)]]\\ | * **[[apps:orage:| Calendar application (orage)]]** -- A fast and easy to use graphical time-managing application |
Save the state of your desktop and restore it on the next startup. | * **[[apps:xfburn:|CD Burning application (Xfburn)]]** -- A simple CD/DVD burning tool. |
| * **[[apps:xfce4-dict:|Dictionary (xfce4-dict)]]** -- allows you to search different kinds of dictionary services for words or phrases and shows you the results |
| * **[[apps:catfish:|File Search Utility (catfish)]]** -- a versatile file search utility for the Xfce desktop |
| * **[[apps:ristretto:|Image Viewer (ristretto)]]** -- Image viewer for the Xfce desktop |
| * **[[apps:parole:|Media player (parole)]]** -- Media player for the Xfce desktop |
| * **[[apps:xfmpc:|Music Player Daemon (xfmpc)]]** -- A graphical GTK+ Music Player Daemon (MPD) client focusing on low footprint |
| * **[[apps:notifyd:|Notification service (xfce4-notifyd)]]** -- Notification service for the Xfce desktop |
| * **[[apps:gigolo:|Remote filesystem Utility (gigolo)]]** -- A frontend to easily manage connections to remote filesystems. |
| * **[[apps:xfce4-panel-profiles:|Panel Profiles (xfce4-panel-profiles)]]** -- A simple application to manage Xfce panel layouts |
| * **[[apps:screensaver:|Screensaver Utility (xfce4-screensaver)]]** -- A simple, secure screen saver and locker. |
| * **[[apps:xfce4-screenshooter:|Screenshot application (xfce4-screenshooter)]]** -- Take screenshots of your Xfce desktop |
| * **[[apps:xfce4-taskmanager:|Taskmanager(xfce4-taskmanager)]]** -- Easy to use task manager |
| * **[[apps:xfce4-terminal:|Terminal Emulator (xfce4-terminal)]]** -- Terminal emulator for the Xfce desktop |
| * **[[apps:mousepad:|Text Editor (mousepad)]]** -- A simple text editor for Xfce |
| * **[[apps:xfce4-mixer:|Volume Control & Mixer (xfce4-mixer)]]** -- A volume control application based on GStreamer & panel-plugin |
| * **[[apps:xfdashboard:|Xfdashboard]]** -- Provides a Gnome shell-like dashboard for Xfce |
| |
[[xfce:xfce4-settings:|Settings Manager (xfce4-settings)]]\\ | [[|Back to Top]] |
The settings daemon and the settings dialogs. This includes the accessibility, appearance, display, keyboard and mouse settings. | |
| |
[[xfce:xfwm4:|Window Manager (xfwm4)]]\\ | ---- |
Handles the placement of windows on the screen. | |
| |
[[xfce:xfconf:|Configuration Storage System (xfconf)]]\\ | ==== External Plugins ==== |
D-Bus-based configuration storage system. | * **[[:panel-plugins:xfce4-battery-plugin:start|Battery]]** -- A battery monitor panel plugin for Xfce4 compatible with APM and ACPI, for Linux and *BSD. |
===== Applications ===== | * **[[:panel-plugins:xfce4-calculator-plugin:start|Calculator]]** -- a calculator plugin for the Xfce4 panel. |
| * **[[:panel-plugins:xfce4-clipman-plugin:start|Clipman]]** -- A clipboard manager for Xfce |
| * **[[:panel-plugins:xfce4-cpufreq-plugin:start|Cpufreq]]** -- shows information about the CPU governor and frequencies supported and used by your system. |
| * **[[:panel-plugins:xfce4-cpugraph-plugin:start|Cpugraph]]** -- offers multiple display modes (LED, gradient, fire, etc…) to show the current CPU load of the system. |
| * **[[:panel-plugins:xfce4-datetime-plugin:start|Datetime]]** -- shows the date and time in the panel, and a calendar appears when you left-click on it. |
| * **[[:panel-plugins:xfce4-diskperf-plugin:start|Diskperf]]** -- displays instant disk/partition performance (bytes transferred per second). |
| * **[[:panel-plugins:xfce4-docklike-plugin:start|Docklike]]** -- A modern, minimalist taskbar for Xfce. |
| * **[[:panel-plugins:xfce4-embed-plugin:start|Embed]]** -- Embed arbitrary application windows into the panel. |
| * **[[:panel-plugins:xfce4-eyes-plugin:start|Eyes]]** -- Eyes that spy on you. |
| * **[[:panel-plugins:xfce4-fsguard-plugin:start|Fsguard]]** -- checks the chosen mountpoint for free disk space. |
| * **[[:panel-plugins:xfce4-genmon-plugin:start|Genmon]]** -- spawns the indicated script/program, captures its output (stdout) and displays the resulting string into the panel. |
| * **[[:panel-plugins:xfce4-indicator-plugin:start|Indicator]]** -- small plugin written by Mark Trompell to display information from various applications consistently. |
| * **[[:panel-plugins:xfce4-mailwatch-plugin:start|Mailwatch]]** -- multi-threaded, multi-mailbox, multi-protocol plugin for checking mails periodically. |
| * **[[:panel-plugins:xfce4-mount-plugin:start|Mount]]** -- a mount/umount utility for the panel. |
| * **[[:panel-plugins:xfce4-mpc-plugin:start|Mpc]]** -- client plugin for MPD, the Music Player Daemon |
| * **[[:panel-plugins:xfce4-netload-plugin:start|Netload]]** -- displays the current load of the network interfaces, currently works on Linux, *BSD, Sun Solaris, HP_UX and MacOS X. |
| * **[[:panel-plugins:xfce4-notes-plugin:start|Notes]]** -- provides sticky notes for your desktop. |
| * **[[:panel-plugins:xfce4-places-plugin:start|Places]]** -- a menu with quick access to folders, documents, and removable media. |
| * **[[:panel-plugins:xfce4-pulseaudio-plugin:start|PulseAudio Plugin]]** -- Adjust audio volume and control media players on the Xfce desktop |
| * **[[:panel-plugins:xfce4-sample-plugin:start|Sample]]** -- Sample plugin developers can use as a base for new panel-plugins |
| * **[[:panel-plugins:xfce4-sensors-plugin:start|Sensors]]** -- a hardware sensors plugin for the panel. |
| * **[[:panel-plugins:xfce4-smartbookmark-plugin:start|Smartbookmark]]** -- allows you to do a search directly on Internet on sites like google or debian bugzilla. |
| * **[[:panel-plugins:xfce4-statusnotifier-plugin:start|Statusnotifier]]** -- provides a panel area for status notifier items (application indicators). |
| * **[[:panel-plugins:xfce4-stopwatch-plugin:start|Stopwatch]]** -- Keep track of elapsed time. |
| * **[[:panel-plugins:xfce4-systemload-plugin:start|Systemload]]** -- Displays the current CPU load, the memory in use, the swap space and the system uptime. |
| * **[[:panel-plugins:xfce4-timer-plugin:start|Timer]]** -- Lets the user run an alarm at a specified time or at the end of a specified countdown period. |
| * **[[:panel-plugins:xfce4-time-out-plugin:start|Time-out]]** -- for taking breaks from the computer every X minutes. |
| * **[[:panel-plugins:xfce4-verve-plugin:start|Verve]]** -- A comfortable command line plugin for the Xfce panel. |
| * **[[:panel-plugins:xfce4-wavelan-plugin:start|Wavelan]]** -- Display stats from a wireless lan interface (signal state, signal quality, network name (SSID)). It supports NetBSD, OpenBSD, FreeBSD, and Linux. |
| * **[[:panel-plugins:xfce4-weather-plugin:start|Weather]]** -- Shows the current temperature and weather condition, using weather data provided by xoap.weather.com. |
| * **[[:panel-plugins:xfce4-whiskermenu-plugin:start|Whiskermenu]]** -- A menu that provides access to favorites, recently used, and searching installed applications. |
| * **[[:panel-plugins:xfce4-windowck-plugin:start|Windowck]]** -- Place the maximized window title and windows buttons on the panel. |
| * **[[:panel-plugins:xfce4-xkb-plugin:start|Xkb]]** -- Setup and use multiple (currently up to 4 due to X11 protocol limitation) keyboard layouts. |
| |
[[apps:terminal:|Terminal Emulator (xfce4-terminal)]]\\ | [[|Back to Top]] |
Terminal emulator for the Xfce desktop. | ---- |
| |
[[apps:ristretto:|Image Viewer (ristretto)]]\\ | Take a look at the [[https://wiki.xfce.org/recommendedapps| list of recommended applications]] for more light-weight applications, recommended by Xfce users. |
Image viewer for the Xfce desktop. | |
| |
[[apps:screenshooter:|Screenshot application (xfce4-screenshooter)]]\\ | [[https://floss.social/@xfce|@xfce@floss.social ]] |
Take screenshots of your Xfce desktop. | |
| |
[[apps:parole:|Media player (parole)]]\\ | Check the [[/start?do=index|sitemap]] of this wiki to see all available wiki pages. |
Media player for the Xfce desktop. | |
===== API documentation ===== | |
| |
Library references can be found in the releases: [[http://archive.xfce.org/src/xfce/garcon|garcon]], [[http://archive.xfce.org/src/xfce/exo|exo]], [[http://archive.xfce.org/src/xfce/libxfce4ui|libxfce4ui]], [[http://archive.xfce.org/src/xfce/libxfce4util|libxfce4util]], [[http://archive.xfce.org/src/xfce/thunar|thunar]], [[http://archive.xfce.org/src/xfce/xfconf|xfconf]]. They are often also installed by distributions in ''/usr/share/gtk-doc/html/''. | |
| |