.\" 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::Fish::Commands 3"
.TH Zoidberg::Fish::Commands 3 "2008-01-12" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Zoidberg::Fish::Commands \- Zoidberg plugin with builtin commands
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This module is a Zoidberg plugin, see Zoidberg::Fish for details.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This object contains internal/built\-in commands
for the Zoidberg shell.
.Sh "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
None by default.
.SH "COMMANDS"
.IX Header "COMMANDS"
.IP "cd [\-v|\-\-verbose] [\fIdir\fR|\-|(+|\-)\fIhist_number\fR]" 4
.IX Item "cd [-v|--verbose] [dir|-|(+|-)hist_number]"
.PD 0
.IP "cd (\-l|\-\-list)" 4
.IX Item "cd (-l|--list)"
.PD
Changes the current working directory to \fIdir\fR.
When used with a single dash changes to \s-1OLDPWD\s0.
.Sp
This command uses the environment variable '\s-1CDPATH\s0'. It serves as
a search path when the directory you want to change to isn't found
in the current directory.
.Sp
This command also uses a directory history.
The '\-number' and '+number' switches are used to change directory
to an positive or negative offset in this history.
.IP "exec \fIcmd\fR" 4
.IX Item "exec cmd"
Execute \fIcmd\fR. This effectively ends the shell session,
process flow will \fB\s-1NOT\s0\fR return to the prompt.
.IP "eval \fIcmd\fR" 4
.IX Item "eval cmd"
Eval \fIcmd\fR like a shell command. Main use of this is to
run code stored in variables.
.IP "export \fIvar\fR=\fIvalue\fR" 4
.IX Item "export var=value"
Set the environment variable \fIvar\fR to \fIvalue\fR.
.Sp
\&\s-1TODO\s0 explain how export moved varraibles between the perl namespace and the environment
.IP "setenv \fIvar\fR \fIvalue\fR" 4
.IX Item "setenv var value"
Like \fBexport\fR, but with a slightly different syntax.
.IP "unsetenv \fIvar\fR" 4
.IX Item "unsetenv var"
Set \fIvar\fR to undefined.
.IP "set [+\-][abCefnmnuvx]" 4
.IX Item "set [+-][abCefnmnuvx]"
.PD 0
.IP "set [+o|\-o] \fIoption\fR" 4
.IX Item "set [+o|-o] option"
.PD
Set or unset a shell option. Although sometimes confusing
a '+' switch unsets the option, while the '\-' switch sets it.
.Sp
Short options correspond to the following names:
.Sp
.Vb 11
\&        a  =>  allexport  *
\&        b  =>  notify
\&        C  =>  noclobber
\&        e  =>  errexit    *
\&        f  =>  noglob
\&        m  =>  monitor    *
\&        n  =>  noexec     *
\&        u  =>  nounset    *
\&        v  =>  verbose
\&        x  =>  xtrace     *
\&        *) Not yet supported by the rest of the shell
.Ve
.Sp
See zoiduser for a description what these and other options do.
.Sp
\&\s-1FIXME\s0 takes also hash arguments
.IP "source \fIfile\fR" 4
.IX Item "source file"
Run the \fBperl\fR script \fIfile\fR. This script is \fB\s-1NOT\s0\fR the same
as the commandline syntax. Try using Zoidberg::Shell in these
scripts.
.IP "alias" 4
.IX Item "alias"
.PD 0
.IP "alias \fIname\fR" 4
.IX Item "alias name"
.IP "alias \fIname\fR=\fIcommand\fR" 4
.IX Item "alias name=command"
.IP "alias \fIname\fR \fIcommand\fR" 4
.IX Item "alias name command"
.PD
Make \fIname\fR an alias to \fIcommand\fR. Aliases work like macros
in the shell, this means they are substituted before the commnd
code is interpreted and can contain complex statements.
.Sp
Without \fIcommand\fR shows the alias defined for \fIname\fR if any;
without arguments lists all aliases that are currently defined.
.Sp
Aliases are simple substitutions at the start of a command string.
If you want something more intelligent like interpolating arguments
into a string define a builtin command; see hash.
.IP "unalias \fIname\fR" 4
.IX Item "unalias name"
Remove an alias definition.
.IP "hash \fIlocation\fR" 4
.IX Item "hash location"
.PD 0
.IP "hash \-r" 4
.IX Item "hash -r"
.PD
\&\s-1TODO\s0
.Sp
Command to manipulate the commands hash and command lookup logic.
.IP "read [\-r] \fIvar1\fR \fIvar2 ..\fR" 4
.IX Item "read [-r] var1 var2 .."
Read a line from \s-1STDIN\s0, split the line in words 
and assign the words to the named enironment variables.
Remaining words are stored in the last variable.
.Sp
Unless '\-r' is specified the backslash is treated as
an escape char and is it possible to escape the newline char.
.IP "newgrp" 4
.IX Item "newgrp"
\&\s-1TODO\s0
.IP "umask" 4
.IX Item "umask"
\&\s-1TODO\s0
.IP "false" 4
.IX Item "false"
A command that always returns an error without doing anything.
.IP "true" 4
.IX Item "true"
A command that never fails and does absolutely nothing.
.IP "dirs" 4
.IX Item "dirs"
Output the current dir stack.
.Sp
\&\s-1TODO\s0 some options
.Sp
Note that the dir stack is ont related to the dir history.
It was only implemented because historic implementations have it.
.IP "popd \fIdir\fR" 4
.IX Item "popd dir"
Pops a directory from the dir stack and \fBcd\fRs to that directory.
.Sp
\&\s-1TODO\s0 some options
.IP "pushd \fIdir\fR" 4
.IX Item "pushd dir"
Push \fIdir\fR on the dir stack.
.Sp
\&\s-1TODO\s0 some options
.IP "pwd" 4
.IX Item "pwd"
Prints the current \s-1PWD\s0.
.IP "symbols [\-a|\-\-all] [\fIclass\fR]" 4
.IX Item "symbols [-a|--all] [class]"
Output a listing of symbols in the specified class.
Class defaults to the current perl namespace, by default
\&\f(CW\*(C`Zoidberg::Eval\*(C'\fR.
.Sp
All symbols are prefixed by their sigil ('$', '@', '%', '&'
or '*') where '*' is used for filehandles.
.Sp
By default sub classes (hashes containing '::')
and special symbols (symbols without letters in their name)
are hidden. Use the \-\-all switch to see these.
.IP "reload \fImodule\fR [\fImodule\fR, ..]" 4
.IX Item "reload module [module, ..]"
.PD 0
.IP "reload \fIfile\fR [\fIfile\fR, ..]" 4
.IX Item "reload file [file, ..]"
.PD
Force (re\-)loading of a module file. Typically used for debugging modules,
where you reload the module after each modification to test it interactively.
.Sp
\&\s-1TODO:\s0 recursive switch that scans for 'use' statements
.IP "help [\fItopic\fR|command \fIcommand\fR]" 4
.IX Item "help [topic|command command]"
Prints out a help text.
.IP "which [\-a|\-\-all|\-m|\-\-module] \s-1ITEM\s0" 4
.IX Item "which [-a|--all|-m|--module] ITEM"
Finds \s-1ITEM\s0 in \s-1PATH\s0 or \s-1INC\s0 if the \-m or \-\-module option was used.
If the \-a or \-\-all option is used all it doesn't stop after the first match.
.Sp
\&\s-1TODO\s0 it should identify aliases
.Sp
\&\s-1TODO\s0 what should happen with contexts other then \s-1CMD\s0 ?
.IP "jobs [\-l,\-\-list|\-p,\-\-pgids] \fIjob_spec ...\fR" 4
.IX Item "jobs [-l,--list|-p,--pgids] job_spec ..."
Lists current jobs.
.Sp
If job specs are given as arguments only lists those jobs.
.Sp
The \-\-pgids option only lists the process group ids for the jobs
without additional information.
.Sp
The \-\-list option gives more verbose output, it adds the process group id
of the job and also shows the stack of commands pending for this job.
.Sp
This command is not \s-1POSIX\s0 compliant. It uses '\-l' in a more verbose
way then specified by \s-1POSIX\s0. If you wat to make sure you have \s-1POSIX\s0
compliant verbose output try: \f(CW\*(C`jobs \-l | {! /^\et/}g\*(C'\fR.
.IP "bg \fIjob_spec\fR" 4
.IX Item "bg job_spec"
Run the job corresponding to \fIjobspec\fR as an asynchronous background process.
.Sp
Without argument uses the \*(L"current\*(R" job.
.IP "fg \fIjob_spec\fR" 4
.IX Item "fg job_spec"
Run the job corresponding to \fIjobspec\fR as a foreground process.
.Sp
Without argument uses the \*(L"current\*(R" job.
.IP "wait" 4
.IX Item "wait"
\&\s-1TODO\s0
.IP "kill \-l" 4
.IX Item "kill -l"
.PD 0
.IP "kill [\-w | \-s \fIsigspec\fR|\-n \fIsignum\fR|\-\fIsigspec\fR] (\fIpid\fR|\fIjob_spec\fR)" 4
.IX Item "kill [-w | -s sigspec|-n signum|-sigspec] (pid|job_spec)"
.PD
Sends a signal to a process or a process group.
By default the \*(L"\s-1TERM\s0\*(R" signal is used.
.Sp
The '\-l' option list all possible signals.
.Sp
The \-w or \-\-wipe option is zoidberg specific. It not only kills the job, but also
wipes the list that would be executed after the job ends.
.IP "disown" 4
.IX Item "disown"
\&\s-1TODO\s0
.Sh "Job specs"
.IX Subsection "Job specs"
\&\s-1TODO\s0 tell bout job specs
.SH "AUTHOR"
.IX Header "AUTHOR"
Jaap Karssenberg || Pardus [Larus] <pardus@cpan.org>
R.L. Zwart, <rlzwart@cpan.org>
.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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Zoidberg, Zoidberg::Fish