.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Zoidberg 3" .TH Zoidberg 3 "2008-01-12" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Zoidberg \- A modular perl shell .SH "SYNOPSIS" .IX Header "SYNOPSIS" You should use the \fBzoid\fR system command to start the Zoidberg shell. To embed the Zoidberg shell in another perl program use the Zoidberg::Shell module. .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fIThis page contains devel documentation, if you're looking for user documentation start with the \fIzoid\fI\|(1) and \fIzoiduser\fI\|(1) man pages.\fR .PP This module contains the core dispatch and event logic of the Zoidberg shell. Also it is used as a 'main object' so other objects can find each other here; all other objects are nested below this object. Also it contains some parser code. .PP This object inherits from both Zoidberg::Contractor and Zoidberg::Shell. .SH "METHODS" .IX Header "METHODS" .ie n .IP """new(\e%attr)""" 4 .el .IP "\f(CWnew(\e%attr)\fR" 4 .IX Item "new(%attr)" Initialize secondary objects and sets config. \&\f(CW%attr\fR contains non-default attributes and is used to set runtime settings. .Sp You probably don't want to use this to construct a new Zoidberg shell object, better use Zoidberg::Shell. .ie n .IP """main_loop()""" 4 .el .IP "\f(CWmain_loop()\fR" 4 .IX Item "main_loop()" Spans interactive shell reading from a secondary ReadLine object or from \s-1STDIN\s0. .Sp To quit this loop the routine \f(CW\*(C`exit()\*(C'\fR of this package should be called. Most common way to do this is pressing ^D. .IP "mode [mode]" 4 .IX Item "mode [mode]" Without arguments prints the current mode. With arguments sets the mode. .IP "plug" 4 .IX Item "plug" \&\s-1TODO\s0 .IP "unplug" 4 .IX Item "unplug" \&\s-1TODO\s0 .ie n .IP """exit()""" 4 .el .IP "\f(CWexit()\fR" 4 .IX Item "exit()" Called by plugins to exit zoidberg \*(-- this ends a interactive \f(CW\*(C`main_loop()\*(C'\fR loop. This does not clean up or destroy any objects, \f(CW\*(C`main_loop()\*(C'\fR can be called again to restart it. .ie n .IP """round_up()""" 4 .el .IP "\f(CWround_up()\fR" 4 .IX Item "round_up()" This method should be called to clean up the shell objects. A \f(CW\*(C`round_up()\*(C'\fR method will be called recursively for all secondairy objects. .SH "AUTOLOADING" .IX Header "AUTOLOADING" Routines not recognised by this object are understood to be either the name of a plugin, in which case a reference to that object is returned, or a shell command, in which case Zoidberg tries to execute it. .SH "AUTHOR" .IX Header "AUTHOR" Jaap Karssenberg || Pardus [Larus] .PP R.L. Zwart, .PP Copyright (c) 2002 Jaap G Karssenberg. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP See and .SH "SEE ALSO" .IX Header "SEE ALSO" zoid(1), zoiddevel(1), Zoidberg::Shell,