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
5 changes: 4 additions & 1 deletion docs/manual/build.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,17 @@ def uid(t):
i += 1
out.append("<ul>" + "".join(f"<li>{inline(x)}</li>" for x in items) + "</ul>")
elif re.match(r"\d+\. ", line):
# A list that resumes after a table or code block keeps its numbering.
first = int(re.match(r"(\d+)\. ", line).group(1))
items = []
while i < len(lines) and (re.match(r"\d+\. ", lines[i]) or (lines[i].startswith(" ") and lines[i].strip() and items)):
if re.match(r"\d+\. ", lines[i]):
items.append(re.sub(r"^\d+\. ", "", lines[i]))
else:
items[-1] += " " + lines[i].strip()
i += 1
out.append("<ol>" + "".join(f"<li>{inline(x)}</li>" for x in items) + "</ol>")
start = f' start="{first}"' if first != 1 else ""
out.append(f"<ol{start}>" + "".join(f"<li>{inline(x)}</li>" for x in items) + "</ol>")
else:
buf = []
while i < len(lines) and lines[i].strip() and not re.match(r"(#{1,4} |```|>|\||\s*[-*] |\d+\. |!\[)", lines[i]):
Expand Down
14 changes: 7 additions & 7 deletions docs/manual/pages/awake.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ Watching a film, presenting, or waiting for a long download? Keep Awake stops yo
1. Open **Keep Awake**.
2. Choose how long in the **For** list:

| Choice | Length |
|---|---|
| 30 minutes | 30 minutes |
| 1 hour | 60 minutes |
| 2 hours | 120 minutes |
| 4 hours | 240 minutes |
| Until turned off | no time limit |
| Choice | Length |
|---|---|
| 30 minutes | 30 minutes |
| 1 hour | 60 minutes |
| 2 hours | 120 minutes |
| 4 hours | 240 minutes |
| Until turned off | no time limit |

3. Turn the switch on. The status changes to **Keep Awake is on**, and when a timer is running it shows the time left.
4. Turn the switch off whenever you are done: the status says **Keep Awake is off**.
Expand Down
66 changes: 40 additions & 26 deletions docs/manual/pages/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,31 +41,41 @@ Snap updates arrive automatically.

### After installing the snap

1. **Open Voltkit once** from your apps. It starts its background service, sets it to start at every login, and adds its keyboard shortcuts.
2. **Allow the permissions the snap doesn't get automatically.** Run these once in a terminal, or switch them on in your app store under **Voltkit → Permissions**:

```bash
sudo snap connect voltkit:removable-media
sudo snap connect voltkit:system-observe
sudo snap connect voltkit:mount-observe
sudo snap connect voltkit:process-control
sudo snap connect voltkit:log-observe
sudo snap connect voltkit:login-session-observe
sudo snap connect voltkit:hardware-observe
```

| Permission | Lets Voltkit |
|---|---|
| `removable-media` | use files on USB drives and other external disks (Compressor, Batch Rename, Image Resizer) |
| `system-observe` | see which apps have files and ports open, and read drivers and the system's state (What's Using This?, System Report) |
| `mount-observe` | list the drives that are connected (What's Using This?, System Report) |
| `process-control` | close the apps that keep something busy (What's Using This?) |
| `log-observe` | read the sleep history (Why Didn't It Sleep?) |
| `login-session-observe` | see what is keeping the computer awake (Why Didn't It Sleep?) |
| `hardware-observe` | read hardware details, temperatures and fans (System Report, GPU Tuner) |

You can connect only the ones for the tools you use. Nothing else needs connecting: screenshots, the eyedropper, the clipboard and pasting go through the desktop's portals, which the snap may use without asking.
3. **Check** with `voltkit doctor`: its *Snap Store version* section lists each permission and whether it is connected.
**1. Open Voltkit once** from your apps. It starts its background service, sets it to start at every login, and adds its keyboard shortcuts.

**2. Allow the permissions the snap doesn't get automatically.** Copy these commands into a terminal and press Enter (they ask for your password once):

```bash
sudo snap connect voltkit:removable-media
sudo snap connect voltkit:system-observe
sudo snap connect voltkit:mount-observe
sudo snap connect voltkit:process-control
sudo snap connect voltkit:log-observe
sudo snap connect voltkit:login-session-observe
sudo snap connect voltkit:hardware-observe
```

Instead of the terminal, you can also switch them on in your app store under **Voltkit → Permissions**. What each one is for:

| Permission | Lets Voltkit |
|---|---|
| `removable-media` | use files on USB drives and other external disks (Compressor, Batch Rename, Image Resizer) |
| `system-observe` | see which apps have files and ports open, and read drivers and the system's state (What's Using This?, System Report) |
| `mount-observe` | list the drives that are connected (What's Using This?, System Report) |
| `process-control` | close the apps that keep something busy (What's Using This?) |
| `log-observe` | read the sleep history (Why Didn't It Sleep?) |
| `login-session-observe` | see what is keeping the computer awake (Why Didn't It Sleep?) |
| `hardware-observe` | read hardware details, temperatures and fans (System Report, GPU Tuner) |

You can connect only the ones for the tools you use. Nothing else needs connecting: screenshots, the eyedropper, the clipboard and pasting go through the desktop's portals, which the snap may use without asking.

**3. Check** that everything is connected:

```bash
voltkit doctor
```

Its *Snap Store version* section lists each permission and whether it is connected.

### What works only with apt or Fedora

Expand All @@ -79,7 +89,11 @@ Snap updates arrive automatically.
| [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. |

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 (`sudo snap remove voltkit`) and install with [apt](#ubuntu-debian-and-derivatives) or [Fedora](#fedora) instead.
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:

```bash
sudo snap remove voltkit
```

## From source

Expand Down
Loading