/usr/share/doc/vile-common/perl/Vileserv.doc is in vile-common 9.8s-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | NAME
Vileserv - Provides file-load server capability for Vile.
SYNOPSIS
In Vile:
:perl use Vileserv
:startserv
:stopserv
DESCRIPTION
Vileserv runs a server that listens for requests to load files into an
already running instance of Vile. The vileget utility can be used to
make such requests from a shell command line. Vileserv requires that
Vile be compiled with the built-in PERL interpreter.
Vileserv will likely only work with *Vile* under Unix.
Vileserv does not provide nearly the level of feeping creaturism as
Emacs' gnuserv, but it's a start.
INSTALLATION
[Note: Vileserv may already be automagically installed for you as part
of your Vile or XVile installation.]
Install Vileserv.pm somewhere in the @INC path. Depending on your Vile
installation, */usr/local/share/vile/perl* might be a good place.
To start Vileserv when you start Vile, simply add the following to your
*.vilerc* file:
; Import and start Vileserv (adds :startserv and :stopserv commands)
perl "use Vileserv"
CUSTOMIZATION
Several variables settings can be used to modify Vileserv's default
behaviors. For best results, any of these variables that you choose to
use should be set in your *.vilerc* file before Vileserv is imported and
started.
Vileserv looks for a perl binary in */usr/bin/perl* and
*/usr/local/bin/perl* respectively. You can override this in your
*.vilerc* file using the %vileserv-perl-path variable:
setv %vileserv-perl-path /opt/local/bin/perl
The default socket file used is *$HOME/.vilesock*. This can be
overridden by setting the environment variable VILESOCK. You can also
set it explicitly in your *.vilerc* file by using the variable
%vileserv-socket-path. However, using the environment variable is
recommended, since overriding it will stop the vileget program from
starting a new Vile with a new socket path on demand.
The Vileserv protocol (if you can call it a protocol) allows arbitrary
Vile commands to be executed. This functionality is disabled by default,
but can enabled by adding the following to your *.vilerc* file:
setv %vileserv-accept-commands true
In order to support <B>vileget>'s *-w* option, Vileserv will use Vile's
$write-hook variable. (Use perldoc vileget for details about the *-w*
option.) Vileserv refrains from using the $write-hook variable if it is
already being used, or Vileserv takes advantage of the CaptHook package
if it is loaded. You can disabled this behavior entirely by adding the
following to your *.vilerc* file before you load Vileserv:
setv %vileserv-no-writehook
If the Vileserv socket file already exists, Vileserv will attempt to
determine if another Vileserv is active or not. If not, the old socket
file is removed and the Vileserv startup proceeds normally. If another
Vileserv seems to be active, the new Vileserv will slink away fairly
quietly. If you prefer the old behavior in which Vileserv dies a
horrible death and brings your entire Vile startup to a grinding halt,
you can add the following to your *.vilerc* file:
setv %vileserv-doh! true
BUGS
If the server is started, then stopped, then started again, you may see
the warning "Attempt to free unreferenced scalar..." This is just a
warning. The server startup probably succeeded.
SEE ALSO
vileget(1), vile(1)
CREDITS
Having a PERL interpreter in Vile is very slick. Kudos to everyone who
made it happen. :-)
AUTHOR
J. Chris Coppick, 1998 (last updated: Sept 29, 2001
|