Jayadeep K M <kmjayadeep@users.noreply.github.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date
Message
systemd: add README (#7225)
Diff
1diff --git a/plugins/systemd/README.md b/plugins/systemd/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..d91329290ab40c3af01d3d9e3ce33ff3689de300
4--- /dev/null
5+++ b/plugins/systemd/README.md
6@@ -0,0 +1,53 @@
7+# Systemd plugin
8+
9+The systemd plugin provides many useful aliases for systemd.
10+
11+To use it, add systemd to the plugins array of your zshrc file:
12+```
13+plugins=(... systemd)
14+```
15+
16+## Aliases
17+
18+| Alias | Command | Description |
19+|:-----------------------|:-----------------------------------|:-----------------------------------------------------------------|
20+| `sc-list-units` | `systemctl list-units` | List all units systemd has in memory |
21+| `sc-is-active` | `systemctl is-active` | Show whether a unit is active |
22+| `sc-status` | `systemctl status` | Show terse runtime status information about one or more units |
23+| `sc-show` | `systemctl show` | Show properties of units, jobs, or the manager itself |
24+| `sc-help` | `systemctl help` | Show man page of units |
25+| `sc-list-unit-files` | `systemctl list-unit-files` | List unit files installed on the system |
26+| `sc-is-enabled` | `systemctl is-enabled` | Checks whether any of the specified unit files are enabled |
27+| `sc-list-jobs` | `systemctl list-jobs` | List jobs that are in progress |
28+| `sc-show-environment` | `systemctl show-environment` | Dump the systemd manager environment block |
29+| `sc-cat` | `systemctl cat` | Show backing files of one or more units |
30+| `sc-list-timers` | `systemctl list-timers` | List timer units currently in memory |
31+| **Aliases with sudo** |
32+| `sc-start` | `sudo systemctl start` | Start Unit(s) |
33+| `sc-stop` | `sudo systemctl stop` | Stop Unit(s) |
34+| `sc-reload` | `sudo systemctl reload` | Reload Unit(s) |
35+| `sc-restart` | `sudo systemctl restart` | Restart Unit(s) |
36+| `sc-try-restart` | `sudo systemctl try-restart` | Restart Unit(s) |
37+| `sc-isolate` | `sudo systemctl isolate` | Start a unit and its dependencies and stop all others |
38+| `sc-kill` | `sudo systemctl kill` | Kill unit(s) |
39+| `sc-reset-failed` | `sudo systemctl reset-failed` | Reset the "failed" state of the specified units, |
40+| `sc-enable` | `sudo systemctl enable` | Enable unit(s) |
41+| `sc-disable` | `sudo systemctl disable` | Disable unit(s) |
42+| `sc-reenable` | `sudo systemctl reenable` | Reenable unit(s) |
43+| `sc-preset` | `sudo systemctl preset` | Reset the enable/disable status one or more unit files |
44+| `sc-mask` | `sudo systemctl mask` | Mask unit(s) |
45+| `sc-unmask` | `sudo systemctl unmask` | Unmask unit(s) |
46+| `sc-link` | `sudo systemctl link` | Link a unit file into the unit file search path |
47+| `sc-load` | `sudo systemctl load` | Load unit(s) |
48+| `sc-cancel` | `sudo systemctl cancel` | Cancel job(s) |
49+| `sc-set-environment` | `sudo systemctl set-environment` | Set one or more systemd manager environment variables |
50+| `sc-unset-environment` | `sudo systemctl unset-environment` | Unset one or more systemd manager environment variables |
51+| `sc-edit` | `sudo systemctl edit` | Edit a drop-in snippet or a whole replacement file with `--full` |
52+| `sc-enable-now` | `sudo systemctl enable --now` | Enable and start unit(s) |
53+| `sc-disable-now` | `sudo systemctl disable --now` | Disable and stop unit(s) |
54+| `sc-mask-now` | `sudo systemctl mask --now` | Mask and stop unit(s) |
55+
56+### User aliases
57+
58+You can use the above aliases as `--user` by using the prefix `scu` instead of `sc`.
59+For example: `scu-list-units` will be aliased to `systemctl --user list-units`.