aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md34
1 files changed, 17 insertions, 17 deletions
diff --git a/README.md b/README.md
index d98b65b..ab2949c 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@ Here are some short HOWTOs and infos on using some of the special or modified sy
### Real-time kernel command line option
Some services are dependant or anti-dependant on the kernel command line option *"systemd.setenv=REALTIME=true"*. The option itself sets nothing but an Environment for systemd.
-This is pretty useful when wanting to enable or disable certain services using *"ConditionKernelCommandLine"* in their **[Unit]** sections,
+This is pretty useful when wanting to enable or disable certain services using *ConditionKernelCommandLine* in their **[Unit]** sections,
### Separate tmux environment
Tmux is used for a couple of services to start an environment in which other command line interface programs can run. To achieve this and not get in conflict with the standard tmux environment, some modifications might be needed.
@@ -40,22 +40,22 @@ In some services the following Environment will be set:
Environment=TMUX_TMPDIR=/run/user/%U/tmux
-This will store the tmux server socket in the users run directory. If after starting this service one wants to connect to that special tmux session, it is necessary to either define the absolute path to the socket
+This will store the tmux server socket in the users run directory. If after starting this service one wants to connect to that special tmux session, it is necessary to either define the absolute path to the socket
tmux -S /run/user/<your-user-id>/tmux/<name-of-socket> attach
-or to just set your *"TMUX\_TMPDIR"* variable to the same directoy in your shells configuration files and then just attach to it, like so:
+or to just set your *"$TMUX\_TMPDIR"* variable to the same directoy in your shells configuration files and then just attach to it, like so:
tmux -L <name-of-socket> attach
### compton
-The [compton](https://github.com/chjj/compton/) user service will need a properly exported **DISPLAY** variable to work. You can set this in */etc/systemd/user.conf*:
+The [compton](https://github.com/chjj/compton/) user service will need a properly exported **$DISPLAY** variable to work. You can set this in */etc/systemd/user.conf*:
...
DefaultEnvironment=DISPLAY=:0
...
-The compton user service is anti-dependent on the real-time kernel command line option. It will not start, when booting into a kernel with that
+The compton user service is anti-dependent on the real-time kernel command line option. It will not start, when booting into a kernel with that option set.
You can start and enable it like any other systemd user service:
systemctl --user start compton
@@ -64,8 +64,8 @@ You can start and enable it like any other systemd user service:
### cpupower
The cpupower package (on Archlinux) has some [limitations](https://bugs.archlinux.org/task/44270?project=5&cat[0]=33&string=cpupower), that make it quite hard to apply CPU settings based on profiles.
At least in a real-time environment, the modified version of cpupower - called cpupower-rt - makes it easy to apply differing settings **after** the usual cpupower settings have been applied.
-Once the above mentioned feature request is resolved, it will be as easy as just copying the *cpupower.service* file and modify it slightly in *"/etc/systemd/sytem/"*
-For now, there needs to be a separate config file **and** a separate script. For setting it up, just modify *"/etc/default/cpupower-rt"* as you would for *"/etc/default/cpupower"*.
+Once the above mentioned feature request is resolved, it will be as easy as just copying the *cpupower.service* file and modify it slightly in */etc/systemd/sytem/*.
+For now, there needs to be a separate config file **and** a separate script. For setting it up, just modify */etc/default/cpupower-rt* as you would for */etc/default/cpupower*.
This service is dependant on the real-time kernel command line option. It will only start, if that condition is met.
You can start and enable it like any other systemd service:
@@ -93,19 +93,19 @@ To connect to it after starting the service, just do
tmux -S /run/user/<your-user-id>/tmux/mon attach
-or (if you've setup *"TMUX_TMPDIR"* properly in your shell)
+or (if you've setup *$TMUX_TMPDIR* properly in your shell)
tmux -L mon attach
### MPD
-The specialized systemd user service *mpd@.service* starts MPD with a separate configuration located in *"~/.config/mpd/mpd-<name-of-server>.conf*. It will also use pax11publish to connect pulseaudio to that server!
+The specialized systemd user service *mpd@.service* starts MPD with a separate configuration located in *~/.config/mpd/mpd-<name-of-server>.conf*. It will also use pax11publish to connect pulseaudio to that server!
Start and enable it like any other systemd user service:
systemctl --user start mpd@myserver
systemctl --user enable mpd@myserver
### postpone-screensaver
-With the systemd user service and timer *postpone-screensaver.{service,timer}* one can - as the name implies - postpone one's screensaver from blanking the screen. The script checks for programs set in *"~/.config/postpone-screensaver"* and can be started and activated like any other timer/service:
+With the systemd user service and timer *postpone-screensaver.{service,timer}* one can - as the name implies - postpone one's screensaver from blanking the screen. The script checks for programs set in *~/.config/postpone-screensaver* and can be started and activated like any other timer/service:
systemctl --user start postpone-screensaver.timer
systemctl --user enable postpone-screensaver.timer
@@ -121,13 +121,13 @@ Make sure to also disable autospawn in your *~/.config/pulse/client.conf*, like
autospawn = no
### rtorrent
-rtorrent doesn't really come with any systemd service. Here it is started within a separate tmux environment. It will automatically create *"~/Downloads/rtorrent/{tmp,session}"*, if non-existent, set its working directory to *"~/Downloads"*.
+rtorrent doesn't really come with any systemd service. Here it is started within a separate tmux environment. It will automatically create *~/Downloads/rtorrent/{tmp,session}*, if non-existent, set its working directory to *~/Downloads*.
The systemd user service is started/ enabled like this:
systemctl --user start rtorrent
systemctl --user enable rtorrent
-The systemd system service is quite similar in functionality, but on top offers the possibility of dependency to a system service - like [OpenVPN](http://openvpn.net/). The default is a OpenVPN profile called *"ipredator"*.
+The systemd system service is quite similar in functionality, but on top offers the possibility of dependency to a system service - like [OpenVPN](http://openvpn.net/). The default is a OpenVPN profile called *ipredator*.
**Note:** In a separate configuration file (*"/etc/conf.d/rtorrent@.conf"*), the *TMUX_TMPDIR* should be set, as it otherwise defaults to using *"/tmp/*!
The system service can be started and enabled like this:
@@ -138,18 +138,18 @@ To connect to the user and system service after starting the service, just do
tmux -S /run/user/<your-user-id>/tmux/rt attach
-or (if you've setup *"TMUX_TMPDIR"* properly in your shell and for the **rtorrent@.service**, too)
+or (if you've setup *$TMUX_TMPDIR* properly in your shell and for the **rtorrent@.service**, too)
tmux -L rt attach
### syndaemon
-The [xf86-input-synaptics](https://www.archlinux.org/packages/extra/x86_64/xf86-input-synaptics/) package comes with *"/usr/bin/syndaemon"*. This tool is used to disable the touchpad while typing. While desktop environments like KDE and Gnome use it integrated, it can also be started as a systemd user service:
+The [xf86-input-synaptics](https://www.archlinux.org/packages/extra/x86_64/xf86-input-synaptics/) package comes with */usr/bin/syndaemon*. This tool is used to disable the touchpad while typing. While desktop environments like KDE and Gnome use it integrated, it can also be started as a systemd user service:
systemctl --user start syndaemon
systemctl --user enable syndaemon
### systemd-analyze-plot
-Systemd comes with a functionality to plot the system's boot up process in svg and other file formats. This user service uses *"/usr/bin/systemd-analyze"* to plot a svg to a predefined directory. Configuration takes place in *"~/.config/systemd/plot.conf"*.
+Systemd comes with a functionality to plot the system's boot up process in svg and other file formats. This user service uses */usr/bin/systemd-analyze* to plot a svg to a predefined directory. Configuration takes place in *~/.config/systemd/plot.conf*.
To start/enable the service afterwards just do:
systemctl --user start systemd-analyze-plot
@@ -157,7 +157,7 @@ To start/enable the service afterwards just do:
### tmux
[Tmux](http://tmux.sourceforge.net/) is a very useful tool to multiplex your terminals. It offers tiling and a high configurability.
-The systemd user service for tmux starts it in a separate environment (set in *"TMUX\_TMPDIR"*). This way it is started as soon as the *user@.service* starts, but will also close, when your last session closes!
+The systemd user service for tmux starts it in a separate environment (set in *$TMUX\_TMPDIR*). This way it is started as soon as the *user@.service* starts, but will also close, when your last session closes!
To start/enable it, just do:
systemctl --user start tmux
@@ -167,7 +167,7 @@ To connect to the user service after starting it, just do
tmux -S /run/user/<your-user-id>/tmux/default attach
-or (if you've setup *"TMUX_TMPDIR"* properly in your shell)
+or (if you've setup *$TMUX_TMPDIR* properly in your shell)
tmux attach