1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
.TH GEREALCTL 1 "January 2026" "gereal" "User Commands"
.SH NAME
gerealctl \- manage gereal serial console sessions
.SH SYNOPSIS
.B gerealctl
.RI [ options ] " command " [ session ]
.SH DESCRIPTION
.B gerealctl
is the command-line control utility for
.BR gereal (8),
an automated serial console management system
based on GNU screen and systemd.
It allows users and administrators to list configured sessions,
control their lifecycle via systemd,
and attach to running screen sessions
using a variety of authentication modes.
.SH COMMANDS
.TP
.B list
List all configured serial sessions.
.TP
.BI start " session"
Start the given session via systemd.
.TP
.BI stop " session"
Stop the given session via systemd.
.TP
.BI restart " session"
Restart the given session via systemd.
.TP
.BI status " session"
Show the systemd status of the given session.
.TP
.BI attach " session"
Attach to the running screen session.
.SH ATTACHMENT MODES
By default,
.B gerealctl
tries the available attachment modes in the following order:
.TP
.B direct
Attach directly to the screen session as the current user
(using
.B screen -r gereal:<session>
as the user that has invoked gerealctl).
.TP
.B multiuser
Attach using GNU screen's multiuser feature.
This requires screen to be setuid root and the session's
.B screenrc
file contain the
.B multiuser on
and
.B acladd <user>
directives.
.TP
.B sudo
Attach by invoking screen as the session owner via sudo (
.B sudo -u <user> screen -r gereal:<session>
).
To keep sudo from asking a password, enter
.B <youruser> ALL=(<user>) NOPASSWD: /usr/bin/screen -r gereal:*
in a sudo configuration file.
.P
A specific mode can be forced using the
.BR \-\-mode
option.
.SH OPTIONS
.TP
.BR \-m ", " \-\-mode " " {direct|multiuser|sudo}
Force a specific attachment mode.
.TP
.BR \-c ", " \-\-conf " " file
Use an alternate configuration file.
The default is
.IR /etc/gereal/gereal.conf .
.TP
.BR \-v ", " \-\-verbose
Enable verbose debug output.
.TP
.BR \-h ", " \-\-help
Show help and exit.
.SH CONFIGURATION
Session configuration is read from
.BR gereal.conf (5).
Changes to the configuration require a
.B systemctl daemon-reload
to regenerate systemd units.
.SH EXIT STATUS
.TP
.B 0
Success.
.TP
.B 1
An error occurred.
.SH SEE ALSO
.BR gereal.conf (5),
.BR screen (1),
.BR systemctl (1),
.BR sudo (8)
.SH AUTHOR
Marc Haber <mh+debian-packages@zugschlus.de>
|
