You are on page 1of 35

ArcMenu User Manual v1.0.

3
A Traditional Application Menu for GNOME

ArcMenu is developed and maintained by @LinxGem33 and @AndrewZaech


Table of Contents
ArcMenu Default view (Section 1)..................................................................................................4
1. Change default view................................................................................................................4
Display ArcMenu On (Section 2)....................................................................................................5
1. Main Panel..............................................................................................................................5
2. Dash to Panel..........................................................................................................................5
3. Dash to Dock...........................................................................................................................5
Disable Tooltips (Section 3).............................................................................................................6
1. Tooltips....................................................................................................................................6
Modify Activities Hot Corner (Section 4).......................................................................................6
1. Configure the hot corner action...............................................................................................6
ArcMenu Hotkey (Section 5)...........................................................................................................7
1. Choose hotkey action..............................................................................................................7
2. Custom Hot key......................................................................................................................7
3. Modifying the hotkey..............................................................................................................7
ArcMenu Icon Settings (Section 1).................................................................................................8
1. Configure icon settings...........................................................................................................8
2. Icon settings explained............................................................................................................9
3. Changing the button icon text...............................................................................................10
4. Using a custom Icon..............................................................................................................10
Customize ArcMenu Appearance (Section 2)................................................................................10
1. Customizing elements of the menu.......................................................................................11
2. Miscellaneous options what they mean?...............................................................................12
2.1 Large application Icons.......................................................................................................12
2.2 Category Sub Menus...........................................................................................................12
2.3 Disable Category Arrows....................................................................................................12
Override ArcMenu Theme (Section 3)..........................................................................................13
1. Theme settings and colour presets........................................................................................13
2. Creating your Theme Preset..................................................................................................14
3. Managing Theme Presets......................................................................................................14
4. Sharing your Theme preset...................................................................................................14
Menu Layouts (Section 4)..............................................................................................................14
1. Menu layout chooser.............................................................................................................15
Configure Shortcuts (Section 1)....................................................................................................16
1. Configure directories shortcuts.............................................................................................17
2. Configure application shortcuts............................................................................................18
3. Configure session buttons.....................................................................................................19
4. Enable/Disable external devices and bookmark shortcuts....................................................20
5. HDD drives and Remote shares.................................................................................................20
1. CD/DVD...............................................................................................................................20
2. ISOs.......................................................................................................................................20
3. USB Thumb drives................................................................................................................20
4. ftp..........................................................................................................................................20
5. sftp.........................................................................................................................................20
6. Bookmarks............................................................................................................................20
Your pinned apps (Section 1).........................................................................................................21
1. Pinned apps...........................................................................................................................21
2. Add more apps......................................................................................................................22
3. Add custom shortcut..............................................................................................................22
Importing/Exporting Settings (Section 1)......................................................................................23
Importing/Exporting Settings....................................................................................................23
Importing/Exporting Themes (Section 2)......................................................................................24
Sharing or Importing/Exporting Themes..................................................................................24
About Tab (Section 1)....................................................................................................................25
1. ArcMenu Information...........................................................................................................25
Dependencies.................................................................................................................................26
1. Make file Dependences.........................................................................................................26
Distribution Specific Dependences................................................................................................26
1. If your running Debian/Ubuntu based distro........................................................................26
2. If your running Fedora..........................................................................................................27
3. If your running Arch based distro.........................................................................................27
Installation via Git using GitLab...................................................................................................28
1. Git Install Method.................................................................................................................28
2. Make File Check List............................................................................................................28
Alternative install method from source files..................................................................................29
1. Source Files Install method:..................................................................................................29
Install from Source Extended Information....................................................................................29
1. Install notes from GIT...........................................................................................................29
2. Install notes from GNOME extensions.................................................................................29
Install From GNOME Software Centre.........................................................................................30
1. Simply search for Arc Menu.................................................................................................30
2. Gnome Software extension page...........................................................................................30
Reporting Bugs on Gitab...............................................................................................................31
1. What Information to Report..................................................................................................31
2. Getting the Information from the Terminal...........................................................................31
Extended Information....................................................................................................................33
Extended Information from the ArcMenu wiki.........................................................................33
- How do i use ArcMenu with Dash to Panel?..........................................................................33
- How do i install ArcMenu from source?.................................................................................33
- I really like ArcMenu how do i help out?...............................................................................33
- What are ArcMenu's Dependencies and how do i install them?.............................................33
- I've got a problem with ArcMenu how do i report it?.............................................................33
- ArcMenu is not in my language how do i add my native language?......................................33
- What distributions with the Gnome desktop does ArcMenu support?...................................33
- Do you have video tutorials on how to use ArcMenu's features?...........................................33
- How do i use ArcMenu's new search feature?........................................................................33
- Does ArcMenu have an official website ?..............................................................................33
- How do i design a new colour preset for ArcMenu?..............................................................33
- Where can i download colour themes for ArcMenu?.............................................................33
- How do i design a new style preset for ArcMenu?.................................................................33
- What are the different menu layouts for ArcMenu?...............................................................33
- I've created a new style/colour preset for ArcMenu where do i post it?.................................33
Resources for GNOME extension Development...........................................................................34
GNOME developer centre.........................................................................................................34
Introduction to writing GTK+ 3 applications with Gjs.............................................................34
GNOME platform libraries.......................................................................................................34
GNOME GJS built-in modules and core API’s........................................................................34
SpiderMonkey JavaScript engine..............................................................................................34
GNOME Shell...........................................................................................................................35
GNOME Shell Extensions........................................................................................................35
GNU gettext and the free Translation Project...........................................................................35
ArcMenu General Tab
Settings Sections 1 - 5

ArcMenu Default view (Section 1)


1. Change default view

This option in the settings will allow you to choose between the pinned apps view and the
category view, just click the drop down to choose and Arc menu will display this view every
time you open the menu.
Display ArcMenu On (Section 2)
1. Main Panel

This option allows you to set and configure the position of ArcMenu when placed on the
GNOME main panel.

2. Dash to Panel

When you select to display ArcMenu on Dash to Panel you will have a few options
available automatically after selection, these include the ability to position the menu button
on the panel and also display ArcMenu on multiple monitors.

3. Dash to Dock

When you select to display ArcMenu on Dash to dock you will have the ability to disable
the activities button for a more integrated experience and similar to dash to panel you also
have the ability to display ArcMenu on multiple monitors.
Display on multiple monitors also works for the Ubuntu Dock
Disable Tooltips (Section 3)
1. Tooltips

The disable tooltips section will allow you to disable all menu tooltips for all menu layouts
Please note this will not disable tooltips for the settings window

Modify Activities Hot Corner (Section 4)


1. Configure the hot corner action

This section allows you to modify the hot corner action, by default this uses the GNOME
activities action but you can choose to;
• Disable
• Toggle ArcMenu
• Use custom terminal command
You can also choose from a set of preset commands or type your own terminal command
in the terminal command entry box.
ArcMenu Hotkey (Section 5)
1. Choose hotkey action

In this section you can choose to set ArcMenu’s hotkey to either GNOME’s default (none)
or set it to your left super key or right super key , you can also set a custom hotkey if
you are using the left or right super key for other uses to do this just click on the custom
hot key button.

2. Custom Hot key

The custom hotkey section allows you to modify the hot key to your own specific
combination and also gives you the ability to even choose how the hot key is activated it
will also display your current hot key combination (useful if you regularly set different hot
keys).

3. Modifying the hotkey


To modify your hot key to a custom key simply click on a modifier button and add your
preferred key combination or set your own combination the choice is yours.
ArcMenu Appearance Tab
Settings Sections 1 – 4

ArcMenu Icon Settings (Section 1)


1. Configure icon settings

This section allows you to configure the menu button and all related features to configure
just click on the settings cog.
2. Icon settings explained

Once you have clicked on the settings cog this window will be opened allowing you to
configure the different aspects of the menu button and icon parameters.
Don’t worry about changing any parameters as you can reset to defaults
by clicking the reset button
3. Changing the button icon text

When you first open this setting it might not be obvious at first glance how to change the
button icon text, you first need to choose Text from the drop down options then a entry box
will appear so you can add your custom text.

4. Using a custom Icon

Similar to the text option choosing a custom Icon is not obvious at first glance, you need
choose Custom Icon in the drop down options and a find Icon button will be made
available, then browse for your Icon by clicking on the find Icon button and choosing a Icon
on your system.

Customize ArcMenu Appearance (Section 2)

This section allows you to customize some of the elements of the menu both globally and
also specific elements.
1. Customizing elements of the menu
This section includes the ability to change the height and width along with other useful
features in the miscellaneous area.
2. Miscellaneous options what they mean?

When seeing these options for the first time you may not know exactly what they do, this
section will explain how they relate and when to apply these miscellaneous options.

2.1 Large application Icons


This option changes the search and application icons from small to large.

2.2 Category Sub Menus

The category sub menu option allows you to create nested submenus from within ArcMenu
without this option enabled you would have a long lists which in some cases can be quite
long, to avoid this and keep the proper structure enable the Category Sub Menu option.

2.3 Disable Category Arrows


This option removes the arrows that are located next to each category enable this option
to remove them.
Override ArcMenu Theme (Section 3)

This section is where you can have fun or tweak the menu theme to fit your current GTK
theme.
" Here you can design and create practically an unlimited number of preset theme
combinations to suite your style and personality, "
Don't worry about making any mistakes you can reset to defaults at any
time.

1. Theme settings and colour presets


2. Creating your Theme Preset
• Firstly toggle on the override ArcMenu theme option then click the settings cog
• Then create your desired theme using our theme creator
• Once you have created your theme click the save preset button to add it to the
preset list

3. Managing Theme Presets


Once you have created lots of cool theme presets we have also given you the ability to
manage those colour preset themes by clicking on the Manage Presets button,
" This will allow you to rearrange your themes delete them or simply edit the names giving
you the creative freedom to design some really unique themes. "
• Rearrange your presets
• Delete presets
• Edit your presets name

4. Sharing your Theme preset


We have even developed a custom architecture to allow individuals or 3rd party's to
share their designs using our custom developed preset import and export themes section
on ArcMenu's settings via the newly created misc tab.

Menu Layouts (Section 4)

This section is where you can choose a wide selection of different menu layout styles, this
is useful if you prefer a different layout from another desktop environment but is not
available on GNOME.
1. Menu layout chooser

To access the different menu layouts click on the menu layout settings cog to activate the
menu layout chooser here you can choose from a wide variety of layouts to suite your style
or need, each menu layout comes with its own specific tweaks section where you can
tweak a specific function for your chosen menu layout.
ArcMenu Shortcuts Tab
Settings Sections 1 – 2

Configure Shortcuts (Section 1)

This section is where you can configure the right panel shortcuts and session buttons.
1. Configure directories shortcuts

Once you have clicked on the configure shortcuts cog you will then see the shortcuts
configuration window, here you can configure 3 main sections;
• Directories
• Applications
• Session Buttons
Each section corresponds to the different sections on the right panel of ArcMenu and
various other menu layouts, you can add new directories or custom the choice is yours just
click on the appropriate section.
2. Configure application shortcuts

This section allows you to configure applications on the right panel add, create custom,
edit or delete, you can manage the applications shortcuts on this tab.
3. Configure session buttons

The enable/disable session buttons allows you to disable any of the session buttons on the
right hand side of the menu panel, just toggle the switch to enable or disable a particular
button.
4. Enable/Disable external devices and bookmark shortcuts

The enable/disable external devices and bookmark shortcuts allows you to display any of
your external devices and bookmarks on the right hand side of the menu panel, just toggle
the switch to enable or disable this shortcut.

5. HDD drives and Remote shares


1. CD/DVD
Display your CD/DVD drives from ArcMenu from here you can access your drive or
unmount

2. ISOs
Display your ISO’s from ArcMenu from here you can access your ISO or unmount

3. USB Thumb drives


Connect any of your thumb drives or portable drives once mounted you can access the
information directly from the menu or unmount your device

4. ftp
Access your ftp from directly within the menu just create your ftp share and make a
shortcut available then enable it

5. sftp
Access your sftp from directly within the menu just create your ftp share and make a
shortcut available then enable it

6. Bookmarks
Create bookmarks in nautilus and display them directly in ArcMenu by enabling bookmarks
in ArcMenu settings
ArcMenu Pinned Apps Tab
Settings Sections 1 – 3

Your pinned apps (Section 1)

1. Pinned apps
The your pinned apps section allows you to view which apps you have pinned to the
menu, in this section you can remove apps re order your apps or remove your apps.
2. Add more apps
• The add more apps section allows you to choose which apps you want to be pinned
to your menu, just click on the [+] icon to bring up the dialogue box below and
choose your apps.

3. Add custom shortcut


• The add custom shortcut section allows you to add a custom app to the menu, just
click on the [+] icon to bring up the dialogue box below and fill in the boxes to add
your app.
ArcMenu Misc Tab
Settings Sections 1 – 2

Importing/Exporting Settings (Section 1)

Importing/Exporting Settings
Only settings regarding setup will be imported or exported such as pinned apps or
predefined parameters such as font size etc.
• Simply click on the export or import button
• Choose your location to export or import and that's it
Importing/Exporting Themes (Section 2)

Sharing or Importing/Exporting Themes

Only settings regarding theme creation will be imported or exported such as colour
HUE Hex colours or predefined parameters such as font size etc.
• Simply click on the export/import themes button
• Choose your theme/s to export or import and that's it
ArcMenu About Tab
Settings Sections 1

About Tab (Section 1)


1. ArcMenu Information
On this area of the tab you can find information about what version of Arc menu you are
using
you will also find a link to the project page on GitLab and also information about
developers translators and contributors under the link
you will also find a link to the GNU Public licence as published by the free software
foundation.
Arc Menu Dependencies
Getting ArcMenu GNOME extension working

Dependencies
Please note: For ArcMenu to work properly, your GNOME Desktop must have the
following dependencies installed (please see below).

1. Make file Dependences


Please Note: You may have problems on Debian when using the included makefile to
install ArcMenu from source as Debian doesn't have gettext libgettextpo-dev installed by
default which is Needed to get the makefile to work properly.
• To install use the command below;
sudo apt-get install gettext libgettextpo-dev

Distribution Specific Dependences

1. If your running Debian/Ubuntu based distro...

sudo apt install gnome-shell-extensions

sudo apt install gnome-tweak-tool

sudo apt install gnome-menus

sudo apt-get install gir1.2-gmenu-3.0 (`optional`)


2. If your running Fedora...

sudo dnf install gnome-shell-extensions

sudo dnf install gnome-tweak-tool

sudo dnf install gnome-menus

3. If your running Arch based distro..

sudo pacman -S gnome-shell-extensions

sudo pacman -S gnome-tweak-tool

sudo pacman -S gnome-menus


Install From Source Guide
Install via GIT or Source Files

Installation via Git using GitLab


• Probably, the simplest way to install Arc Menu from source is using git, make.

1. Git Install Method

A `Makefile` is included. Then all you have to do is run the command below

git clone https://gitlab.com/LinxGem33/Arc-Menu.git

cd Arc-Menu

make install

Alt + F2 and enter r

2. Make File Check List


• To install the extension in your home directory. A Shell reload is required and the
extension may need to be enabled with gnome-tweak-tool or with dconf.
Please Note: You may have problems on Debian when using the included makefile as
Debian doesn't have gettext libgettextpo-dev installed by default which is Needed to get
the makefile to work properly.
• To install use the command below;
sudo apt-get install gettext libgettextpo-dev
Alternative install method from source files
• Please remove any version of Arc menu before installing from source.

1. Source Files Install method:

1. Download from Arc menu master branch

• Arc menu master branch .Zip file


2. Extract the .Zip

3. Open Arc menu folder

4. Open terminal within the folder

5. Run `make install`

6. Reload GNOME shell (`Alt+F2`, `r`, `Enter`)

Install from Source Extended Information


1. Install notes from GIT
When running make install any previously installed version of ArcMenu will be uninstalled
automatically so no need for a make uninstall command any more

2. Install notes from GNOME extensions


When you install from GNOME extensions any previously installed version will be
uninstalled automatically and replaced with the current stable official version.
Install ArcMenu from GNOME
Software
GNOME Software Centre

Install From GNOME Software Centre


1. Simply search for Arc Menu
• Simply search for Arc Menu - in Gnome software and once located click on the
result and then simply install, you can also open Arc Menus settings from here and
also remove Arc Menu from your system.

2. Gnome Software extension page


• Arc Menu extension page - on Gnome software
Reporting Bugs
How to Report Bugs on the GitLab issue Tracker

Reporting Bugs on Gitab


Please Note: that without any information about your system, the Arc Menu Team can only
speculate what the problem is. So, please provide us information about your GNU/Linux
distribution and the GNOME Shell version. Otherwise, we are not able to try and solve
your problem.

1. What Information to Report

• Please make sure you include basic information before logging your issue we
would need gnome-shell version your OS release info and finally logs from the
systemd journal to track any errors that Arc menu may have, the commands are
below please do this when you restart your system.

2. Getting the Information from the Terminal


Below you will see 3 terminal commands that will help determine information about your
GNU/Linux distribution and the GNOME Shell version and the last command will give logs
from the systemd journal, which will allow the ArcMenu team to get basic setup and error
information to help us diagnose your issue.

1. lsb_release -a

2. gnome-shell --version

3. journalctl /usr/bin/gnome-shell -f -o cat


Useful ArcMenu Wiki Links
Extended Information from the ArcMenu wiki

Extended Information
Extended Information from the ArcMenu wiki

- How do i use ArcMenu with Dash to Panel?

- How do i install ArcMenu from source?

- I really like ArcMenu how do i help out?

- What are ArcMenu's Dependencies and how do i install them?

- I've got a problem with ArcMenu how do i report it?

- ArcMenu is not in my language how do i add my native language?

- What distributions with the Gnome desktop does ArcMenu support?

- Do you have video tutorials on how to use ArcMenu's features?

- How do i use ArcMenu's new search feature?

- Does ArcMenu have an official website ?

- How do i design a new colour preset for ArcMenu?

- Where can i download colour themes for ArcMenu?

- How do i design a new style preset for ArcMenu?

- What are the different menu layouts for ArcMenu?

- I've created a new style/colour preset for ArcMenu where do i post it?
Extension Developer Resources
Resources for GNOME extension Development

Resources for GNOME extension Development


GNOME developer centre
https://developer.gnome.org/ (recommended resource)
• GNOME developer centre! Here you will find all the information that you need to
create fantastic software using GNOME technologies.

Introduction to writing GTK+ 3 applications with Gjs


https://gjs-tutorial.readthedocs.io/en/latest/
• This tutorial gives an introduction to writing GTK+ 3 applications with Gjs. It is an
adaption and extension of another tutorial written about GTK+ 3 development in
Python.

GNOME platform libraries


https://gitlab.gnome.org/GNOME/gjs
• Use the GNOME platform libraries in your JavaScript programs. GJS powers
GNOME Shell, Polari, GNOME Documents, and many other apps. Under the hood
it uses SpiderMonkey, Mozilla's JavaScript engine originally developed for Firefox.

GNOME GJS built-in modules and core API’s


https://gitlab.gnome.org/GNOME/gjs/wikis/Home
• GJS includes some built-in modules like Cairo and Gettext, as well as helpers for
some core APIs like DBus and Variants. See the Modules page for an overview of
the built-in modules and their usage.

SpiderMonkey JavaScript engine


https://github.com/spidermonkey-embedders/spidermonkey-embedding-examples
• This repository contains documentation and examples for people who want to
embed the SpiderMonkey JavaScript engine.
https://github.com/spidermonkey-embedders/spidermonkey-embedding-examples/tree/
esr60/docs
• In this directory you will find documentation pages with explanations of core
SpiderMonkey concepts, and how-to pages.

GNOME Shell
https://gitlab.gnome.org/GNOME/gnome-shell
• GNOME Shell provides core user interface functions for the GNOME 3 desktop,
like switching to windows and launching applications. GNOME Shell takes
advantage of the capabilities of modern graphics hardware and introduces
innovative user interface concepts to provide a visually attractive and easy to use
experience.

GNOME Shell Extensions


https://gitlab.gnome.org/GNOME/gnome-shell-extensions
• GNOME Shell Extensions is a collection of extensions providing additional and
optional functionality to GNOME Shell.

GNU gettext and the free Translation Project


http://www.gnu.org/software/gettext/manual/gettext.html
• GNU gettext and the free Translation Project it explains a few broad concepts
around Native Language Support, and positions message translation with regard to
other aspects of national and cultural variance, as they apply to programs. It also
surveys those files used to convey the translations. It explains how the various tools
interact in the initial generation of these files, and later, how the maintenance cycle
should usually operate.

You might also like