htalkat.1

   1 .\" Automatically generated by Pandoc 2.14.2
   2 .\"
   3 .TH "HTALKAT" "1" "" "Version 0.1.1" "htalkat"
   4 .hy
   5 .SH NAME
   6 .PP
   7 htalkat - talkat client and server
   8 .SH SYNOPSIS
   9 .PP
  10 talkat [OPTION]\&... COMMAND [ARG]\&...
  11 .SH DESCRIPTION
  12 .PP
  13 htalkat is a client and server for the talkat real-time text protocol,
  14 with a curses interactive client.
  15 Similar to talk(1) but running over a TLS connection.
  16 .SH COMMANDS
  17 .TP
  18 h[elp] [COMMAND]
  19 Give detailed usage information.
  20 .TP
  21 i[dentity] [PUBLIC_NAME]
  22 Create/show/modify cryptographic identity (public and secret keys, and
  23 certificates), setting public name to PUBLIC_NAME if given.
  24 .TP
  25 c[onnect] ( [talkat:]FP\[at]HOST | NAME[\[at]HOST] )
  26 Connect to remote host, checking the public key agrees with the
  27 fingerprint provided.
  28 Waits for the connection to be \[lq]answered\[rq], then starts
  29 the interactive curses client (or a user-configured client)
  30 .TP
  31 n[ame] ( [talkat:]FP\[at]HOST | NAME[\[at]HOST] ) NAME
  32 Set short name (\[lq]petname\[rq]) for fingerprint and optional host.
  33 This can be
  34 used with the c[onnect] command, and will be used when referring to the
  35 fingerprint.
  36 If the name to set is omitted, it will be prompted for.
  37 .TP
  38 l[isten]
  39 Start server process.
  40 This will listen for connections on the configured
  41 port (default: 5518), and notify by writing information to stdout and
  42 executing the \[ti]/.htalkat/notify.sh script.
  43 If the public key provided on an
  44 incoming connection does not have a name associated, it will be assigned
  45 an
  46 automatic name +N where N is the next available positive integer.
  47 .TP
  48 a[nswer] [--list|-l] NAME
  49 Answer incoming connection, starting the interactive curses client (or
  50 a user-configured client), or list pending unanswered connections.
  51 .TP
  52 a[nswer] [--interactive-client|-i] NAME SOCKET_PATH
  53 Directly spawn default (curses) client.
  54 NAME is the name of remote to
  55 display.
  56 SOCKET_PATH is the path to a unix domain socket to interact with;
  57 characters read from this socket are displayed as coming from remote,
  58 and user input is written to the socket.
  59 .SH OPTIONS
  60 .TP
  61 -d, --datadir \f[I]PATH\f[R]
  62 Directory for data and configuration.
  63 Default: \[ti]/.htalkat
  64 .TP
  65 -S, --socks-host \f[I]HOST\f[R]
  66 Use SOCKS5 proxy for all connections (including DNS resolution).
  67 .TP
  68 -P, --socks-port \f[I]PORT\f[R]
  69 Port to use for SOCKS5 proxy.
  70 Default: 1080.
  71 .TP
  72 -v, --version
  73 Show version information.
  74 .TP
  75 -h, --help
  76 Show usage information.
  77 .SH FILES
  78 .TP
  79 \[ti]/.htalkat
  80 Default \f[I]datadir\f[R].
  81 The paths given below assume that this is used.
  82 .TP
  83 \[ti]/.htalkat/id.key
  84 Secret key used in certificates.
  85 The user hash is derived from the
  86 corresponding public key.
  87 .TP
  88 \[ti]/.htalkat/id-connect.crt
  89 X509 certificate used for outgoing connections.
  90 .TP
  91 \[ti]/.htalkat/id-listen.crt
  92 X509 certificate used for incoming connections.
  93 Unlike id-connect.crt, this will typically have empty Common Name field,
  94 for privacy reasons.
  95 .TP
  96 \[ti]/.htalkat/htalkat.conf
  97 Configuration file.
  98 .TP
  99 \[ti]/.htalkat/notify.sh
 100 Executable script which is run when the server accepts an incoming
 101 connection.
 102 .TP
 103 \[ti]/.htalkat/names/
 104 Short names (\[lq]petnames\[rq]) for user hashes, optionally with hosts,
 105 are stored
 106 here.
 107 These files may be manipulated directly.
 108 .TP
 109 \[ti]/.htalkat/incoming/
 110 Information on unanswered incoming connections is stored here.
 111 .TP
 112 \[ti]/.htalkat/logs/
 113 Communication logs are optionally written here, one file per connection.
 114 .SH ENVIRONMENT
 115 .TP
 116 HTALKAT_DIR
 117 Path to directory to use in place of \[ti]/.htalkat/ (can be overridden
 118 by -d).
 119 .SH LICENCE
 120 .PP
 121 htalkat is free software, released under the terms of the GNU GPL v3 or
 122 later.
 123 You should have obtained a copy of the licence as the file COPYING.
 124 .SH AUTHORS
 125 .PP
 126 Martin Bays <mbays@sdf.org>