Debian Codegraph @

upstream/fedora-44/man1/systemd-ssh-issue.1

raw
1 '\" t
2 .TH "SYSTEMD\-SSH\-ISSUE" "1" "" "systemd 259.5" "systemd-ssh-issue"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd-ssh-issue \- Generator for SSH login prompt drop\-ins
24 .SH "SYNOPSIS"
25 .HP \w'\fB/usr/lib/systemd/systemd\-ssh\-issue\ \fR\fB\fB\-\-make\-vsock\fR\fR\fB/usr/lib/systemd/systemd\-ssh\-issue\ \fR\fB\fB\-\-rm\-vsock\fR\fR\ 'u
26 \fB/usr/lib/systemd/systemd\-ssh\-issue \fR\fB\fB\-\-make\-vsock\fR\fR\fB/usr/lib/systemd/systemd\-ssh\-issue \fR\fB\fB\-\-rm\-vsock\fR\fR
27 .SH "DESCRIPTION"
28 .PP
29 \fBsystemd\-ssh\-issue\fR
30 is a small tool that generates a
31 /run/issue\&.d/50\-ssh\-vsock\&.issue
32 drop\-in file in case
33 \fBAF_VSOCK\fR
34 support is available in the kernel and the VM environment\&. The file contains brief information about how to contact the local system via SSH\-over\-\fBAF_VSOCK\fR, in particular it reports the system\*(Aqs
35 \fBAF_VSOCK\fR
36 CID\&. The file is typically read and displayed by
37 \fBagetty\fR(8)
38 on console or serial login prompts\&.
39 .PP
40 This tool is automatically used by
41 \fBsystemd-ssh-generator\fR(8)
42 in the
43 \fBAF_VSOCK\fR
44 socket units it generates\&.
45 .SH "OPTIONS"
46 .PP
47 The following options are understood:
48 .PP
49 \fB\-\-make\-vsock\fR
50 .RS 4
51 Generates the issue file\&. This command has no effect if called on systems lacking
52 \fBAF_VSOCK\fR
53 support\&.
54 .sp
55 Added in version 258\&.
56 .RE
57 .PP
58 \fB\-\-rm\-vsock\fR
59 .RS 4
60 Removes the issue file if it exists\&.
61 .sp
62 Added in version 258\&.
63 .RE
64 .PP
65 \fB\-\-issue\-path=\fR
66 .RS 4
67 Changes the path to the issue file to write to/remove\&. If not specified, defaults to
68 /run/issue\&.d/50\-ssh\-vsock\&.issue\&. If specified as empty string or
69 "\-"
70 writes the issue file contents to standard output\&.
71 .sp
72 Added in version 258\&.
73 .RE
74 .PP
75 \fB\-h\fR, \fB\-\-help\fR
76 .RS 4
77 Print a short help text and exit\&.
78 .RE
79 .PP
80 \fB\-\-version\fR
81 .RS 4
82 Print a short version string and exit\&.
83 .RE
84 .SH "EXIT STATUS"
85 .PP
86 On success, 0 is returned, a non\-zero failure code otherwise\&.
87 .SH "SEE ALSO"
88 .PP
89 \fBsystemd\fR(1), \fBsystemd-ssh-generator\fR(8), \fBvsock\fR(7), \fBssh\fR(1), \fBsshd\fR(8), \fBagetty\fR(8)