spiceterm.pod

   1 =head1 NAME
   2
   3 spiceterm - SPICE Terminal Emulator
   4
   5 =head1 SYNOPSIS
   6
   7  spiceterm [OPTIONS] [-- <command> [args]]
   8
   9   --timeout <seconds>  Wait this time before aborting (default
  10                        is 10 seconds)
  11   --authpath <path>    Authentication path  (PVE AUTH)
  12   --permission <perm>  Required permissions (PVE AUTH)
  13   --port <port>        Bind to port <port>
  14   --addr <addr>        Bind to address <addr>
  15   --noauth             Disable authentication
  16   --keymap             Spefify keymap (uses kvm keymap files)
  17
  18 =head1 DESCRIPTION
  19
  20 spiceterm is a full featured terminal emulator and exports the display
  21 using the SPICE protocol. Implements a 'xterm' compatible terminal.
  22
  23 =head2 Features
  24
  25 =over
  26
  27 =item xterm/linux compatible
  28
  29 =item cut and paste (vdagent)
  30
  31 =item screen resize (vdagent)
  32
  33 =item use TLS to encrypt all traffic
  34
  35 =item use Proxmox VE authentication
  36
  37 =back
  38
  39 =head1 Authentication
  40
  41 You can disable authentication using the C<--noauth> option.
  42
  43 Ticket authentication is default, and you should pass the ticket using
  44 the C<SPICE_TICKET> environment variable.
  45
  46  # SPICE_TICKET=PASSWD ./spiceterm
  47
  48 =head1 Keyboard Layout
  49
  50 Due to SPICE protocol limitation, you need to specify the keyboard
  51 layout used by the client. We currently use the keymap files from kvm
  52 (/usr/share/kvm/keymaps/).
  53
  54  # spiceterm --keymap de
  55
  56 =head1 EXAMPLES
  57
  58 By default we start a simple shell (/bin/sh)
  59
  60  # spiceterm --noauth
  61
  62 You can then connect with remote-viewer
  63
  64  # remote-viewer spice://localhost?tls-port=5900
  65
  66 Note: spiceterm uses a short timeout and exit if no client connects
  67 (for security reasons).
  68
  69 You can also specify the program to execute, for example a login screen
  70
  71  # spiceterm --noauth -- /bin/login
  72
  73 Or enter a OpenVZ container console
  74
  75  # ./spiceterm --noauth -- vzctl enter 100
  76
  77
  78 =head1 AUTHOR
  79
  80 Dietmar Maurer <dietmar@proxmox.com>
  81
  82 =head1 COPYRIGHT AND DISCLAIMER
  83
  84 Copyright (C) 2013 Proxmox Server Solutions GmbH
  85
  86 Copyright: spiceterm is under GNU GPL, the GNU General Public License.
  87
  88 This program is free software; you can redistribute it and/or modify
  89 it under the terms of the GNU General Public License as published by
  90 the Free Software Foundation; either version 2 of the License, or
  91 (at your option) any later version.
  92
  93 This program is distributed in the hope that it will be useful,
  94 but WITHOUT ANY WARRANTY; without even the implied warranty of
  95 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  96 GNU General Public License for more details.
  97
  98 You should have received a copy of the GNU General Public License along
  99 with this program; if not, write to the Free Software Foundation, Inc.,
 100 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.