Difference between revisions of "Guake"

From ArchWiki
Jump to: navigation, search
m (s/throubleshooting/troubleshooting/)
 
(37 intermediate revisions by 20 users not shown)
Line 1: Line 1:
 
[[Category:Terminal emulators]]
 
[[Category:Terminal emulators]]
 +
[[de:Guake]]
 +
[[ja:Guake]]
 
[[ru:Guake]]
 
[[ru:Guake]]
{{Expansion}}
+
{{Related articles start}}
 
+
{{Related|GNOME}}
{{Article summary start}}
+
{{Related articles end}}
{{Article summary text|This article demonstrates the installation of Guake}}
+
[http://guake-project.org/ Guake] is a top-down terminal for [[GNOME]] (in the style of [[Yakuake]] for [[KDE]], [[Tilda]] or the terminal used in Quake).
{{Article summary end}}
 
 
 
[http://guake.org Guake] is a top-down terminal for [[GNOME]] (in the style of Yakuake for [[KDE]], [[Tilda]] or the terminal used in Quake).
 
  
 
== Installation ==
 
== Installation ==
  
[[pacman|Install]] {{pkg|guake}}, available in the [[official repositories]].
+
[[Install]] {{Pkg|guake}}, available in the [[official repositories]].
  
Also the development version is available and in the [[Arch User Repository|AUR]]: {{AUR|guake-git}}.
+
== Usage ==
  
==Usage==
 
 
Once installed, you can start Guake from the terminal with:
 
Once installed, you can start Guake from the terminal with:
  
 
  $ guake
 
  $ guake
  
After guake has started you can right click on the interface and select Preferences to change the hotkey to drop the terminal automatically, by default it is set to F12.
+
After guake has started you can right click on the interface and select ''Preferences'' to change the hotkey to drop the terminal automatically, by default it is set to {{ic|F12}}.
 +
 
 +
Also, you can adjust many of the Guake preferences with ''gconf-editor'' tool under ''apps > guake''. If it's not enough for you, you are always free to copy the ''guake'' executable ({{ic|/usr/bin/guake}}) to {{ic|/usr/local/bin/guake}} and edit it in text editor, since it's just a [[Python]] script. Remember to make the file executable.
  
 
== Autostartup ==
 
== Autostartup ==
  
 
You may want Guake to load on starting up Desktop Environment. To do this, you need to
 
You may want Guake to load on starting up Desktop Environment. To do this, you need to
{{bc|# cp /usr/share/applications/guake.desktop /etc/xdg/autostart/}}
+
# cp /usr/share/applications/guake.desktop /etc/xdg/autostart/
 +
 
 +
See [[Autostarting]] for more info.
 +
 
 +
== Guake scripting ==
 +
 
 +
Like [[Yakuake]], Guake allows to control itself at runtime by sending the [[D-Bus]] messages. Thus it can be used to start Guake in a user defined session. You can create tabs, assign names for them and also ask to run any specific command in any opened tab or just to show/hide Guake window, manually in a terminal or by creating a custom script for it.
 +
 
 +
Example of such a script is given below this section.
 +
 
 +
You can use ''guake'' executable itself to send D-Bus messages. Here is the list of available options you may be interested in:
 +
 
 +
* {{ic|-t}}, {{ic|--toggle-visibility}} — toggle the visibility of the terminal window. Actually, you can just type {{ic|guake}}, and it will toggle the visibility of already running instance.
 +
* {{ic|-f}}, {{ic|--fullscreen}} — put Guake to fullscreen mode.
 +
* {{ic|--show}} — show Guake main window.
 +
* {{ic|--hide}} — hide Guake main window.
 +
* {{ic|-n ''CUR_DIR''}}, {{ic|1=--new-tab=''CUR_DIR''}} — create new tab and select it. Value of {{ic|CUR_DIR}} used to set a current directory for the tab, if specified.
 +
* {{ic|-s ''INDEX''}}, {{ic|1=--select-tab=''INDEX''}} — select tab with index {{ic|INDEX}}. Tab indexes are started with 0.
 +
* {{ic|-g}}, {{ic|--selected-tab}} — print index of currently selected tab.
 +
* {{ic|-e ''CMD''}}, {{ic|1=--execute-command=''CMD''}} — execute an arbitrary command {{ic|CMD}} in the selected tab.
 +
* {{ic|-i ''INDEX''}}, {{ic|1=--tab-index=''INDEX''}} — used with {{ic|--rename-tab}} to specify index {{ic|INDEX}} of a tab to rename. Default value is 0.
 +
* {{ic|1=--rename-tab=''TITLE''}} — set the tab name to {{ic|TITLE}}. You can reset tab title to default value by passing a single dash ({{ic|"-"}}). Use {{ic|-i}} option to specify which tab to rename.
 +
* {{ic|1=--bgcolor=''RGB''}} — set the hexadecimal ({{ic|#rrggbb}}) background color {{ic|RGB}} of the selected tab.
 +
* {{ic|1=--fgcolor=''RGB''}} — set the hexadecimal ({{ic|#rrggbb}}) foreground color {{ic|RGB}} of the selected tab.
 +
* {{ic|-r ''TITLE''}}, {{ic|1=--rename-current-tab=''TITLE''}} — same as {{ic|--rename-tab}}, but renames the currently selected tab.
 +
* {{ic|-q}}, {{ic|--quit}} — shutdown running Guake instance.
 +
 
 +
Multiple options may be combined in a single call. If there's no guake instance running, all of the options specified will be applied to the newly created instance.
 +
 
 +
To display list of all available options, type {{ic|guake --help}}.
 +
 
 +
There are 2 ways of starting guake while applying these scripts
 +
* copying the below example into a file like {{ic|guake-init.sh}} making it executable and running that file instead of guake
 +
* right clicking on {{ic|Guake Terminal > Preferences > General}} and adding the path to the {{ic|guake-init.sh}} script in the "Path to script executed on Guake start:" section while making certain to comment out {{ic|/usr/bin/guake &}} from the script below
 +
 
 +
The second option is preferable if you want the script to run regardless of how guake is started and you can still instruct guake not to run the script with {{ic|guake --no-startup-script}} if needed.
 +
 
 +
Example:
  
== Window width ==
+
#!/bin/bash
 +
 +
/usr/bin/guake &
 +
sleep 5 # let main guake process start and initialize D-Bus session
 +
 +
# adjust tab which was opened by default
 +
guake --rename-tab="iotop" --execute="/usr/bin/iotop"
 +
 +
# create new tab, start bash session in it
 +
guake --new-tab --execute="/usr/bin/bash"
 +
# and then execute htop, renaming the tab to "htop"
 +
guake --execute="/usr/bin/htop" --rename-current-tab="htop"
 +
 +
# ...
 +
guake --new-tab --execute="/usr/bin/bash"
 +
guake --execute="/usr/bin/atop" --rename-current-tab="atop"
 +
 +
guake --new-tab --execute="/usr/bin/bash"
 +
guake --execute="~/.iptables.sh" --rename-current-tab="iptables -nvL"
 +
 +
guake --new-tab --execute="/usr/bin/bash"
 +
guake --execute="/usr/bin/journalctl --follow --full" --rename-current-tab="journalctl"
 +
 +
guake --new-tab --execute="/usr/bin/bash"
 +
guake --execute="/usr/bin/irssi" --rename-current-tab="irssi"
 +
 +
guake --new-tab --execute="/usr/bin/bash"
 +
guake --execute="/usr/bin/sudo -i" --rename-current-tab="rootshell0"
 +
 +
guake --new-tab --execute="/usr/bin/bash"
 +
guake --execute="/usr/bin/sudo -i" --rename-current-tab="rootshell1"
 +
 +
guake --new-tab --execute="/usr/bin/bash"
 +
guake --rename-current-tab="shell0"
 +
 +
guake --new-tab --execute="/usr/bin/bash"
 +
guake --rename-current-tab="shell1"
  
Guake takes all the width of your display by default and there's no such option in "Preferences". To change width you can edit the program itself which is [[Python|python]] script.
+
Notice than we should wait some time calling ''sleep'' to avoid race conditions between running instances.
{{bc|# nano /usr/bin/guake}}
+
{{Warning|{{ic|--execute}} option can make harmful things on a tab running text interface program, like {{ic|fdisk}} or {{ic|innotop}}. Use it with caution. There is a bug on github about it: [https://github.com/Guake/guake/issues/921 guake#921].}}
  
Find that string
+
== Using Guake on multiple monitors ==
  
{{bc|width = 100}}
+
There are two GConf options allowing you to change the screen on which Guake window will appear:
  
It is width value in percents, change it to whatever you like.
+
* {{ic|/apps/guake/general/display_n}} — display to appear on if the {{ic|mouse_display}} option is not set. If this is set to an invalid value (as in the case of removing a screen from a system), the invalid value is automatically updated to the current primary screen.
  
If you want to align new "narrowed" window left or right find string
+
* {{ic|/apps/guake/general/mouse_display}} — appear on the mouse display. This overrides any setting in {{ic|display_n}}.
  
{{bc|if halignment == ALIGN_CENTER:}}
+
Use some tool like ''gconf-editor'' to edit GConf options.
  
and replace CENTER with LEFT or RIGHT.
+
== Troubleshooting ==
  
== 'Ctrl' Keybind Problem ==
+
=== 'Ctrl' keybind problem ===
  
As of {{pkg|guake}} 0.4.2-7, there has been a noted bug affecting multiple users concerning the use of the 'Ctrl' key on the Keyboard Shortcuts to toggle guake visibility in the "Keyboard shortcuts" tab of guake-prefs (i.e. Users that setup 'Ctrl+Shift+z' to open the guake console can open it by pressing 'Shift+z', hence having the Ctrl key-bind irrelevant.
+
As of {{Pkg|guake}} 0.4.2-7 there has been a noted bug affecting multiple users concerning the use of the {{ic|Ctrl}} key to toggle Guake window visibility (i.e. users that setup {{ic|Ctrl+Shift+z}} to open the guake console are able to open it by just pressing {{ic|Shift+z}}, independent on whether {{ic|Ctrl}} key has been pressed).
  
There is a bug in the program that stores the settings in Toggle Guake Visibility that places the Ctrl string as "<Primary>" instead of "<Control>".
+
To solve the problem you should manually fix the value of the GConf key {{ic|/apps/guake/keybindings/global/show_hide}}. Open a ''gconf-editor'', navigate to ''apps > guake > keybindings > global > show_hide'' and replace {{ic|<Primary>}} with {{ic|<Control>}}.
  
The workaround is to use the command-line gconftool-2 from {{pkg|gconf}} package, get the current string shortcut string from /apps/guake/keybindings/global/show_hide, and replace all instances of "<Primary>" to "<Control>".
+
=== In Floating WM ===
  
To get what the current keyboard shortcut string is:
+
If you are using Tilda and a floating WM, you may find out that you can use class string "Tilda" to set the window keep floating. But that Guake's WM_CLASS(STRING)'s out put is "Main.py", so you should use "Main.py" to do this. For example, in i3wm, add this to your .i3/config:
{{bc|# gconftool-2 -g /apps/guake/keybindings/global/show_hide}}
 
  
To activate the guake console with Ctrl+Shift+z for example:
+
for_window [class="Main.py"] floating enable
{{bc|# gconftool-2 -t string -s /apps/guake/keybindings/global/show_hide "<Control><Shift>z"}}
 
  
It would be easier to use the graphical gconftool equivalent {{pkg|gconf-editor}} to browse for and edit the /apps/guake/keybindings/global/show_hide string. Replace "<Primary>" in the string with "<Control>".
+
== See also ==
  
Alternatively you can use this script to replace instances of <Primary> with <Control> in the /apps/guake/keybindings/global/show_hide string:
+
* {{man|1|guake}}
{{hc|~/replaceit.sh
 
|#! /bin/bash
 
|2=<nowiki>if which gconftool-2 &> /dev/null
 
then
 
  val=$(printf "%s" $(gconftool-2 -g /apps/guake/keybindings/global/show_hide))
 
  newval=${val/"<Primary>"/"<Control>"}
 
  if [ "$newval" = "$val" ]
 
    then echo "No changes made. Could not find or replace <Primary> in your settings."
 
  else
 
    echo "Replacing old string $val with new string:$newval"
 
    gconftool-2 -t string -s /apps/guake/keybindings/global/show_hide "$newval"
 
  fi
 
else
 
  echo "gconftool-2 not found. Please install gconf. Exiting..."
 
fi</nowiki>}}
 

Latest revision as of 00:27, 24 September 2017

Guake is a top-down terminal for GNOME (in the style of Yakuake for KDE, Tilda or the terminal used in Quake).

Installation

Install guake, available in the official repositories.

Usage

Once installed, you can start Guake from the terminal with:

$ guake

After guake has started you can right click on the interface and select Preferences to change the hotkey to drop the terminal automatically, by default it is set to F12.

Also, you can adjust many of the Guake preferences with gconf-editor tool under apps > guake. If it's not enough for you, you are always free to copy the guake executable (/usr/bin/guake) to /usr/local/bin/guake and edit it in text editor, since it's just a Python script. Remember to make the file executable.

Autostartup

You may want Guake to load on starting up Desktop Environment. To do this, you need to

# cp /usr/share/applications/guake.desktop /etc/xdg/autostart/

See Autostarting for more info.

Guake scripting

Like Yakuake, Guake allows to control itself at runtime by sending the D-Bus messages. Thus it can be used to start Guake in a user defined session. You can create tabs, assign names for them and also ask to run any specific command in any opened tab or just to show/hide Guake window, manually in a terminal or by creating a custom script for it.

Example of such a script is given below this section.

You can use guake executable itself to send D-Bus messages. Here is the list of available options you may be interested in:

  • -t, --toggle-visibility — toggle the visibility of the terminal window. Actually, you can just type guake, and it will toggle the visibility of already running instance.
  • -f, --fullscreen — put Guake to fullscreen mode.
  • --show — show Guake main window.
  • --hide — hide Guake main window.
  • -n CUR_DIR, --new-tab=CUR_DIR — create new tab and select it. Value of CUR_DIR used to set a current directory for the tab, if specified.
  • -s INDEX, --select-tab=INDEX — select tab with index INDEX. Tab indexes are started with 0.
  • -g, --selected-tab — print index of currently selected tab.
  • -e CMD, --execute-command=CMD — execute an arbitrary command CMD in the selected tab.
  • -i INDEX, --tab-index=INDEX — used with --rename-tab to specify index INDEX of a tab to rename. Default value is 0.
  • --rename-tab=TITLE — set the tab name to TITLE. You can reset tab title to default value by passing a single dash ("-"). Use -i option to specify which tab to rename.
  • --bgcolor=RGB — set the hexadecimal (#rrggbb) background color RGB of the selected tab.
  • --fgcolor=RGB — set the hexadecimal (#rrggbb) foreground color RGB of the selected tab.
  • -r TITLE, --rename-current-tab=TITLE — same as --rename-tab, but renames the currently selected tab.
  • -q, --quit — shutdown running Guake instance.

Multiple options may be combined in a single call. If there's no guake instance running, all of the options specified will be applied to the newly created instance.

To display list of all available options, type guake --help.

There are 2 ways of starting guake while applying these scripts

  • copying the below example into a file like guake-init.sh making it executable and running that file instead of guake
  • right clicking on Guake Terminal > Preferences > General and adding the path to the guake-init.sh script in the "Path to script executed on Guake start:" section while making certain to comment out /usr/bin/guake & from the script below

The second option is preferable if you want the script to run regardless of how guake is started and you can still instruct guake not to run the script with guake --no-startup-script if needed.

Example:

#!/bin/bash

/usr/bin/guake &
sleep 5 # let main guake process start and initialize D-Bus session

# adjust tab which was opened by default
guake --rename-tab="iotop" --execute="/usr/bin/iotop"

# create new tab, start bash session in it
guake --new-tab --execute="/usr/bin/bash"
# and then execute htop, renaming the tab to "htop"
guake --execute="/usr/bin/htop" --rename-current-tab="htop"

# ...
guake --new-tab --execute="/usr/bin/bash"
guake --execute="/usr/bin/atop" --rename-current-tab="atop"

guake --new-tab --execute="/usr/bin/bash"
guake --execute="~/.iptables.sh" --rename-current-tab="iptables -nvL"

guake --new-tab --execute="/usr/bin/bash"
guake --execute="/usr/bin/journalctl --follow --full" --rename-current-tab="journalctl"

guake --new-tab --execute="/usr/bin/bash"
guake --execute="/usr/bin/irssi" --rename-current-tab="irssi"

guake --new-tab --execute="/usr/bin/bash"
guake --execute="/usr/bin/sudo -i" --rename-current-tab="rootshell0"

guake --new-tab --execute="/usr/bin/bash"
guake --execute="/usr/bin/sudo -i" --rename-current-tab="rootshell1"

guake --new-tab --execute="/usr/bin/bash"
guake --rename-current-tab="shell0"

guake --new-tab --execute="/usr/bin/bash"
guake --rename-current-tab="shell1"

Notice than we should wait some time calling sleep to avoid race conditions between running instances.

Warning: --execute option can make harmful things on a tab running text interface program, like fdisk or innotop. Use it with caution. There is a bug on github about it: guake#921.

Using Guake on multiple monitors

There are two GConf options allowing you to change the screen on which Guake window will appear:

  • /apps/guake/general/display_n — display to appear on if the mouse_display option is not set. If this is set to an invalid value (as in the case of removing a screen from a system), the invalid value is automatically updated to the current primary screen.
  • /apps/guake/general/mouse_display — appear on the mouse display. This overrides any setting in display_n.

Use some tool like gconf-editor to edit GConf options.

Troubleshooting

'Ctrl' keybind problem

As of guake 0.4.2-7 there has been a noted bug affecting multiple users concerning the use of the Ctrl key to toggle Guake window visibility (i.e. users that setup Ctrl+Shift+z to open the guake console are able to open it by just pressing Shift+z, independent on whether Ctrl key has been pressed).

To solve the problem you should manually fix the value of the GConf key /apps/guake/keybindings/global/show_hide. Open a gconf-editor, navigate to apps > guake > keybindings > global > show_hide and replace <Primary> with <Control>.

In Floating WM

If you are using Tilda and a floating WM, you may find out that you can use class string "Tilda" to set the window keep floating. But that Guake's WM_CLASS(STRING)'s out put is "Main.py", so you should use "Main.py" to do this. For example, in i3wm, add this to your .i3/config:

for_window [class="Main.py"] floating enable

See also