6. Lumina Desktop¶
Beginning with 11.0, the PC-BSD® installer installs the Lumina Desktop Environment (Lumina for short). Additional window managers can be installed using AppCafe®. This chapter describes the Lumina Configuration utility and the various utilities which are built into Lumina. For instructions on how to install Lumina on other operating systems or how to contribute to the Lumina Project, refer to the documentation at the Lumina website.
Lumina is a lightweight, XDG-compliant, BSD-licensed desktop environment that focuses specifically on streamlining the ability to get work done while minimizing system overhead. It is specifically designed for PC-BSD® and FreeBSD, but has also been ported to many other BSD and Linux operating systems. It is based on the Qt graphical toolkit and the Fluxbox window manager, and uses a small number of X utilities for various tasks, such as numlockx and xscreensaver.
Lumina’s features include:
- Very little system overhead.
- Does not require any of desktop implementation frameworks such as DBUS, policykit, consolekit, systemd, or HALD.
- Does not come bundled with any applications such as web browsers, email clients, multimedia software, or office suites. Instead, it provides utilities for configuring the desktop environment.
- Uses a simple, text-based configuration file for setting system-wide defaults. This allows Lumina distributors to easily pre-set the Lumina defaults and interface for their distribution.
- Provides a plugin-based interface design. This allows the user to make the desktop as light or heavy as desired by choosing which plugins to have running on their desktop and panels. This plugin-based system is similar to Android or other modern operating systems.
- Single, easy-to-use Lumina Configuration utility controls all the different configuration options for the desktop in one location.
- Intelligent “favorites” system for creating quick shortcuts to applications, files, and directories.
- ZFS file restore functionality through the Insight File Manager.
- Simple access to operating system-specific functionality such as screen brightness, audio volume, and battery status.
- Multi-monitor support includes the Lumina Xconfig graphical utility for adding or removing monitors from the Lumina session.
- Simple system controls through the system menu for configuring audio volume, screen brightness, battery status/notifications, and workspace switching.
- Total system search capabilities through Lumina Search, without a daemon eating memory in the background.
- Screenshot functionality through Lumina Screenshot which is also tied to the “Print Screen” key by default.
- Basic text creation and editing capability through Lumina Text Editor.
6.2. Panel and System Tray¶
By default, Lumina provides a panel at the bottom of the screen with a system tray at the far right of the panel. This section describes the default layout. For instructions on how to configure the panel to suit your needs, refer to the “Panels” tab Interface section.
As you open windows or applications, a button will be added to the section of the panel near the system menu. If the application provides an icon, the button will appear as that icon and if you mouse over it, the tooltip will show the name of the application. If you have multiple copies of an application running, it will combine all those entries into a single button and list the number of windows after the icon. If you click on a button, it will automatically make that window active and if you click it again, it will automatically minimize it. If there are multiple windows, you can select the particular window you want to activate from a drop-down menu.
If you right-click the title of an open window, a menu of options will appear so that you can shade, stick, maximize, iconify, raise, lower, set the window title, send the window to a workspace, layer/dock the window, set the window’s transparency, remember a specified setting, or close the window.
The system tray is located in the right portion of the panel. Any applications that register a tray icon will appear in this area. For example, on a PC-BSD system, icons will appear for Life Preserver, Mount Tray, and Update Manager. Click or right-click an icon to interact with that application directly. The current system time shown by the clock is in the default format for the current locale. If you click the clock icon and then click “Time Zone”, a menu will open where you can select to either “Use System Time” or click a country name in order to select a city to change to that city’s time zone.
6.4. Lumina Configuration¶
The Lumina Configuration utility, shown in Figure 6.4.1: Lumina Desktop Configuration, can be used to configure every aspect of the desktop and is the recommended way to make changes. To launch this utility, click the start menu then , right-click the desktop and click , or type lumina-config from an xterm.
Each of the tabs at the top configures a different area of the system, with the most frequently changed options on the left side. As changes are made, the “Save Changes” button at the bottom of the window becomes active. This allows the user to setup multiple changes in any tab and apply them all at the same time.
Note
If you make any changes in any of the tabs, remember to click “Save Changes” before exiting this utility in order to save them.
The rest of this section describes the configurations that are available in each tab.
6.4.1. Appearance¶
This tab is used to change the visual appearance and functionality of the desktop on a per-screen basis. The “Wallpaper” tab, shown in Figure 6.4.1: Lumina Desktop Configuration, can be used to add a wallpaper (“+” button) or remove (“-” button) a wallpaper. When you click the “+” button, the drop-down menu can be used to select the file(s), a single directory, a directory and all of its subdirectories, or a solid color to use as the wallpaper. If multiple images are selected, the “Rotate Background” button can be selected as well as a specified time interval in minutes to rotate to the next image.
Click the “Layout” drop-down menu to change the default layout of “Automatic” to one of the following options: “Tile”, “Center”, “Top Left”, “Top Right”, “Bottom Left”, or “Bottom Right”.
The options that are available when you click Figure 6.4.2: Modifying the Wallpaper. If you select a color and click “OK”, it will be added as a solid color background to the wallpaper selection drop-down menu.
are shown inThe “Theme” tab, shown in Figure 6.4.3: Modifying the Theme, can be used to change the default font, font size, theme template, color scheme, icon pack, and mouse cursors.
It is possible to create your own “Theme Template” or “Color Scheme” by clicking the “Edit” button next to those options and changing the settings as necessary. Figure 6.4.4: Using the Theme Editor shows an example of clicking the “Edit” button with the “Lumina-default (System)” theme template selected. This action opened the “Theme Editor” and the user has clicked the color selector (dropper icon) in the upper right corner. After selecting an item in this menu, the template controlling that selection can be edited by changing the values in the theme editor box. Note that the theme templates are written as Qt stylesheets, so some scripting experience may be helpful when configuring a theme. After making your changes, you can either click the “Save” button to save the theme without closing the editor, or click the “Apply” button which will both save the theme and close the theme editor.
6.4.2. Interface¶
The “Interface” tab is used to configure the desktop right-click menu and panel. Its “Desktop” tab, shown in Figure 6.4.5: Right-Click Menu Configuration, is used to configure which items appear in the right-click menu and which items are embedded onto the desktop.
To add an item to the right-click menu, click the “+” button under the “Quick-Access Menu”. This will open the “Select a Plugin” screen where you can add an application, custom app, an entry for the Insight File Manager, a separator, a shortcut to Settings, a terminal, or a listing of currently open applications. To remove an item from the right-click menu, highlight it and click the “-” button. Use the arrow buttons to change the order of the items in the right-click menu.
To embed a utility onto the desktop, click the “+” button under the “Embedded Utilities” frame. The following plugins can be added as an icon on the desktop: Application Launcher (opens a menu that lists which applications can be launched), Audio Player, Calendar, Desktop Icons View, Note Pad, Sample (an example of a QtQuick/QML plugin), and System Monitor (displays CPU temperature/usage, memory usage, and disk I/O). Once you click the “Save Changes” button, any utilities you added will appear on top of the desktop. To remove an embedded utility from the desktop, highlight its entry under “Embedded Utilities”, click the “-” button, and click “Save Changes”. Alternately, right-click the icon for the utility and select “Remove Item” from the right-click menu.
The following options are also available when you right-click an icon on the desktop, allowing you to customize the location and appearance of desktop icons: “Start Moving Item” (click the icon to lock it in place once you have moved it to the desired location), “Start Resizing Item” (use the mouse to increase/decrease size and click when you are finished), “Increase Desktop Icon Sizes” (increases all desktop icons, repeat as necessary), and “Decrease Desktop Icon Sizes” (decreases all desktop icons, repeat as necessary).
The “Display Desktop Folder Contents” option is used to display each item stored in ~/Desktop
as an icon on the desktop. By default, this option is selected as its box is black. If
you de-select this option and click “Save Changes”, the icons for the contents of ~/Desktop
will be removed from the desktop.
To configure the panel, click the “Panels” tab which will open the screen shown in Figure 6.4.6: Panels Tab.
This screen can be used to customize the location, alignment, size, theme, and plugins for an existing panel. The “+” and “-” icons towards the top, next to “Panel 1” can be used to add or remove additional panels. Panels must be aligned along a screen edge, opposite screen edges in the case of two panels, and may have any width, color, or transparency.
Note
If you add additional panels, a frame, similar to “Panel 1”, will be created for each panel, and will be labeled “Panel 2”, “Panel 3”, and so on. This allows you to configure each panel separately. The configuration tabs available for a panel are described below. Be sure to select the tab in the panel that you wish to customize.
The “Location” tab (4 arrow icon) contains the following items:
- Edge: this drop-down menu can be used to set the location of the panel which can be “Top”, “Bottom”, “Left”, or “Right”.
- Alignment: this drop-down menu can be used to center the panel on the edge or pin it to one of the corners.
- Size: can be used to specify the panel width in pixels and the panel length.
The “Appearance” tab (monitor icon) is shown in Figure 6.4.7: Panels Appearance Tab.
If you would like the panel to be hidden unless the mouse is hovered over it, check the “Auto-hide Panel” box. The “Custom Color” option can be used to fine-tune the panel color. Click its box, then the paint icon to select the panel color.
The “Plugins” tab (puzzle icon) is shown in Figure 6.4.8: Panels Plugins Tab.
To add a plugin as an icon to the panel, click the “+” button below the listed plugins and select a plugin from the list that appears. The available plugins include:
- Application Launcher: when you select this plugin, it will prompt you to select the application to launch. This will add a shortcut for launching the selected application to the panel.
- Application Menu: adds an application menu that contains a shortcut to your home directory, a shortcut to the operating system’s graphical software management utility (if there is one), a shortcut to the operating system’s Control Panel (if it provides one), and a list of installed software sorted by categories.
- Battery Monitor: hover over this icon to view the current charge status of the battery. When the charge reaches 15% or below, the low battery icon will flash intermittently and will change to a low battery icon when there is less than 5% charge left.
- Desktop Bar: adds a “star” button for automatically displaying entries for anything in the
~/Desktop
folder and alternately launching the selected entry. - Line: adds a separator line to the panel.
- Show Desktop: this button will hide all open windows so that only the desktop is visible. This is useful for touch screens or small devices.
- Spacer: adds a blank area to the panel.
- Start Menu: adds a classic start menu as seen on other operating systems.
- System Dashboard: used to view/modify audio volume, screen brightness, battery life, and virtual desktops.
- System Tray: provides a display area for dockable applications.
- Task Manager (No Groups): ensures that every window gets its own button. This uses a lot more space on the panel since it needs to put part of the window title on each button.
- Task Manager: is added by default. Its behavior is to group windows by application.
- Time/Date: displays the current time and date.
- User Button: main button for accessing applications, directories, settings, and log out.
- Workspace Switcher: used to switch between virtual desktops.
To remove a plugin, highlight it and click the “-” button below the listed plugins. The arrow buttons can be used to move the location of the plugin on the panel. The top of an ordered list corresponds to either the top of a vertical panel or the left side of a horizontal panel.
6.4.3. Applications¶
The “Applications” tab, shown in Figure 6.4.9: Lumina Applications Configuration, is used to configure which applications start when you login to Lumina as well as the default applications and file types.
To prevent an application from starting automatically, uncheck its box.
To add an application to the auto-start configuration , click “Application” to select the application’s name from a drop-down menu or click “Binary” or “File” to browse to the location of the application or file to open. If you select a file name, Lumina will automatically open it in an application that is capable of reading the file type.
To configure the default application used for particular file types, click the “File Defaults” tab, shown in Figure 6.4.10: Lumina Defaults Configuration.
To add an application, select the file type and specific group and either click “Set App”, which will open a drop-down menu of common applications, or “Set Binary”, which will open a file browser so that you can browse to the path of the application. Alternately, selecting only a file type and then clicking “Set App” or “Set Binary” will register your application for all the groups within the selected type.
The “Common Applications” tab, shown in Figure 6.4.11: Lumina Common Applications Configuration, can be used to configure default applications.
You can configure the default web browser, email client, file manager, and virtual terminal. Simply click the application you wish to change, and a new window will appear allowing you to select a new default application. If you wish to go back to the default application, click the current application’s name, then click “Restore Defaults”.
Note
Some applications, such as web browsers, keep their own internal lists of default applications for opening particular types of files. If you set that application to use the lumina-open or xdg-open utilities, it will use the default applications that are set here so that there is only a single list of default applications for the system.
6.4.4. Shortcuts¶
The “Shortcuts” tab, shown in Figure 6.4.12: Lumina Shortcuts Configuration, is used to configure various keyboard shortcuts for system or window tasks. Most of these options relate to window and workspace management, such as moving windows between workspaces, but there are also options for changing the system audio volume or screen brightness.
To create a shortcut, click the desired entry, then “Change Shortcut”, then the key combination you wish to set. Note that any entry that already has a defined shortcut showing in the “Keyboard Shortcut” column can not be assigned to another action. First, highlight that shortcut, click “Clear Shortcut”, then “Save Changes”. You can now create a new shortcut.
6.4.5. Session¶
The “Session” tab, shown in Figure 6.4.13: Session General Options Tab, governs the general settings for the desktop session. These settings are usually not changed on a frequent basis.
The “General Options” tab can be used to automatically enable numlock, to play chimes when Lumina starts or exits, and to change the icon that appears in the login menu and the start menu button. It also has options to set the time format, date format, and time display format. Buttons are available to reset these options to either the system defaults or Lumina defaults.
The “Locale” tab is shown in Figure 6.4.14: Session Locale Tab.
The lumina-i18n package provides localization files. Once installed, this allows you to customize which locale is used for the various items listed in Figure 6.4.14: Session Locale Tab. To install this package on a PC-BSD or FreeBSD system, use sudo pkg install lumina-i18n. On other operating systems, use the software management tool that comes with the operating system. If the Lumina Configuration utility was open before the installation, restart it so that the list of localizations can be loaded into the drop-down menus of this screen. Since each setting has its own drop-down menu, you have the flexibility to select different locales for each item shown in this screen. Note that if you make any changes in the “Locale” tab, click the “Save Changes” button and restart Lumina so that the configured locales can be loaded.
Installing the lumina-i18n package will also add a drop-down menu to the “Preferences” of the start menu, though you will need to restart Lumina after the package installation in order for the locale menu to appear in “Preferences”. This drop-down menu can be used to temporarily change the locale for this session only. This will immediately change the localization of any translated menu items on the fly so that you do not have to log back into the Lumina session.
Note
Any menu items that continue to be displayed in English have not been translated to the selected language yet. You can assist the Lumina Project in translating menu items using the instructions in Interface Translation.
The “Window System” tab, shown in Figure 6.4.15: Session Window System Tab, contains various configuration options for the window manager.
Drop-down menus are provided for configuring the following:
- Number of Workspaces: up to 10 workspaces can be defined, with a default of 2.
- New Window Placement: indicates where new windows are placed on the screen. Choices are “Align in a Row”, “Align in a Column”, “Cascade”, or “Underneath Mouse”.
- Focus Policy: indicates when windows receive focus. Choices are “Click to Focus”, “Active Mouse Focus”, or “Strict Mouse Focus”.
- Window Theme: controls the appearance of the frame around application windows. The “Window Theme Preview” screen can be used to preview the selected theme.
6.5. Lumina Utilities¶
Lumina provides many built-in utilities, which are described in this chapter.
6.5.1. Lumina Screenshot¶
This utility can be used to take screenshots of the desktop or selected window and save them as PNG image files. To launch this utility, click the start menu and select
Print Screen
button.
On the “New Screenshot” tab, seen here in Figure 6.5.1: New Screenshot Tab the following settings can be used to fine-tune the screenshot:
- Entire Session: will take a screenshot of the entire screen.
- Single Screen: in a multi-monitor setup, you can select which screen number to use for the screenshot.
- Single Window: will screenshot a selected window. Simply choose “Single Window,” then the “Take Screenshot” button, and click on the desired window. The “Include Borders” checkbox can be used to determine whether or not the screenshot of the window is surrounded by a black border.
- Delay: in seconds. This can be used to give you time to setup the screenshot.
There are three options for taking a screenshot: clicking the “Take Screenshot” button in the lower-right corner of Lumina Screenshot, pressing Ctrl+N
, or clicking .
After capturing a screenshot, the “View/Edit”, seen here in Figure 6.5.2: View/Edit Tab tab provides additional options for manipulating the screenshot:
- Image Preview: displays the captured screenshot. Right clicking the image will provide options for zooming in or out. Left click and dragging across the image will highlight an area which can be cropped by pressing the “Crop” button in the lower-right corner.
- “Save As”: button to open a window where you can specify the filename and location for saving the screenshot.
- Launch Editor: button to launch a selectable image manipulation program.
Additionally, clicking
will automatically save the screenshot to the default “Pictures” directory and open a window to select an image manipulation program.6.5.2. Insight File Manager¶
The Insight file manager, shown in Figure 6.5.3: Insight File Manager, allows the user to easily browse and modify files on the local system on a per-directory basis. To open Insight, click the start menu and select “Browse Files”, right-click the desktop and select “Browse Files”, or type lumina-fm from an xterm.
It is possible to open up additional directories through the tab system using Ctrl-T
or by clicking , allowing the user to easily manage multiple
locations on the system. Insight also features the ability to “bookmark” locations on the system for instant access via the “star” button. Once a location has been bookmarked, it will be
available via the “Bookmarks” menu at the top of the window. Any removable devices that are available on the system will show up in the “External Devices” menu, if supported by the operating
system. When an item is selected, the icons on the left side of the screen provide the possible actions that may be taken with regards to that item. Possible actions include: “open item”,
“open item” (will prompt to select the application to use), “add item to personal favorites”, “rename item”, “cut items (add to the clipboard)”, “copy items to the clipboard”, “paste items
from clipboard”, and “delete items”. By default, the action buttons are visible. They can be made invisible by clicking . To disable thumbnails,
uncheck . Note that this option does not remove thumbnails that have already been loaded, it only prevents loading thumbnails in new directories.
Hidden files are not shown by default; this can be changed by checking .
If you select a file or directory and right-click it, the following options become available: “Open”, “Open With” (where you select the application to use), “Rename”, “View Checksums” (shows the MD5 checksum), “Cut Selection”, “Copy Selection”, “Paste”, “Delete Selection”, “File Properties” (such as file type, size, permissions, and creation date), or “Open Terminal here”.
A few additional options may be available at the bottom of the window, depending on the directory being viewed and the types of files that are in it:
- New file: the ability to create a new file is available if the user has permission to modify the contents of the current directory.
- New Dir: the ability to create a new directory is available if the user has permission to modify the contents of the current directory.
- Slideshow: if there are image files in the directory, this option will display those image files as a slideshow and provide arrows for going forward or back by one file or to the very beginning or end of the file list. Buttons are also provided for deleting the currently displayed image or to rotate it, and save the rotation, clockwise or counter-clockwise.
- Play: will appear if there are supported multimedia files in the directory. The types of files that are supported depends on what multimedia plugins are installed on the system. If a particular file is not recognized as a multimedia file, install the associated multimedia codec using the operating system’s application management software and restart the file manager.
- Backups: if the system is formatted with ZFS and snapshots of the current directory are available, this button will appear. Snapshots are organized from
oldest to newest, with the most recent snapshot selected by default, and the contents of the directory at the time of that snapshot are displayed. To
restore a file or multiple files, select them from the list and click the “Restore Selection” button. If those files still exist and you want to overwrite
them, make sure the “Overwrite Existing Files” option is checked first. Otherwise, if a file with that name exists, the restore will append a number to the
end of the filename. For example, the first restored version of
testfile.txt
will becometestfile-1.txt
.
6.5.3. Lumina Open¶
To open a file, directory, or URL from the command line, use lumina-open followed by the full path to the file or the URL. This utility will look for an appropriate application to use to open the specified file or URL. If there is no default application registered for the input type, a small dialog will prompt the user to select which application to use, and optionally set it as the default application for this file type. As seen in the example shown in Figure 6.5.4: Lumina Open, this dialog organizes the available applications into three types:
- Preferred: these applications have registered their Mime type with the system and can open that type of file. Also included are any applications that have been used to open this type of file before as it keeps track of the last three applications used for that file type.
- Available: displays all the applications installed on the system, organized by category and name.
- Custom: lets the user manually type in the binary name or path of the application to use. It also provides a search button to let the user graphically search the system for the binary. Whenever text is entered, a check is performed to determine whether that is a valid binary and the icon will change between a green checkmark or a red X as appropriate.
6.5.4. Lumina Search¶
Lumina Search provides the ability to easily search for and launch applications or to quickly search for file and directories. The “*” wildcard can be used in the search terms and the search will include hidden files if the search term starts with a dot (”.”).
To start this utility, type lumina-search or go to the start menu Figure 6.5.5: Search for Applications shows a screenshot of this utility.
.To open an application, begin to enter its name. The box below the selected “Applications” button will display any matching application names. Select the desired application and click the “Launch Item” button to open it.
If you click the “Files or Directories” button, the screen changes slightly, as seen in Figure 6.5.6: Search for Files.
By default, a “Files or Directories” search is limited to the user’s home directory, as indicated by the “Search: ~” at the bottom of the screen. The “Smart: Off” indicates that every subdirectory is included in the search; in other words, there are no excluded directories. To add additional search directories or to exclude subdirectories, click the wrench icon to see the screen shown in Figure 6.5.7: Configuring the Search Directories.
Click the blue folder icon to change the starting search directory. For example, you can select “Computer” then “/” from the “Select Search Directory” screen to search the entire contents of the computer. You can also add directories to exclude from searches by clicking the “+” button. If you add any excludes, you can delete an exclude by highlighting it and clicking the “-” button. By default, the “Save as Defaults” option is selected. Unselect this option if you only wish to temporarily modify your search settings.
6.5.5. Lumina File Information¶
The lumina-fileinfo utility can be used to open a graphical window summarizing the size, permissions and ownership, creation time, and last modification time of the specified
file or directory. In the example shown in in Figure 6.5.8: Sample File Information, the user has typed lumina-fileinfo Downloads from a terminal window to view the
file information of their ~/Downloads
directory.
6.5.6. Lumina Information¶
This utility provides information about the version of Lumina, as well as the license, acknowledgements, and Project links. To launch this utility, right-click the desktop and select Figure 6.5.9: About Lumina.
, click the start menu then the question mark icon in “Preferences”, or type lumina-info in a terminal window. An example is shown inThe “General” tab contains the following information:
- Desktop Version: indicates the version of Lumina.
- OS Build: indicates the operating system that was used to build this version of Lumina.
- Qt Version: click the “View Information” button to display the QT version and its license.
- Lumina Website: click the “Open in web browser” link to open http://lumina-desktop.org/ in the default web browser.
- Source Repository: click the “Open in web browser” link to open https://github.com/pcbsd/lumina in the default web browser.
- Report a Bug: click the “Open in web browser” link to open https://bugs.pcbsd.org/projects/pcbsd in the default web browser. Refer to Report a bug for instructions on how to submit a bug report.
The “License” tab contains the license text for Lumina. Lumina is licensed under a 3-clause BSD license.
The “Acknowledgements” tab contains the following:
- Project Lead: the name of the Project’s lead developer. Click the name to open his profile on GitHub in the default web browser.
- Contributors: click the “Open in web browser” link to open https://github.com/pcbsd/lumina/graphs/contributors.
- Sponsors: lists the project and corporate sponsors of the Lumina Project.
6.5.7. Lumina Xconfig¶
The lumina-xconfig utility is a graphical front-end to the xrandr command line utility. It provides the ability to probe and manage any number of attached monitors. To start this utility, right-click the desktop and select Figure 6.5.10: Configuring Monitors.
or type lumina-xconfig from a terminal window. This will open a screen similar to the one shown inIn this example, two display inputs are attached to the system and their current screen resolutions are displayed. If the display input supports multiple resolutions, they will appear in the “Resolution” drop-down menu so that you can select a different resolution.
If you attach another display input, the “Add Screen” tab is activated so that you can configure the new input’s resolution and whether or not it should be the default input.
6.5.8. Lumina Text Editor¶
The lumina-textedit utility, seen in Figure 6.5.11: Lumina Text Edit is a simple plaintext editor which features four primary elements: optional syntax highlighting, find/replace functionality, line numbering, and bracket highlighting. Additionally, colors can be customized by selecting .