qsrun/README.md

96 lines
2.2 KiB
Markdown
Raw Normal View History

2019-08-23 23:58:43 +02:00
qsrun
2018-01-03 09:52:05 +01:00
========
2019-08-23 23:58:43 +02:00
qsrun is a launcher. It contains user defined entries for applications and also searches
system-applications. Using libcalculate, it can also be used as a calculator.
2018-01-03 09:52:05 +01:00
If you run a desktop environment like KDE it is questionable whether you will
find this useful, since they usually bring applications that are more or less
2019-08-23 23:58:43 +02:00
comparable to qsrun, although much more
2018-01-03 09:52:05 +01:00
powerful (like KRunner). It can be useful for users running a window manager like
fluxbox etc.
Dependencies
------------
2019-07-15 23:18:06 +02:00
Qt >=5.7.
2018-01-03 09:52:05 +01:00
For the calculation engine, libqalculate is needed.
Currently no conditional compile flags are supported...
2019-08-23 23:58:43 +02:00
Building
2019-08-24 09:48:30 +02:00
--------
Assuming the necessary dependencies are installed:
```
2019-08-23 23:58:43 +02:00
qmake
make
2019-08-24 09:48:30 +02:00
```
2019-08-23 23:58:43 +02:00
2018-01-03 09:52:05 +01:00
Getting started
----------------
2019-08-24 09:48:30 +02:00
$HOME/.config/qsrun
2018-01-03 09:52:05 +01:00
In this folder user-defined entries should be put (See "Entry format").
Config format
------------
2019-08-24 09:48:30 +02:00
Path: $HOME/.config/qsrun/qsrun.config
2018-01-03 09:52:05 +01:00
2019-08-24 09:48:30 +02:00
Example:
2018-01-03 09:52:05 +01:00
```
[General]
2019-08-24 09:48:30 +02:00
sysAppsPaths = "/usr/share/applications/", "/var/lib/snapd/desktop/applications/"
2018-01-03 09:52:05 +01:00
```
2019-08-24 09:48:30 +02:00
sysAppsPaths will default to "/usr/share/applications/" if no value
is given.
2018-01-03 09:52:05 +01:00
Entry format
------------
It rudimentary supports .desktop files, but for user entries, the own format
should be preferred.
It's a simple format: [key] [value].
Example: quasselclient.qsrun:
```
command quasselclient
name Quassel
icon /usr/share/icons/hicolor/128x128/apps/quassel.png
row 1
col 0
key I
```
Example with inheritance: qsrun will search for "vlc.desktop" inside the paths defined in sysAppsPaths:
```
inherit vlc.desktop
row 3
col 1
```
Therefore, there is no need to explicitly the entry a name or icon etc. However, values given here will overwrite the inherited values.
2018-01-03 09:52:05 +01:00
"key" means a shortcut key, you can launch those by pressing Ctrl + "key", so in
the example above: CTRL + I.
Simply pressing Ctrl will show you the associated shortcuts on each individual
button.
General usage
2018-01-03 10:16:44 +01:00
-------------
2018-01-03 09:52:05 +01:00
Starting to type will search user defined entries first, followed by system
entries. Then the PATH variable will be searched, if there is a single match you can also
press TAB for auto completion.
In general it will launch anything once you press enter, however it won't open a
terminal.
Calculator
2018-01-03 10:16:44 +01:00
----------
2018-01-03 09:52:05 +01:00
Start by typing "=", followed by your expression, e. g: "=(2+3)^2"