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