view release on metacpan or  search on metacpan

man1/zoiduser.pod  view on Meta::CPAN

=head1 NAME

zoiduser - Extended user documentation for zoid

=head1 DESCRIPTION

=head2 Configuration

The location of config and data files can be installation specific.
You can check the location where zoid looks for them with the command C<zoid --config>.

By default zoid uses two run control files:
F</etc/zoidrc> and F<~/.zoidrc> or F<~/.zoid/zoidrc>,
these are ordinary perl scripts that can interface with zoid.
In general data files are found in F<~/.zoid/>, F</usr/local/share/zoid/>
or F</usr/share/zoid/> these are called 'data_dirs'.

The sub dir F<plugins> can contains config files
for various plugins or directories with all files belonging to a plugin.
The following plugins are included in the standard distribution:

FIXME tell which builtins are provided by each plugin
FIXME tell commands provided by Zoidberg.pm

=over 4

=item Commands

Ships a collection of standard builtin commands that one 
would expects to have in a shell.

Provides: B<cd>, B<pwd>, B<exec>, B<eval>, B<source>, B<true>, B<false>,
B<newgrp>, B<umask>, B<read>, B<wait>, B<fg>, B<bg>, B<kill>, B<jobs>,
B<set>, B<export>, B<setenv>, B<unsetenv>, B<alias>, B<unalias>, B<dirs>,
B<popd>, B<pushd> and B<symbols>

=item Log

Keeps a history of your doings.

=item Intel

Takes care of tab expansion.

Provides: B<complete>

=item ReadLine

Tries to load a module from the L<Term::ReadLine> family of modules.

Provides: B<readline>, B<readmore> and B<select>

=item CPAN

Adds a 'CPAN mode' which uses CPAN::Shell.

=back

In theory you should be able to remove or replace any of these plugins,
but you better not try this till a more stable version of zoid.

=head2 Key Bindings

Key bindings depend on the ReadLine module that is loaded. See for example
L<Term::ReadLine::Zoid>.

=head2 Settings

The following settings supported by (some) Zoidberg modules.
They are housed in the hash C<< ->{settings} >>.
Also the builtin C<set> command acts on this hash.

( FIXME link to doc on set command )

More advanced settings can be found in L<zoiddevel>.

=over 4

=item noglob

Disable path expansion for shell-like syntax.

=item nocaseglob

When set makes globs case insensitive.

=item nullglob

It allows to have wildcard patterns that expand into an empty list.
The default behavior is to leave the pattern unchanged  
when it is syntactically incorrect, or when the list of matching pathnames is empty.

=item voidbraces