zoiduser 0.96

zoiduser is an extended user documentation for zoid.

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 zoid --config.

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

The sub dir 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

Commands

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

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

Log

Keeps a history of your doings.

Intel

Takes care of tab expansion.

Provides: complete

ReadLine

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

Provides: readline, readmore and select

CPAN

Adds a CPAN mode which uses CPAN::Shell.

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.

Key Bindings

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

Settings

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

More advanced settings can be found in zoiddevel.

noglob

Disable path expansion for shell-like syntax.

nocaseglob

When set makes globs case insensitive.

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.

voidbraces

Do brace expansion posix compliant instead of bash compatible. This means that braces will be removed even if there is just one word between them.
hide_private_method

Hide all object methods and data structures which have a name starting with an _ unless they are asked for explicitly.

hide_hidden_files

Hide all filesystem nodes which have a name starting with a . unless they are asked for explicitly.

ignoreeof

When this setting is in effect a ^D char, also known as EOF or EOT, wont exit the shell.

naked_zoid

Dont hide the root object behind clothes for things like tab completion and the single arrow operator, but show it in full glory.

notify

Asynchronous notification, dont wait for the respawning of a prompt before notifying the user about background jobs that have finished.

This option should be named notify_async for clearity, but notify is the proper name according to POSIX.

notify_verbose

When you stop a job the shell will show all jobs instead of just notifying just of the one you stopped; makes the behaviour more tcsh(1) like.