This is just a suggestion to make your README more beautiful using Markdown Syntax.
yakuake-session - A script to create new yakuake sessions from command-line.
Copyright 2010-2013 Jesús Torres <[email protected]>
## What is yakuake-session?
yakuake-session is a Bash script that allows to create new sessions in Yakuake
terminal emulator from command line. I made it mainly to get a better
integration of Yakuake in KDE desktop environment. For example, thanks to it
Yakuake can replace Konsole in "Open terminal here" action in Dolphin or we
can setup a menu similar to Konsole Profiles widget but using Yakuake instead
of Konsole.
## Installation
Clone this repository
```
git clone https://github.com/aplatanado/yakuake-session.git
```
The yakuake-session script should to be copied to `~/bin`, `/usr/bin` or some other directory in `$PATH` variable, if we want to avoid indicating the
path of the script when invoked.
```
sudo cp yakuake-session /usr/bin
```
## Usage
To invoke yakuake-session:
```
$ yakuake-session
```
Without arguments, yakuake-session creates a new session in the currently
running Yakuake terminal emulator.
The option `-e` allows to indicate a command to execute in the new session.
```
$ yakuake-session -e ls
```
The argument `-t` sets the title for the new tab.
```
$ yakuake-session -t "Title"
```
The session working directory is changed to the directory where yakuake-session
was called, before execute the command. If we want to launch the command from
user's home directory then we would use the option `-h`.
```
$ yakuake-session -h -e ls
```
If the command requires some arguments, they are taken from non-option
arguments passed to yakuake-session. That means that if some arguments for the
command begin with `-`, they must passed to yakuake-session after `--`.
```
$ yakuake-session -h -e ssh -- -X [email protected]
```
Another useful option is `--workdir`. It allows to change the working directory
before execute the command.
```
$ yakuake-session --workdir /tmp -e ls
```
yakuake-session has many other options that were shown in help.
```
$ yakuake-session --help
Usage: yakuake-session [options] [args]
Options:
--help Show help about options.
-h, --homedir Set the working directory of the new tab to the user's home.
-w, --workdir <dir> Set the working directory of the new tab to 'dir'
--hold, --noclose Do not close the session automatically when the command ends.
-p <property=value> Change the value of a profile property (only for KDE 4).
-e <cmd> Command to execute.
-q Do not open yakuake window.
-t <title> Set the title of the new tab
Arguments:
args Arguments passed to command.
```
## Action in Dolphin
Dolphin provides the action "Open terminal here" that opens a Konsole terminal
emulator in the specified folder. This behavior can be changed to use Yakuake
instead of Konsole with:
```
cp ServiceMenus/konsolehere.desktop ~/.kde/share/kde4/services/ServiceMenus/
```
If we do not want to change the behavior of "Open terminal here", then cp `ServiceMenus/yakuakehere.desktop` to add the new action "Open yakuake here" to Dolphin.
```
cp ServiceMenus/yakuakehere.desktop ~/.kde/share/kde4/services/ServiceMenus/
```
## Quick Access Menu
Konsole Profiles is a Plasma widget that allows to open a new terminal window,
configured according to a select profile, and automatically execute a command
in it. We can get something similar but for Yakuake using the QuickAccess
widget. We only have to make a directory and setup a QuickAccess widget
instance to use it as origin (I also like to disable the browsing). Then we
add some "Link to Application" to that directory, such that each one use
yakuake-session to create a new Yakuake session and to execute the command
that we want.
The file `examples/[email protected]` contains an example that launch
a ssh client in a new Yakuake session.
-- Jesús Torres <[email protected]>
yakuake-session - A script to create new yakuake sessions from command-line.
Copyright 2010-2013 Jesús Torres [email protected]
What is yakuake-session?
yakuake-session is a Bash script that allows to create new sessions in Yakuake terminal emulator from command line. I made it mainly to get a better integration of Yakuake in KDE desktop environment. For example, thanks to it
Yakuake can replace Konsole in "Open terminal here" action in Dolphin or we can setup a menu similar to Konsole Profiles widget but using Yakuake instead of Konsole.
Installation
Clone this repository
git clone https://github.com/aplatanado/yakuake-session.git
The yakuake-session script should to be copied to ~/bin
, /usr/bin
or some other directory in $PATH
variable, if we want to avoid indicating the path of the script when invoked.
sudo cp yakuake-session /usr/bin
Usage
To invoke yakuake-session:
Without arguments, yakuake-session creates a new session in the currently running Yakuake terminal emulator.
The option -e
allows to indicate a command to execute in the new session.
The argument -t
sets the title for the new tab.
$ yakuake-session -t "Title"
The session working directory is changed to the directory where yakuake-session was called, before execute the command. If we want to launch the command from user's home directory then we would use the option -h
.
$ yakuake-session -h -e ls
If the command requires some arguments, they are taken from non-option arguments passed to yakuake-session. That means that if some arguments for the command begin with -
, they must passed to yakuake-session after --
.
$ yakuake-session -h -e ssh -- -X [email protected]
Another useful option is --workdir
. It allows to change the working directory before execute the command.
$ yakuake-session --workdir /tmp -e ls
yakuake-session has many other options that were shown in help.
$ yakuake-session --help
Usage: yakuake-session [options] [args]
Options:
--help Show help about options.
-h, --homedir Set the working directory of the new tab to the user's home.
-w, --workdir <dir> Set the working directory of the new tab to 'dir'
--hold, --noclose Do not close the session automatically when the command ends.
-p <property=value> Change the value of a profile property (only for KDE 4).
-e <cmd> Command to execute.
-q Do not open yakuake window.
-t <title> Set the title of the new tab
Arguments:
args Arguments passed to command.
Action in Dolphin
Dolphin provides the action "Open terminal here" that opens a Konsole terminal emulator in the specified folder. This behavior can be changed to use Yakuake instead of Konsole with:
cp ServiceMenus/konsolehere.desktop ~/.kde/share/kde4/services/ServiceMenus/
If we do not want to change the behavior of "Open terminal here", then cp ServiceMenus/yakuakehere.desktop
to add the new action "Open yakuake here" to Dolphin.
cp ServiceMenus/yakuakehere.desktop ~/.kde/share/kde4/services/ServiceMenus/
Quick Access Menu
Konsole Profiles is a Plasma widget that allows to open a new terminal window, configured according to a select profile, and automatically execute a command in it. We can get something similar but for Yakuake using the QuickAccess widget. We only have to make a directory and setup a QuickAccess widget instance to use it as origin (I also like to disable the browsing). Then we add some "Link to Application" to that directory, such that each one use yakuake-session to create a new Yakuake session and to execute the command that we want.
The file examples/[email protected]
contains an example that launch a ssh client in a new Yakuake session.
-- Jesús Torres [email protected]