117 lines
2.8 KiB
Groff
117 lines
2.8 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH SSH-CHAT 8 "2020-11-18" "1.10" "SlackBuilds.org"
|
|
.SH NAME
|
|
ssh-chat \- custom ssh server providing IRC-like chat
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.\" RST source for ssh-chat(1) man page. Convert with:
|
|
.
|
|
.\" rst2man.py ssh-chat.rst > ssh-chat.8
|
|
.
|
|
.\" rst2man.py comes from the SBo development/docutils package.
|
|
.
|
|
.SH SYNOPSIS
|
|
.sp
|
|
ssh\-chat [\fI\-options\fP]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
ssh\-chat is a custom SSH server written in Go. Instead of a shell,
|
|
clients get a chat prompt when they connect.
|
|
.sp
|
|
There is no specific client for ssh\-chat; use a standard ssh client to connect.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-v\fP,\fB \-\-verbose
|
|
Show verbose logging.
|
|
.TP
|
|
.B \-\-version
|
|
Print version and exit.
|
|
.TP
|
|
.BI \-i\fP,\fB \-\-identity\fB= file
|
|
Private key to identify server with. (default: ~/.ssh/id_rsa)
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-bind=host:port
|
|
Host and port to listen on. (default: 0.0.0.0:2022)
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-\-admin\fB= file
|
|
File of public keys who are admins.
|
|
.TP
|
|
.BI \-\-whitelist\fB= file
|
|
Optional file of public keys who are allowed to connect.
|
|
.TP
|
|
.BI \-\-motd\fB= file
|
|
Optional Message of the Day file.
|
|
.TP
|
|
.BI \-\-log\fB= file
|
|
Write chat log to this file.
|
|
.TP
|
|
.BI \-\-pprof\fB= yes
|
|
Enable pprof http server for profiling.
|
|
.TP
|
|
.B \-h\fP,\fB \-\-help
|
|
Show this help message
|
|
.UNINDENT
|
|
.SH DEMO
|
|
.sp
|
|
To connect to the project\(aqs ssh\-chat server:
|
|
.sp
|
|
$ ssh ssh.chat
|
|
.SH EXAMPLES
|
|
.sp
|
|
ssh\-chat \-\-verbose \-\-bind ":22" \-\-identity ~/.ssh/id_dsa
|
|
.sp
|
|
To bind on port 22, you\(aqll need to make sure it\(aqs free (move any other ssh
|
|
daemons to another port) and run ssh\-chat as root (or with sudo).
|
|
.sp
|
|
Note that ssh\-chat doesn\(aqt run in the background. If you want to \(aqdaemonize\(aq it,
|
|
use the \-\-log option, and run it with a command like:
|
|
.sp
|
|
$ cd / ; ssh\-chat [options] \-\-log=logfile </dev/null >/dev/null 2>&1 &
|
|
.SH COPYRIGHT
|
|
.sp
|
|
See the file /usr/doc/ssh\-chat\-1.10/LICENSE for license information.
|
|
.SH AUTHORS
|
|
.sp
|
|
ssh\-chat was written by Andrey Petrov.
|
|
.sp
|
|
This man page written for the SlackBuilds.org project
|
|
by B. Watson, and is licensed under the WTFPL.
|
|
.SH SEE ALSO
|
|
.sp
|
|
ssh(1), sshd(1)
|
|
.sp
|
|
The ssh\-chat homepage: \fI\%https://github.com/shazow/ssh\-chat/\fP
|
|
.\" Generated by docutils manpage writer.
|
|
.
|