1termy-setup(1) General Commands Manual termy-setup(1)
2
3
4
6 termy-setup - Perform setup actions for termy-server(1)
7
8
10 termy-setup [options]
11
12
14 For each user that will be running termy-server(1), use the termy-setup
15 shell script to perform recommended setup actions before running the
16 server for the first time. Use one or more command line options to
17 specify which setup tasks to perform.
18
19
21 --systemd
22 Enable and start the systemd(1). systemd user service for
23 termy-server(1). See SYSTEMD SETUP below.
24
25
26 --bash Enable iTerm2-compatible shell integration for bash(1) login
27 shells run under termy-server(1). Commands will be appended to
28 the user's .profile if it exists, otherwise to .bash_profile.
29
30
31 --zsh Enable iTerm2-compatible shell integration for zsh(1) shells run
32 under termy-server(1). Commands will be appended to the user's
33 .zshrc.
34
35
36 --help Print basic help
37
38
39 --version
40 Print version information
41
42
43 --man Attempt to show this man page
44
45
47 The systemd setup action essentially runs the following commands:
48
49 systemctl --user enable termy-server.socket
50 systemctl --user start termy-server.socket
51 loginctl enable-linger
52 kill `head -1 /tmp/termy-server$UID/pid`
53
54 This ensures that the user's persistent instance of termy-server(1)
55 will keep running even when the user is logged out. This is only appli‐
56 cable on Linux systems that run systemd user session managers with
57 login sessions controlled by systemd-logind(8). On such systems, this
58 script (or the above commands) should be run for each user that will be
59 using termy-server(1).
60
61 Important: These commands, particularly loginctl, must be run from
62 within a fully formed systemd login session. Shells launched via
63 sudo(8) or su(1) do not always meet this requirement, nor do terminals
64 run under an existing persistent user server (transient session
65 servers, however, are OK). When in doubt, use ssh or machinectl login
66 to log in as the user and run the script from there.
67
68
70 termy-server(1), systemctl(1), loginctl(1), systemd-logind(8), sys‐
71 temd(1)
72 TermySequence - https://termysequence.io
73
74
75
76TermySequence™ October 2018 termy-setup(1)