5. Utilities

Lumina® provides many built-in utilities, which are described in this chapter.

5.1. Archiver

The Lumina® Archiver, seen here in Figure 5.1.1, provides compression/decompression services for a wide variety of file types. It is listed with other utilities in the GUI, or can be opened with lumina-archiver in a CLI.

_images/luminaarc1.png

Fig. 5.1.1 Lumina® Archiver

The File and Edit categories contain all operations for the utility, which are also reproduced in the icon toolbar. Table 5.1.1 lists all operations for the Archive Manager:

Table 5.1.1 Archiver operations
Command Menu Icon Shortcut Result
New Archive File Page with White Plus Ctrl + N Opens a window to create a new archive file
Open Archive File Folder with File Ctrl + O Open an existing archive
Quit File None Ctrl + Q Exit the utility
Add Files Edit Page with Green Plus None Add a file to an open archive
Add Directory Edit Folder with Plus None Add a directory to an open archive
Remove Files Edit Page with Red X None Removes the selected file from the archive
Extract All Edit Page with White Arrow Ctrl + E Opens a window to extract the entire e contents of the archive
Extract Selection Edit Page with White Arrow None Opens a window to extract the highlighted archive contents

The primary window under the icon toolbar displays several elements:

  • Archive: The full pathway to the opened archived.
  • File: Lists the names of the files in the archive.
  • Mimetype: Lists the mimetypes of archived files.
  • Size: Displays the total size of the archived files.

The small section under the primary window will display any tooltips when hovering over an icon, as well as messages indicating an operation’s success or failure.

5.2. Calculator

The Lumina® calculator utility is designed to provide a simple and intuitive interface paired with advanced functions and features. Open the calculator through the Utilities category of the application list, or by typing lumina-calculator in a CLI. The interface is seen in Figure 5.2.1:

_images/lcalc1a.png

Fig. 5.2.1 Lumina® Calculator

The calculator is configured to use a numpad, if one is available. Enter the values and an operation, and the calculator displays the answer in the upper window. Select an equation displayed in the upper window to paste it in the entry field. On the right side of the output display are two icons. Press the Paper with red circle to clear the entire output history. Press the disk and pencil icon to save the calulator history as a basic text document.

Lumina® Calculator also supports a variety of advanced operations, seen in Figure 5.2.2.

_images/lcalc2.png

Fig. 5.2.2 Lumina® Calculator Advanced Operations

These advanced operations can be selected from the drop down menu, or typed manually. The full list of available operations is seen in Table 5.2.1.

Table 5.2.1 Lumina® Calculator Advanced Operations
Operation Symbol
Percentage %
Power ^
Base-10 Exponential E
Exponential e
Constant Pi π
Square Root sqrt(
Logarithm log(
Natural Log ln(
Sine sin(
Cosine cos(
Tangent tan(
Arc Sine asin(
Arc Cosine acos(
Arc Tangent atan(
Hyperbolic Sine sinh(
Hyperbolic Cosine cosh(
Hyperbolic Tangent tanh(

5.3. Insight File Manager

The Insight file manager, shown in Figure 5.3.1, allows the user to easily browse and modify files on the local system. 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.

Note

If Insight is already open, lumina-fm activates the currently open instance of Insight and adds a new tab. Open a new window of Insight by pressing Ctrl + N when the current Insight window is active.

_images/lumina10c.png

Fig. 5.3.1 Insight File Manager

The top menu bar offers a wide variety of options for controlling Insight:

  • File: Contains basic options for manipulating Insight, seen here in Table 5.3.1.

    Table 5.3.1 Insight Manager File Options
    Name Shortcut Description
    New Window Ctrl + N Creates a new instance of Insight
    New Tab Ctrl + T Opens a new tab in Insight
    Search Directory Ctrl + F Opens Lumina® Search
    Close Tab Ctrl + W Removes an open tab
    Exit Ctrl + Q Closes Insight
  • View: Presents options to alter what Insight displays to the user. Table 5.3.2 shows the current options in the View tab:

    Table 5.3.2 Insight Manager “View” Options
    Name Shortcut Description
    Refresh F5 Reloads the current location
    Show Hidden Files Ctrl + H Insight displays all files marked hidden
    Show Image Previews None Displays a small thumbnail of the image file in the Insight window
    View Mode None Basic: Displays the names of files and directories. Advanced: Displays Name, Size, Type, Date Modified, and Date Created for each file or directory.
  • Bookmarks: The Bookmarks not only gives options to add and manipulate internal links for quick navigation with Insight, but also displays any created bookmarks in the drop-down menu. Table 5.3.3 describes all these elements:

    Table 5.3.3 Insight Manager Bookmark Options
    Name Shortcut Description
    Manage Bookmarks Ctrl + B Allows modification or removal of bookmarks
    Add Bookmark Ctrl + D Creates new bookmark of current location
    Bookmark Display None Populates with bookmarks as they are created
  • External Devices: Any attached devices with storage appears in this menu. Click Scan for Devices if an attached device does not appear.

  • Git: Basic GitHub functionality is natively built into Insight. Currently, Repo Status displays the active branch, update status with the origin repository, and any uncommitted changes. Clone Repository opens a wizard to download a git repository from the internet, seen in Figure 5.3.2.

    _images/lumina34.png

    Fig. 5.3.2 Git Clone Repository Wizard

    Tip

    Clone Repository deactivates when Insight navigates inside a directory already labeled as a git repository.

Underneath the top menu bar is a navigation bar with even more options. From left to right, Table 5.3.4 describes each icon:

Table 5.3.4 Insight Manager Navigation bar
Item Description
Left Arrow Go back to previous directory
Up Arrow Go to parent directory
House Icon Go to home directory
Text Field Path to current location/Manual navigation field
Boxes with “x” Single column view
Boxes with plus Dual column view
Vertical dots icon Additional file and directory operations (also available by right-clicking in the display area)

Pressing the Plus Columns button next to the navigation field activates columned browsing, displaying two independent instances of the file manager in a side-by-side view, seen in Figure 5.3.3.

_images/lumina33a.png

Fig. 5.3.3 Insight Columns Display

In columns mode, the active column has a white background. All the menu options and ZFS functions apply to only the active column.

The Vertical Dots Icon shows file and directory operations, commonly seen in the right-click menu when an item is selected. The directory operations are always available and as the name implies, provide options affecting the entire directory. Table 5.3.5 shows each of these options, split into the Create… and Open… categories:

Table 5.3.5 Insight Manager Directory Operations
Item Category Shortcut Description
File Create Ctrl + Shift + F Create new file
Directory Create Ctrl + Shift + N Create new directory
Application Launcher Create Ctrl + G Launches wizard to create link to desired application
Terminal Launch F1 Launches the default terminal set to the current directory
Slideshow Launch F6 Creates and populates a slideshow within a new Insight tab
Multimedia Player Launch F7 Opens the directory with the default multimedia player

Once an item is highlighted in Insight, a number of file operations become available, seen in Table 5.3.6:

Table 5.3.6 Insight Manager Operations
Item Category Shortcut Description
Open None Double-Click Open the file or directory with the default applications
Open With None None Opens the file or directory with a chosen application
Cut Selection File Operations Ctrl + X Used with Paste to move a file
Copy Selection File Operations Ctrl + C Used with Paste to create an exact duplicate of the selected file
Rename File Operations F2 Allows changing the title of the selection
Delete Selection File Operations Del Removes the selection from the system
Auto Extract File Operations Ctrl + E Uses lumina-archiver to extract the file
Checksums View Files None Displays the file’s checksum
Properties View Files None Displays the file information of the selection
Paste None Ctrl + V Used with Cut or Copy to move or clone files and directories

The final element to the upper Insight menus, if configured, is the ZFS snapshot bar, seen as the long blue line in Insight. If the system is formatted with ZFS and snapshots of the current directory are available, this bar allows the user to view the current directory from previous snapshots. In other words, the user can see past instances of the directory, as long as ZFS is configured to take periodic snapshots.

Snapshots are organized with oldest to newest snapshots displayed on the line from left to right. The text box on the left side of the blue line shows the active snapshot. Click the text box to view the other snapshots and choose which snapshots to activate. A slider also exists which can be used to move the directory back and forward in time, according to the saved snapshots. The left and right arrows can also be used for this function.

Insight displays the directory tree in a small window on the left side. This display can also be used to navigate to the desired directory.

Underneath the viewing area of Insight are Magnifying Glass icons, used to increase or decrease the size of the objects to display. Also, the bottom left corner will display tooltips about the highlighted object or other relevant information.

5.4. File Information

The lumina-fileinfo utility is 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 5.4.1, the user has typed lumina-fileinfo Downloads from a terminal window to view the file information of their ~/Downloads directory.

_images/file1a.png

Fig. 5.4.1 Sample File Information

5.5. Information

This utility provides information about the installed version of Lumina®, as well as the license, acknowledgements, and project links. To launch this utility, right-click the desktop and select Preferences ‣ About Lumina, click Start Menu ‣ Question Mark icon in Preferences, or type lumina-info in a terminal window. An example is shown in Figure 5.5.1.

_images/about1c.png

Fig. 5.5.1 About Lumina®

The General tab contains a variety of information:

The License tab contains the license text for Lumina®. Lumina® is licensed under a 3-clause BSD license.

The Acknowledgements tab contains a few elements:

  • Project Lead: The name of the Project’s lead developer. Click the name to open his or her profile on GitHub in the default web browser.
  • Contributors: Click Open in web browser link to open https://github.com/trueos/lumina/graphs/contributors.
  • Sponsors: lists the official sponsors of the Lumina® Project.

5.6. Open

To open a file, directory, or URL from the command line, type 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 5.6.1, this dialog organizes the available applications into three types:

_images/lumina11b.png

Fig. 5.6.1 Lumina® Open

  • Preferred: These applications register their Mime type with the system and can open that type of file. Also included are any applications 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: The user can manually type in the binary name or path of the application to use. A search button is also available for the user to graphically search the system for the binary. Whenever text is entered, a check is performed to determine if it is a valid binary, changing the icon to a green checkmark or red X as appropriate.

5.7. 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 Browse Applications ‣ Utility ‣ Lumina Screenshot, right-click the desktop and select Applications ‣ Utility ‣ Lumina Screenshot, type lumina-screenshot from a terminal window, or press Print Screen.

The utility opens with the View tab open by default, as seen in Figure 5.7.1.

_images/lumina25c.png

Fig. 5.7.1 Lumina Screenshot with View tab open.

The top menu bar contains several common options, while the tabs contain configuration options for screenshots. Table 5.7.1 lists the options in this top menu bar:

Table 5.7.1 Lumina Screenshot menu options
Option Shortcut Description
Capture Ctrl + N Take a screenshot.
Save As Ctrl + S Open the Save Screenshot window to name and save the new screenshot.
Quick Save None Saves the screenshot to /Pictures in the format Screenshot-yr-mth-dy-hr-min-sec.png. An Open With window appears for the user to view the screenshot.
Close Esc Closes lumina-screenshot.

Underneath the top menu bar are tabs for viewing and configuring screenshots.

The View tab displays the most recent screenshot. Adjust the slider on the left to zoom in or out on the screenshot. Click and drag anywhere on the screenshot to designate an area to crop. Click again to remove the highlighted area. When satisfied, click Crop to remove everything from the screenshot outside the highlighted area. Click Open With… to quicksave the screenshot and designate an application to view or further manipulate the screenshot.

Use the settings tab to configure how a screenshot is taken.

Figure 5.7.2 shows the Settings tab, while Table 5.7.2 lists all options for configuring screenshots:

_images/lumina39.png

Fig. 5.7.2 Lumina Screenshot with Settings tab open.

Table 5.7.2 Lumina Screenshot UI Options
Option Description
Entire Session Captures the entire screen.
Single Screen For multi-monitor setups. The screen number can be selected for the screenshot.
Single Window Captures a selected window. With this selected, click Capture, and click the desired window. The Include Borders checkbox is used to determine if the utility takes a screenshot of the window with its border frame.
Delay Choose the number of seconds to delay the screen capture after pressing Capture.
Show warnings Check this box to have the utility provide a popup prompt when closing without saving the screenshot.

5.9. Text Editor

The lumina-textedit utility is a plaintext editor with a number of basic options. Figure 5.9.1: shows the editor with no file opened.

Note

Typing lte in the command line will also open the Lumina® Text Editor.

_images/lumina23.png

Fig. 5.9.1 Lumina® Text Edit

Clicking File presents options to create New File, Open File, Close File, Save file, Save File As, and Close. Click Edit to open options to Find and Replace, also usable with Ctrl-F and Ctrl-R, respectively. The View tab can be used to alter Syntax Highlighting, Line Numbers, Wrap Lines, and Customize Colors. By default, brackets are highlighted, lines are numbered, and words wrap dynamically with the edge of the window. Additionally, selecting Customize Colors gives the option to alter all the default text and highlight colors, as seen in Figure 5.9.2.

_images/lumina32.png

Fig. 5.9.2 Customize Colors

5.10. Lumina Media Player

lumina-mediaplayer is a very basic music player with included integrations for the Pandora internet radio streaming service. Lumina Media Player can be found in the Applications ‣ Utilities section, or by typing lumina-mediaplayer in a command line.

Lumina Media Player is essentially a basic graphic interface for the Qt QMediaPlayer Class. This class supports many audio formats, including .ogg, .mp3, .mp4, .flac, and .wmv. You can increase the number of playable formats by installing gstreamer-plugins from AppCafe®.

Figure 5.10.1 shows the initial screen for Lumina Media Player.

_images/lmediapl1.png

Fig. 5.10.1 Lumina Media Player: Play Local Files

Use View to toggle notifications or closing the player to the tray when active. The Play button plays all songs in the Playlist. When music is playing, the Now Playing tab becomes active, displaying more icons to Pause, Stop, Play Previous, and Skip to Next. Press Stop to disable the Now Playing tab and return to the Playlist tab.

While browsing the Playlist, you can use the Plus and Minus buttons to add and remove songs from the list. Use the Arrow keys to reorder songs in the list. There are also Cross Arrows and Circular Arrows icons to Randomize and Auto-Repeat the playlist, respectively.

To enable Pandora streaming functionality, install the pianobar utility from AppCafe®. Once installed, restart Lumina Media Player to enable the P icon. Click it to switch to Pandora streaming, seen in Figure 5.10.2.

_images/lmediapl2.png

Fig. 5.10.2 Lumina Media Player: Pandora Settings

The Settings tab has a number of options for configuring your Pandora stream. You can log in to your account or click Need an account? to create a new Pandora account. There are also options to adjust Audio Quality, Audio Driver, and add Proxy URLs. Be sure to click Apply Settings. If the account information is valid, the Now Playing tab activates, seen in Figure 5.10.3.

_images/lmediapl3.png

Fig. 5.10.3 Lumina Media Player: Pandora Now Playing

The Now Playing tab offers a very basic Pandora interface, displaying the current song and station, and offering options to like songs, prevent a song from playing for a month, ban songs, and view more details about a song. You can also use the Plus and Minus icons to add or remove new radio stations.

5.11. lumina-notify

lumina-notify is a CLI-only utility designed to create simple QT dialog windows to improve user interactivity. When used in a shell script, lumina-notify launches QDialogs. Here is the syntax: lumina-notify [msgtxt] [accptbtntxt] [rjctbtntxt] [wndwttl].

Save this example and run it to see the full output:

#!/bin/csh
set a=`./lumina-notify "Did Jar Jar do anything wrong?" Yes No "Question"`
if ($a == 1) then
set b=`./lumina-notify "Are you sure?" Yes No "Are you Sure?"`
if ($b == 1) then
./lumina-notify "Please stop being a hater." Ok Ok "Haters gunna hate"
else
set c=`./lumina-notify "Thank you for changing your mind" OK OK "You're Awesome"`
endif
else
./lumina-notify "High Five for Darth Jar Jar" Sure OK "Respect"
endif`

5.12. 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 Preferences ‣ Display or type lumina-xconfig from a terminal window. This opens a screen similar to the one shown in Figure 5.12.1.

_images/lumina15b.png

Fig. 5.12.1 Configuring Monitors

In this example, two display inputs are attached to the system and the resolution for the selected input is displayed. If the display input supports multiple resolutions, these all appear in the Resolution drop-down menu to select a different resolution.

Underneath the Resolution drop-down menu the user is able choose the orientation of their screen. This may prove useful if the user orients their monitor vertically or upside down. Also, the user can make the selected input the primary screen by checking the Primary Screen box.

If another display is attached, the Add Screen tab is activated. On this tab the user can configure the new input resolution as well as make it the new system default.

Within the area the displays are listed, the user is able to drag each display. The arragement of the displays affect which borders switch between monitors.

Located in the top right of the window are two buttons. The top button refreshs the connected displays. The button below it disables the selected input.

The user is able to create several profiles. To create profiles, apply the appropriate settings and select “New Profile” from the Save drop-down menu. It then prompts the user to enter a name for the profile.

5.13. XDG-Entry

This Qt5 utility generates .desktop files and places them in the user’s home directory (/usr/home/[username]). Be sure to copy these files to the default location the operating system searches for .desktop files. As Figure 5.13.1 shows, there are numerous configurable elements:

_images/xdgentry1.png

Fig. 5.13.1 .Desktop Creator (XDG-Entry)

Name: The specific name of the new .desktop file.

Generic Name: This text in this field displays as a tooltip (when enabled).

Comment: Adds more descriptive text to the File Information.

Keywords: Simple word associations for the file.

Executable: Click Select to open the file browser and choose an application to associate with this file.

Icon: Click Select to open the file browser and choose an icon file to associate with this file.

Categories: Choose the category for this file.

Run in Terminal: Select this to open the file with the default terminal application.