Skip to content

rweckert/vAlias

Repository files navigation

vAlias

A simple alias viewing and backup utility.

Script Purpose as a Tool:

Provides simplicity in viewing alias file entries. Allows for sorting the alias file by name or command. When viewing alias entries, option for Backup, Save As, and Edit Copy are available. Open the terminal window from the main menu to test any system changes that you have made directly. NOTE: The script vAlias does not directly edit any system files. The vAlias script makes a copy of the ".bash_aliases" file to a temporary folder for viewing, opening, editing and saving.

vAlias Screenshot

Setup:

  1. Please review "Common System Requirements" and "Critical System Requirements" sections below for basic and critical requirements to run this script successfully.
  2. Save the vAlias.sh file to a directory.
  3. Make the vAlias.sh script executable by running the following command in the same directory as the vAlias.sh file:
    chmod +x vAlias.sh

Features:

  • Easily view and sort alias commands.
  • Backup current alias command list.
  • Edit a copy of the alias command list.
  • Save the alias command list as a separate file.
  • Refresh the alias view as you make direct changes.
  • Copy a selected alias command to the system clipboard.
  • Open the terminal to test alias changes from the menu.
  • Specify the command used to open a terminal session.
  • Use the 'F1' key for documentation from any main window.

Typical Usage:

Upon opening the vAlias script, click on the option for "View Alias". This will show you a list of all alias commands from a copied ".bash_aliases" file. Easily sort, save, and edit as needed. A double click on a alias command entry will show you the details of that command where you can copy the command to the system clipboard. Open the terminal using the "Terminal" option where you can test your direct changes.

Detailed Options and Usage:

Main Menu: When running the vAlias script the main menu will appear with the following options:
- View Alias: Opens the "Alias View" window showing all alias commands.
- Refresh: Updates the Alias Detail view window and displays any changes.
- Terminal: Opens the terminal window. Change the command that opens the terminal window using the "Settings" option.
- Settings: Customize the command that opens the terminal window.
- Theme: Options will allow you to select a theme for vAlias.
- Help: Opens vAlias documentation.
- Exit: Closes all vAlias windows and menus.

View Alias Window:

This window displays all the alias commands from the ".bash_aliases" file. Options and features are as follows:
- Double Click: Perform a double click on a listed alias command to open the vAlias Detail window.
- Backup: Allows the user to select a directory to backup a copy of all alias commands.
- Save As: Save a copy of the ".bash_aliases" file into a directory specified.
- Edit Copy: Opens a copy of the ".bash_aliases" file in the default text editor.
- Help: Opens help documentation.
- Close: Closes the "vAlias-View" window.

vAlias Detail Window:

Double clicking on a listed alias command from the "vAlias-View" window will open the "vAlias Detail" window with the following options:
- Copy Alias: Copies the listed alias command to the system clipboard.
- Close Detail: Closes the "vAlias Detail" window.

vAlias Settings:

This window allows you to customize the command used to open the terminal window:
- Set Terminal Command: Enter the command used to open the terminal window of your choice when using the "Terminal" option from the main menu.
- Save Command: Saves the command entered for future use.
- Cancel Entry: Closes the "vAlias Settings" window without saving changes.

Theme Options:

The "Theme" main menu option allows the user to change settings for the theme being used, as well as access to "Help" and "About" options.
- Load Theme: Allows the user to browse their system for a theme to use.
- Apply Loaded Theme: Applies the loaded theme. Once selected the Options window will close and re-open showing the theme selected in use.
- Mode: Select basic system theme available in the system for "Light Theme" or "Dark Theme". This default uses the "Breeze" theme package located in the "/usr/share/themes/" folder.
- Apply System Theme: Applies the Mode selected for either "Light Theme" or "Dark Theme". Once selected the Options window will close and re-open showing the theme selected in use.
- Browse Themes Folder: Browse the default themes folder "/usr/share/themes/".
- Help: Opens gMapping help documentation.
- About: Opens the about window showing script credits.
- Close: Closes the "Options" window.

Notes:

  • vAlias can be ran from any directory.
  • vAlias uses the /tmp/ folder for temporary and .ini files.
  • If the ".bash_aliases" file does not exist the utility will not display any alias commands.
  • Use the 'F1' key for documentation from any main window.

vAlias Shortcut File:

Save the following as a file named "vAlias.desktop" in creating a shortcut to this utility. Update the path for "Exec" to where the script is stored:
[Desktop Entry]
Name=vAlias
GenericName=vAlias
Comment=A simple alias viewing and backup utility.
Exec=/PathToScript/vAlias.sh
Type=Application
Icon=gtk-zoom-fit
Terminal=false

Common System Requirements:

Common shell commands found in most Linux installations are used to provide system functionalilty for this and other scripts shared from this profile. For thoroughness, these common shell commands are listed in alphabetical order with version and man page link for review: https://github.com/rweckert/vAlias/blob/07e596423567771d7b7c8428ae76c4e5d744ba91/README-Basic-Requirements.md

Critical System Requirements:

Packages listed below provide the core ingredients for graphic display and desired output that enables vAlias to deliver output and are critical for successful execution of the the script:

Package Version Notes
yad 14.0+ (GTK+ 3.24.41) A tool for developing graphical user interfaces in Linux and is used by this script to generate menus and dialog windows, is written by Victor Ananjevsky. Download: https://github.com/v1cont/yad Setup: Step by step instructions are available for either Linux or Microsoft Windows Subsystem for Linux (WSL) using a Debian base: https://github.com/rweckert/yad-14.0-Setup-From-Scratch

Closing:

Script interface written by: Robert W. Eckert - rweckert@gmail.com Please feel free to email to submit bugs, changes or requests. This script comes with absolutely no warranty. See the link for the GNU General Public License, version 3 or later listed below for further details.


Project Contents:

Project Page:
https://github.com/rweckert/vAlias
Source File:
https://github.com/rweckert/vAlias/blob/5a9b0187198c4743d73f15f4b4fd70f8b794bb28/vAlias.sh
Documentation File:
https://github.com/rweckert/vAlias/blob/5a9b0187198c4743d73f15f4b4fd70f8b794bb28/README.md
Project Screenshot:
https://github.com/rweckert/vAlias/blob/5a9b0187198c4743d73f15f4b4fd70f8b794bb28/screenshot-vAlias.jpg
Project Licensing:
https://github.com/rweckert/vAlias/blob/eed51547e49903df6f96930daf54f03dbcb62838/LICENSE
GitHub Profile Page:
https://github.com/rweckert

About

A simple alias viewing and backup utility.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages