X-Git-Url: https://git.proxmox.com/?p=spiceterm.git;a=blobdiff_plain;f=spiceterm.pod;h=dd652884d7aebe4d6ba4b078ef5ca8fbaf5f462f;hp=eb243bef00f3a367a62f10b92a4883c652394a83;hb=HEAD;hpb=16ca49dad037093a8b47de96ac66211cab2d9a8c diff --git a/spiceterm.pod b/spiceterm.pod deleted file mode 100644 index eb243be..0000000 --- a/spiceterm.pod +++ /dev/null @@ -1,100 +0,0 @@ -=head1 NAME - -spiceterm - SPICE Terminal Emulator - -=head1 SYNOPSIS - - spiceterm [OPTIONS] [-- [args]] - - --timeout Wait this time before aborting (default - is 10 seconds) - --authpath Authentication path (PVE AUTH) - --permission Required permissions (PVE AUTH) - --port Bind to port - --addr Bind to address - --noauth Disable authentication - --keymap Spefify keymap (uses kvm keymap files) - -=head1 DESCRIPTION - -spiceterm is a full featured terminal emulator and exports the display -using the SPICE protocol. Implements a 'xterm' compatible terminal. - -=head2 Features - -=over - -=item xterm/linux compatible - -=item cut and paste (vdagent) - -=item screen resize (vdagent) - -=item use TLS to encrypt all traffic - -=item use Proxmox VE authentication - -=back - -=head1 Authentication - -You can disable authentication using the C<--noauth> option. - -Ticket authentication is default, and you should pass the ticket using -the C environment variable. - - # SPICE_TICKET=PASSWD ./spiceterm - -=head1 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/kvm/keymaps/). - - # spiceterm --keymap de - -=head1 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 - - -=head1 AUTHOR - -Dietmar Maurer - -=head1 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.