htalkat.1.md

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