Graham Ollis > Shell-Guess > Shell::Guess

Download:
Shell-Guess-0.05.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.05   Source  

NAME ^

Shell::Guess - Make an educated guess about the shell in use

VERSION ^

version 0.05

SYNOPSIS ^

guessing shell which called the Perl script:

 use Shell::Guess;
 my $shell = Shell::Guess->running_shell;
 if($shell->is_c) {
   print "setenv FOO bar\n";
 } elsif($shell->is_bourne) {
   print "export FOO=bar\n";
 }

guessing the current user's login shell:

 use Shell::Guess;
 my $shell = Shell::Guess->login_shell;
 print $shell->name, "\n";

guessing an arbitrary user's login shell:

 use Shell::Guess;
 my $shell = Shell::Guess->login_shell('bob');
 print $shell->name, "\n";

DESCRIPTION ^

Shell::Guess makes a reasonably aggressive attempt to determine the shell being employed by the user, either the shell that executed the perl script directly (the "running" shell), or the users' login shell (the "login" shell). It does this by a variety of means available to it, depending on the platform that it is running on.

The intended use of this module is to enable a Perl developer to write a script that generates shell configurations for the calling shell so they can be imported back into the calling shell using eval and backticks or source. For example, if your script looks like this:

 #!/usr/bin/perl
 use Shell::Guess;
 my $shell = Shell::Guess->running_shell;
 if($shell->is_bourne) {
   print "export FOO=bar\n";
 } else($shell->is_c) {
   print "setenv FOO bar\n";
 } else {
   die "I don't support ", $shell->name, " shell";
 }

You can then import FOO into your bash or c shell like this:

 % eval `perl script.pl`

or, you can write the output to a configuration file and source it:

 % perl script.pl > foo.sh
 % source foo.sh

Shell::Config::Generate provides a portable interface for generating such shell configurations, and is designed to work with this module.

CLASS METHODS ^

These class methods return an instance of Shell::Guess, which can then be interrogated by the instance methods in the next section below.

Shell::Guess->running_shell

Returns an instance of Shell::Guess based on the shell which directly started the current Perl script. If the running shell cannot be determined, it will return the login shell.

Shell::Guess->login_shell( [ $username ] )

Returns an instance of Shell::Guess for the given user. If no username is specified then the current user will be used. If no shell can be guessed then a reasonable fallback will be chosen based on your platform.

Shell::Guess->bash_shell

Returns an instance of Shell::Guess for bash.

The following instance methods will return:

All other instance methods will return false

Shell::Guess->bourne_shell

Returns an instance of Shell::Guess for the bourne shell.

The following instance methods will return:

All other instance methods will return false

Shell::Guess->c_shell

Returns an instance of Shell::Guess for c shell.

The following instance methods will return:

All other instance methods will return false

Shell::Guess->cmd_shell

Returns an instance of Shell::Guess for the Windows NT cmd shell (cmd.exe).

The following instance methods will return:

All other instance methods will return false

Shell::Guess->command_shell

Returns an instance of Shell::Guess for the Windows 95 command shell (command.com).

The following instance methods will return:

All other instance methods will return false

Shell::Guess->dcl_shell

Returns an instance of Shell::Guess for the OpenVMS dcl shell.

The following instance methods will return:

All other instance methods will return false

Shell::Guess->fish_shell

Returns an instance of Shell::Guess for the fish shell.

The following instance methods will return:

Shell::Guess->korn_shell

Returns an instance of Shell::Guess for the korn shell.

The following instance methods will return:

All other instance methods will return false

Shell::Guess->power_shell

Returns an instance of Shell::Guess for Windows PowerShell.

The following instance methods will return:

All other instance methods will return false

Shell::Guess->tc_shell

Returns an instance of Shell::Guess for tcsh.

The following instance methods will return:

All other instance methods will return false

Shell::Guess->z_shell

Returns an instance of Shell::Guess for zsh.

The following instance methods will return:

All other instance methods will return false

INSTANCE METHODS ^

The normal way to call these is by calling them on the result of either running_shell or login_shell, but they can also be called as class methods, in which case the currently running shell will be used, so

 Shell::Guess->is_bourne

is the same as

 Shell::Guess->running_shell->is_bourne

$shell->is_bash

Returns true if the shell is bash.

$shell->is_bourne

Returns true if the shell is the bourne shell, or a shell which supports bourne syntax (e.g. bash or korn).

$shell->is_c

Returns true if the shell is csh, or a shell which supports csh syntax (e.g. tcsh).

$shell->is_cmd

Returns true if the shell is the Windows command.com shell.

$shell->is_command

Returns true if the shell is the Windows cmd.com shell.

$shell->is_dcl

Returns true if the shell is the OpenVMS dcl shell.

$shell->is_fish

Returns true if the shell is Fish shell.

$shell->is_korn

Returns true if the shell is the korn shell.

$shell->is_power

Returns true if the shell is Windows PowerShell.

$shell->is_tc

Returns true if the shell is tcsh.

$shell->is_unix

Returns true if the shell is traditionally a UNIX shell (e.g. bourne, bash, korn)

$shell->is_vms

Returns true if the shell is traditionally an OpenVMS shell (e.g. dcl)

$shell->is_win32

Returns true if the shell is traditionally a Windows shell (command.com, cmd.exe)

$shell->is_z

Returns true if the shell is zsh

$shell->name

Returns the name of the shell.

$shell->default_location

The usual location for this shell, for example /bin/sh for bourne shell and /bin/csh for c shell. May not be defined for all shells.

CAVEATS ^

Shell::Guess shouldn't ever die or crash, instead it will attempt to make a guess or use a fallback about either the login or running shell even on unsupported operating systems. The fallback is the most common shell on the particular platform that you are using, so on UNIXy platforms the fallback is bourne, and on OpenVMS the fallback is dcl.

These are the operating systems that have been tested in development and are most likely to guess reliably.

UNIXy platforms without a proc filesystem will use Unix::Process if installed, which will execute ps to determine the running shell.

It is pretty easy to fool the ->running_shell method by using fork, or if your Perl script is not otherwise being directly executed by the shell.

Patches are welcome to make other platforms work more reliably.

AUTHOR ^

author: Graham Ollis <plicease@cpan.org>

contributors:

Buddy Burden (BAREFOOT)

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Graham Ollis.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: