NAME

spiceterm - SPICE Terminal Emulator

SYNOPSIS

 spiceterm [OPTIONS] [-- <command> [args]]
  --timeout <seconds>  Wait this time before aborting (default 
                       is 10 seconds)
  --authpath <path>    Authentication path  (PVE AUTH)
  --permission <perm>  Required permissions (PVE AUTH)
  --port <port>        Bind to port <port>
  --addr <addr>        Bind to address <addr>
  --noauth             Disable authentication
  --keymap             Spefify keymap (uses kvm keymap files)

DESCRIPTION

spiceterm is a full featured terminal emulator and exports the display using the SPICE protocol. Implements a 'xterm' compatible terminal.

Authentication

You can disable authentication using the "--noauth" option.

Ticket authentication is default, and you should pass the ticket using the "SPICE_TICKET" environment variable.

 # SPICE_TICKET=PASSWD ./spiceterm

Keyboard Layout

Due to SPICE protocol limitation, you need to specify the keyboard layout used by the client. We currently use the keymap files from kvm (/usr/share/qemu/keymaps/).

 # spiceterm --keymap de

EXAMPLES

By default we start a simple shell (/bin/sh)

 # spiceterm --noauth

You can then connect with remote-viewer

 # remote-viewer spice://localhost?tls-port=5900

Note: spiceterm uses a short timeout and exit if no client connects (for security reasons).

You can also specify the program to execute, for example a login screen

 # spiceterm --noauth -- /bin/login

Or enter a OpenVZ container console

 # ./spiceterm --noauth -- vzctl enter 100

AUTHOR

Dietmar Maurer <dietmar@proxmox.com>

COPYRIGHT AND DISCLAIMER

Copyright (C) 2013 Proxmox Server Solutions GmbH

Copyright: spiceterm is under GNU GPL, the GNU General Public License.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.