Barbie > App-Maisha-0.18 > App::Maisha::Shell

Download:
App-Maisha-0.18.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.18   Source   Latest Release: App-Maisha-0.20

NAME ^

App::Maisha::Shell - A command line social micro-blog networking tool.

SYNOPSIS ^

  use App::Maisha::Shell;
  my $shell = App::Maisha::Shell->new;

DESCRIPTION ^

This distribution provides the ability to micro-blog via social networking websites and services, such as Identica and Twitter.

METHODS ^

Constructor

Configuration Methods

Run Methods

The run methods are handlers to run the specific command requested.

Help Methods

The help methods are handlers to provide additional information about the named command when the 'help' command is used, with the name of a command as an argument.

Summary Methods

When the 'help' command is requested, with no additonal arguments, a summary of the available commands is display, with the text from each specific command summary method handler.

Completion Methods

For some commands completion methods are available to help complete the command request. for example with the 'use' command, pressing <TAB> will attempt to complete the name of the Network plugin name for you.

Connect Methods

The connect methods provide the handlers to connect to a service. This is performed automatically on startup for all the services provided in your configuration file.

Disconnect Methods

The disconnect methods provide the handlers to disconnect from a service.

Use Methods

The use methods provide the handlers change the primary service. The primary service is used by the main messaging commands. All available services are used when 'update' or 'say' are used.

Followers Methods

The followers methods provide the handlers for the 'followers' command.

Follow Methods

The follow methods provide the handlers for the 'follow' command.

Unfollow Methods

The unfollow methods provide the handlers for the 'unfollow' command.

User Methods

The user methods provide the handlers display the profile of a named user.

User Timeline Methods

The user timeline methods provide the handlers for the 'user_timeline' command. Note that the 'ut' is an alias to 'user_timeline'.

The user_timeline command has one optional parameter:

  maisha> ut [limit]

Friends Methods

The friends methods provide the handlers for the 'friends' command.

Friends Timeline Methods

The friends timeline methods provide the handlers for the 'friends_timeline' command. Note that the 'ft' is an alias to 'friends_timeline'.

The friends_timeline command has one optional parameter:

  maisha> ft [limit]

Public Timeline Methods

The public timeline methods provide the handlers for the 'public_timeline' command. Note that the 'pt' is an alias to 'public_timeline'.

The public_timeline command has one optional parameter:

  maisha> pt [limit]

Update Methods

The update methods provide the handlers for the 'update' command. Note that 'say' is an alias for 'update'.

Reply Methods

The reply methods provide the handlers for the 'replies' command. Note that 're' is an aliases for 'replies'

The replies command has one optional parameter:

  maisha> re [limit]

Direct Message Methods

The direct message methods provide the handlers for the 'direct_message' command. Note that 'dm' is an aliases for 'direct_message'.

The direct_message command has two optional parameters:

  maisha> dm [from|to] [limit]

  maisha> dm from
  maisha> dm to 10
  maisha> dm 5
  maisha> dm

The first above is the usage, with the keywords 'from' and 'to' both being optional. If neither is specified, 'to' is assumed. In addition a limit for the number of message can be provided. If no limit is given, your configured default, or the system default (20) is used.

Send Message Methods

The send message methods provide the handlers for the 'send_message' command. Note that both 'send' and 'sm' are aliases to 'send_message'

Search Methods

These methods provide the handlers for the 'search' command.

The search command has one optional, and one mandatory parameter:

  maisha> search [limit] term [term ...]

  maisha> search term
  maisha> search 10 term
  maisha> search a really long search term
  maisha> search 20 a really long search term

If the first parameter is a number, this will be treated as the limit value, used to limit the number of messages displayed.

About Methods

These methods provide the handlers for the 'about' command.

Version Methods

The quit methods provide the handlers for the 'version' command.

Debug Methods

The debug methods provide more verbose error mesages if commands fail.

The debug command has two optional parameters:

  maisha> debug on|off

  maisha> debug on
  maisha> debug off

Quit Methods

The quit methods provide the handlers for the 'quit' command. Note that both 'quit' and 'q' are aliases to 'exit'

Internal Shell Methods

Used internally to interface with the underlying shell application.

SEE ALSO ^

For further information regarding the commands and configuration, please see the 'maisha' script included with this distribution.

App::Maisha

Term::Shell

WEBSITES ^

AUTHOR ^

  Barbie, <barbie@cpan.org>
  for Miss Barbell Productions <http://www.missbarbell.co.uk>.

COPYRIGHT AND LICENSE ^

  Copyright (C) 2009-2012 by Barbie

  This module is free software; you can redistribute it and/or
  modify it under the Artistic License v2.
syntax highlighting: