Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ echo "deb [signed-by=/usr/share/keyrings/voltkit-archive-keyring.gpg] https://ar
sudo apt update && sudo apt install voltkit
```

**Vorher den Snap installiert?** Entfernen Sie ihn zuerst (`sudo snap remove voltkit`), sonst ist Voltkit doppelt installiert, und zwei Hintergrunddienste streiten um dieselben Tastenkürzel.

apt installiert die benötigten Werkzeuge (Tesseract, wl-clipboard, das Desktop-Portal) zusammen mit Voltkit, und
Aktualisierungen kommen mit `sudo apt upgrade`.

Expand All @@ -107,15 +109,21 @@ sudo dnf copr enable arios/voltkit
sudo dnf install voltkit
```

**Vorher den Snap installiert?** Entfernen Sie ihn zuerst (`sudo snap remove voltkit`), sonst ist Voltkit doppelt installiert, und zwei Hintergrunddienste streiten um dieselben Tastenkürzel.

Öffnen Sie Voltkit dann aus Ihren Apps; es richtet sich genauso ein. Aktualisierungen kommen mit
`sudo dnf upgrade`.

## Installation (Snap Store)

Den Snap gibt es vor allem, damit man Voltkit findet: Der Snap Store ist auf jeder Linux-Distribution verfügbar, die Snaps unterstützt. Die meisten Funktionen arbeiten im Snap genauso; für die wenigen, die ein Snap nicht darf, installieren Sie mit apt oder Fedora.

```bash
sudo snap install voltkit
```

**Vorher mit apt oder Fedora installiert?** Entfernen Sie diese Version zuerst (`sudo apt remove voltkit` oder `sudo dnf remove voltkit`), damit Voltkit nicht doppelt installiert ist.

Der Snap läuft in einer Sandbox. Deshalb funktionieren GPU-Tuning, Hosts & Umgebung, App-Berechtigungen, Kürzel beim Tippen und einige weitere Funktionen nur mit apt oder Fedora, und manche Werkzeuge brauchen eine Berechtigung, die einmal mit `sudo snap connect` verbunden wird. Jede betroffene Seite weist darauf hin; die Befehle stehen unter [Nach der Installation des Snaps](https://arios4k.github.io/voltkit/manual/install.html#snap-store) (auf Englisch).

## Installation (aus dem Quellcode)
Expand Down
8 changes: 8 additions & 0 deletions README.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ echo "deb [signed-by=/usr/share/keyrings/voltkit-archive-keyring.gpg] https://ar
sudo apt update && sudo apt install voltkit
```

**¿Instalaste el snap antes?** Quítalo primero (`sudo snap remove voltkit`), o Voltkit quedará instalado dos veces, con dos servicios en segundo plano compitiendo por los mismos atajos.

apt instala las herramientas necesarias (Tesseract, wl-clipboard, el portal del escritorio) junto con Voltkit, y
las actualizaciones llegan con `sudo apt upgrade`.

Expand All @@ -106,15 +108,21 @@ sudo dnf copr enable arios/voltkit
sudo dnf install voltkit
```

**¿Instalaste el snap antes?** Quítalo primero (`sudo snap remove voltkit`), o Voltkit quedará instalado dos veces, con dos servicios en segundo plano compitiendo por los mismos atajos.

Luego abre Voltkit desde tus apps; se configura solo de la misma forma. Las actualizaciones llegan con
`sudo dnf upgrade`.

## Instalación (Snap Store)

El snap existe sobre todo para que la gente encuentre Voltkit: la Snap Store está disponible en todas las distribuciones Linux que admiten snaps. La mayoría de las funciones son iguales en el snap; para las pocas que un snap no tiene permitidas, instálalo con apt o Fedora.

```bash
sudo snap install voltkit
```

**¿Lo instalaste antes con apt o Fedora?** Quita esa versión primero (`sudo apt remove voltkit` o `sudo dnf remove voltkit`), para que Voltkit no quede instalado dos veces.

El snap funciona en un entorno aislado, así que el ajuste de GPU, Hosts y entorno, Permisos de apps, los disparadores al escribir y algunas otras funciones solo funcionan con apt o Fedora, y algunas herramientas necesitan un permiso que se conecta una vez con `sudo snap connect`. Cada página afectada lo indica; consulta [después de instalar el snap](https://arios4k.github.io/voltkit/manual/install.html#snap-store) (en inglés) para ver los comandos.

## Instalación (desde el código fuente)
Expand Down
8 changes: 8 additions & 0 deletions README.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ echo "deb [signed-by=/usr/share/keyrings/voltkit-archive-keyring.gpg] https://ar
sudo apt update && sudo apt install voltkit
```

**Vous aviez installé le snap ?** Supprimez-le d’abord (`sudo snap remove voltkit`), sinon Voltkit sera installé deux fois, avec deux services en arrière-plan qui se disputent les mêmes raccourcis.

apt installe les outils nécessaires (Tesseract, wl-clipboard, le portail du bureau) avec Voltkit, et les mises à jour
arrivent avec `sudo apt upgrade`.

Expand All @@ -113,15 +115,21 @@ sudo dnf copr enable arios/voltkit
sudo dnf install voltkit
```

**Vous aviez installé le snap ?** Supprimez-le d’abord (`sudo snap remove voltkit`), sinon Voltkit sera installé deux fois, avec deux services en arrière-plan qui se disputent les mêmes raccourcis.

Ouvrez ensuite Voltkit depuis vos applications ; il se configure de la même façon. Les mises à jour arrivent avec
`sudo dnf upgrade`.

## Installation (Snap Store)

Le snap existe surtout pour qu’on trouve Voltkit : le Snap Store est disponible sur toutes les distributions Linux qui prennent en charge les snaps. La plupart des fonctions marchent de la même façon dans le snap ; pour les rares qu’un snap n’a pas le droit d’utiliser, installez-le avec apt ou Fedora.

```bash
sudo snap install voltkit
```

**Vous l’aviez installé avec apt ou Fedora ?** Supprimez d’abord cette version (`sudo apt remove voltkit` ou `sudo dnf remove voltkit`), pour que Voltkit ne soit pas installé deux fois.

Le snap s’exécute dans un bac à sable : le réglage du GPU, Hôtes et environnement, les autorisations des applications, les déclencheurs saisis et quelques autres fonctions ne marchent qu’avec apt ou Fedora, et certains outils ont besoin d’une autorisation à connecter une fois avec `sudo snap connect`. Chaque page concernée le signale ; les commandes sont dans [Après l’installation du snap](https://arios4k.github.io/voltkit/manual/install.html#snap-store) (en anglais).

## Installation (depuis les sources)
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ echo "deb [signed-by=/usr/share/keyrings/voltkit-archive-keyring.gpg] https://ar
sudo apt update && sudo apt install voltkit
```

**Installed the snap before?** Remove it first (`sudo snap remove voltkit`), or Voltkit ends up installed twice, with two background services fighting over the same shortcuts.

apt installs the required tools (Tesseract, wl-clipboard, the desktop portal) along with Voltkit, and
updates arrive with `sudo apt upgrade`.

Expand All @@ -103,15 +105,21 @@ sudo dnf copr enable arios/voltkit
sudo dnf install voltkit
```

**Installed the snap before?** Remove it first (`sudo snap remove voltkit`), so Voltkit isn't installed twice.

Then open Voltkit from your apps; it sets itself up the same way. Updates arrive with
`sudo dnf upgrade`.

## Install (Snap Store)

The snap is here mostly so people can find Voltkit: the Snap Store is available on every Linux distribution that supports snaps. Most features work the same in the snap; for the few that a snap isn't allowed, install with apt or Fedora.

```bash
sudo snap install voltkit
```

**Installed with apt or Fedora before?** Remove that version first (`sudo apt remove voltkit` or `sudo dnf remove voltkit`), so Voltkit isn't installed twice.

The snap runs in a sandbox, so GPU tuning, Hosts & Environment, App Permissions, typed triggers and a few other features work only with apt or Fedora, and some tools need a permission connected once with `sudo snap connect`. Each affected page says so; see [after installing the snap](https://arios4k.github.io/voltkit/manual/install.html#snap-store) for the commands.

## Install (from source)
Expand Down
8 changes: 8 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ echo "deb [signed-by=/usr/share/keyrings/voltkit-archive-keyring.gpg] https://ar
sudo apt update && sudo apt install voltkit
```

**之前安装过 snap 版?** 请先移除它(`sudo snap remove voltkit`),否则 Voltkit 会被安装两次,两个后台服务会争抢同一组快捷键。

apt 会在安装 Voltkit 的同时安装所需工具(Tesseract、wl-clipboard、桌面门户),之后的更新通过 `sudo apt upgrade` 获得。

然后从应用列表中打开 Voltkit:它会自动设置后台服务和键盘快捷键。接下来该做什么,请参阅手册中的 [Install](https://arios4k.github.io/voltkit/manual/install.html) 和 [A tour of the app](https://arios4k.github.io/voltkit/manual/tour.html)。
Expand All @@ -106,14 +108,20 @@ sudo dnf copr enable arios/voltkit
sudo dnf install voltkit
```

**之前安装过 snap 版?** 请先移除它(`sudo snap remove voltkit`),否则 Voltkit 会被安装两次,两个后台服务会争抢同一组快捷键。

然后从应用列表中打开 Voltkit;它会以同样的方式完成自身设置。更新通过 `sudo dnf upgrade` 获得。

## 安装(Snap Store)

提供 snap 版主要是为了让更多人发现 Voltkit:所有支持 snap 的 Linux 发行版都可以使用 Snap Store。大多数功能在 snap 版中完全相同;少数 snap 不被允许的功能,请通过 apt 或 Fedora 安装使用。

```bash
sudo snap install voltkit
```

**之前用 apt 或 Fedora 安装过?** 请先移除该版本(`sudo apt remove voltkit` 或 `sudo dnf remove voltkit`),以免 Voltkit 被安装两次。

Snap 版运行在沙盒中,因此 GPU 调节、Hosts 与环境变量、应用权限、键入触发词等少数功能只能在 apt 或 Fedora 版中使用,部分工具还需要用 `sudo snap connect` 连接一次权限。受影响的页面都会提示;命令见[安装 snap 之后](https://arios4k.github.io/voltkit/manual/install.html#snap-store)(英文)。

## 安装(从源码)
Expand Down
1 change: 1 addition & 0 deletions docs/manual/pages/_order.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# file-stem | Title | Group
index | Voltkit Manual | Start here
install | Install | Start here
snap | Snap Store version | Start here
tour | A tour of the app | Start here
permissions | App Permissions | Tools
compress | Asset Compressor | Tools
Expand Down
6 changes: 5 additions & 1 deletion docs/manual/pages/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@

**How do I change the language?** Voltkit follows your session language (English, Spanish, German, French and Simplified Chinese). To test another: `LANGUAGE=de voltkit`. This manual is in English.

**How do I uninstall it?** `sudo apt remove voltkit` or `sudo dnf remove voltkit`. Your settings stay in `~/.config/voltkit/` until you delete them. If you turned on typed triggers, run `voltkit expander remove-access` first.
**Why is there a snap version, and is it the same?** It's there so more people can find Voltkit: the Snap Store is on every Linux distribution that supports snaps. Most of Voltkit works the same in it, but a few features need apt or Fedora because of the snap sandbox. See [Snap Store version](snap).

**Can I install both the snap and the apt or Fedora version?** Don't: you'd get two Voltkit entries in your apps and two background services fighting over the same shortcuts. See [Installing only one version](snap#installing-only-one-version).

**How do I uninstall it?** `sudo apt remove voltkit`, `sudo dnf remove voltkit` or `sudo snap remove voltkit`. Your settings stay in `~/.config/voltkit/` until you delete them. If you turned on typed triggers, run `voltkit expander remove-access` first.

**Is it free?** Yes. Voltkit is open source under the MIT license: [github.com/arios4k/voltkit](https://github.com/arios4k/voltkit). If you find it useful, you can [support the author on PayPal](https://paypal.me/AlexisRios).
41 changes: 27 additions & 14 deletions docs/manual/pages/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ echo "deb [signed-by=/usr/share/keyrings/voltkit-archive-keyring.gpg] https://ar
sudo apt update && sudo apt install voltkit
```

> [!IMPORTANT] **Installed the snap before?** Remove it first, or Voltkit is installed twice: two Voltkit entries in your apps, and two background services fighting over the same keyboard shortcuts.

```bash
sudo snap remove voltkit
```

The repository is signed with a GPG key, and apt installs the tools Voltkit needs (Tesseract, wl-clipboard, the desktop portal) together with it. Updates arrive with `sudo apt upgrade`.

## Fedora
Expand All @@ -27,16 +33,28 @@ sudo dnf install voltkit

Updates arrive with `sudo dnf upgrade`.

> [!IMPORTANT] **Installed the snap before?** Remove it first, or Voltkit is installed twice: two Voltkit entries in your apps, and two background services fighting over the same keyboard shortcuts.

```bash
sudo snap remove voltkit
```

## Snap Store

Voltkit is also in the Snap Store, so you can find it in Ubuntu's App Center:
For everything about the snap (what works, permissions, limits and switching versions), see [Snap Store version](snap).

**Why a snap?** Mostly so people can find Voltkit. The Snap Store is available on every Linux distribution that supports snaps, and it shows up in app stores such as Ubuntu's App Center, so more people can discover the tool and install it in one step. **Most of Voltkit works the same in the snap:** 16 of its 18 tools work there, most of them fully. For the few features a snap isn't allowed (see [What works only with apt or Fedora](#what-works-only-with-apt-or-fedora)), apt or Fedora is the way to install it.

Install it from Ubuntu's App Center, or with:

```bash
sudo snap install voltkit
```

Snap updates arrive automatically.

> [!IMPORTANT] **Installed Voltkit with apt or Fedora before?** Remove that version first, or Voltkit is installed twice: two Voltkit entries in your apps, and two background services fighting over the same keyboard shortcuts. Use `sudo apt remove voltkit` (Ubuntu, Debian) or `sudo dnf remove voltkit` (Fedora).

> [!IMPORTANT] Apps from the Snap Store run in a sandbox that can't ask for your administrator password, change system files or read the desktop's permission store. Some features need one of them, so they work only when Voltkit is installed with apt (Ubuntu, Debian) or DNF (Fedora). Each tool affected shows a banner at the top of its page that says what is missing and why.

### After installing the snap
Expand Down Expand Up @@ -79,21 +97,16 @@ Its *Snap Store version* section lists each permission and whether it is connect

### What works only with apt or Fedora

| Tool | What the snap can't do |
|---|---|
| [GPU Tuner](gpu) | Changing settings (power limit, fans, clocks, voltage) and applying profiles at startup. Monitoring works. |
| [Hosts & Environment](system) | The whole tool: editing `/etc/hosts` and your session's environment variables. |
| [App Permissions](permissions) | The whole tool: the sandbox can't read the desktop's permission store. |
| [Text Expansion](snippets) | Typed triggers such as `;date`. The snippet picker (<kbd>Super</kbd>+<kbd>Shift</kbd>+<kbd>E</kbd>) works. |
| [System Report](sysreport) | Drive health, memory slots and firmware update checks. |
| [What's Using This?](using) | Seeing and closing apps that belong to other users or to the system. |
| [Why Didn't It Sleep?](sleep) | Stopping a USB device from waking the computer. |
A few features need the administrator password, system files or desktop services that a snap isn't allowed to use. **This is a limitation of snaps, not of Voltkit**, and most of Voltkit works the same in the snap. Left out:

These need the administrator password (Voltkit asks through `pkexec`), write system files or read the desktop's permission store, and a snap is allowed none of them. To use them, remove the snap and install with [apt](#ubuntu-debian-and-derivatives) or [Fedora](#fedora) instead:
- [GPU Tuner](gpu): changing settings (monitoring works);
- [Hosts & Environment](system) and [App Permissions](permissions): the whole tools;
- [Text Expansion](snippets): typed triggers (the snippet picker works);
- [System Report](sysreport): drive health, memory slots and firmware checks;
- [What's Using This?](using): other users' and the system's apps;
- [Why Didn't It Sleep?](sleep): stopping a USB device from waking the computer.

```bash
sudo snap remove voltkit
```
[Snap Store version](snap#what-works-only-with-apt-or-fedora) explains why each one can't work in a snap, what works in every tool, and how to switch to apt or Fedora without losing your snippets.

## From source

Expand Down
Loading
Loading