htalkat-0.1.1: htalkat.1

.\" Automatically generated by Pandoc 2.14.2
.\"
.TH "HTALKAT" "1" "" "Version 0.1.1" "htalkat"
.hy
.SH NAME
.PP
htalkat - talkat client and server
.SH SYNOPSIS
.PP
talkat [OPTION]\&... COMMAND [ARG]\&...
.SH DESCRIPTION
.PP
htalkat is a client and server for the talkat real-time text protocol,
with a curses interactive client.
Similar to talk(1) but running over a TLS connection.
.SH COMMANDS
.TP
h[elp] [COMMAND]
Give detailed usage information.
.TP
i[dentity] [PUBLIC_NAME]
Create/show/modify cryptographic identity (public and secret keys, and
certificates), setting public name to PUBLIC_NAME if given.
.TP
c[onnect] ( [talkat:]FP\[at]HOST | NAME[\[at]HOST] )
Connect to remote host, checking the public key agrees with the
fingerprint provided.
Waits for the connection to be \[lq]answered\[rq], then starts
the interactive curses client (or a user-configured client)
.TP
n[ame] ( [talkat:]FP\[at]HOST | NAME[\[at]HOST] ) NAME
Set short name (\[lq]petname\[rq]) for fingerprint and optional host.
This can be
used with the c[onnect] command, and will be used when referring to the
fingerprint.
If the name to set is omitted, it will be prompted for.
.TP
l[isten]
Start server process.
This will listen for connections on the configured
port (default: 5518), and notify by writing information to stdout and
executing the \[ti]/.htalkat/notify.sh script.
If the public key provided on an
incoming connection does not have a name associated, it will be assigned
an
automatic name +N where N is the next available positive integer.
.TP
a[nswer] [--list|-l] NAME
Answer incoming connection, starting the interactive curses client (or
a user-configured client), or list pending unanswered connections.
.TP
a[nswer] [--interactive-client|-i] NAME SOCKET_PATH
Directly spawn default (curses) client.
NAME is the name of remote to
display.
SOCKET_PATH is the path to a unix domain socket to interact with;
characters read from this socket are displayed as coming from remote,
and user input is written to the socket.
.SH OPTIONS
.TP
-d, --datadir \f[I]PATH\f[R]
Directory for data and configuration.
Default: \[ti]/.htalkat
.TP
-S, --socks-host \f[I]HOST\f[R]
Use SOCKS5 proxy for all connections (including DNS resolution).
.TP
-P, --socks-port \f[I]PORT\f[R]
Port to use for SOCKS5 proxy.
Default: 1080.
.TP
-v, --version
Show version information.
.TP
-h, --help
Show usage information.
.SH FILES
.TP
\[ti]/.htalkat
Default \f[I]datadir\f[R].
The paths given below assume that this is used.
.TP
\[ti]/.htalkat/id.key
Secret key used in certificates.
The user hash is derived from the
corresponding public key.
.TP
\[ti]/.htalkat/id-connect.crt
X509 certificate used for outgoing connections.
.TP
\[ti]/.htalkat/id-listen.crt
X509 certificate used for incoming connections.
Unlike id-connect.crt, this will typically have empty Common Name field,
for privacy reasons.
.TP
\[ti]/.htalkat/htalkat.conf
Configuration file.
.TP
\[ti]/.htalkat/notify.sh
Executable script which is run when the server accepts an incoming
connection.
.TP
\[ti]/.htalkat/names/
Short names (\[lq]petnames\[rq]) for user hashes, optionally with hosts,
are stored
here.
These files may be manipulated directly.
.TP
\[ti]/.htalkat/incoming/
Information on unanswered incoming connections is stored here.
.TP
\[ti]/.htalkat/logs/
Communication logs are optionally written here, one file per connection.
.SH ENVIRONMENT
.TP
HTALKAT_DIR
Path to directory to use in place of \[ti]/.htalkat/ (can be overridden
by -d).
.SH LICENCE
.PP
htalkat is free software, released under the terms of the GNU GPL v3 or
later.
You should have obtained a copy of the licence as the file COPYING.
.SH AUTHORS
.PP
Martin Bays <mbays@sdf.org>