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
new
Configuration Methods
context
Used internally to reference the current shell for command handlers.
limit
Used by timeline commands to limit the number of messages displayed. The default setting will display the last 20 messages.
order
Used by timeline commands to order the messages displayed. The default is to display messages in descending order, with the most recent first and the oldest last.
To reverse this order, set the 'order' as 'ascending' (or 'asc') in your configuration file. (case insensitive).
networks
Sets the networks list that will appear above the command line.
prompt_str
Sets the prompt string that will appear on the command line.
tag_str
Sets the text that will appear at the end of your message.
In order to suppress the tag string set the 'tag' option to '.' in your configuration file.
services
Provides the order of services available, the first is always the primary service.
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.
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.
connect
run_connect =item * help_connect =item * smry_connect
Disconnect Methods
The disconnect methods provide the handlers to disconnect from a service.
run_disconnect =item * help_disconnect =item * smry_disconnect
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.
run_use =item * help_use =item * smry_use
Followers Methods
The followers methods provide the handlers for the 'followers' command.
run_followers =item * help_followers =item * smry_followers
Follow Methods
The follow methods provide the handlers for the 'follow' command.
run_follow =item * help_follow =item * smry_follow
Unfollow Methods
The unfollow methods provide the handlers for the 'unfollow' command.
run_unfollow =item * help_unfollow =item * smry_unfollow
User Methods
The user methods provide the handlers display the profile of a named user.
run_user =item * help_user =item * smry_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'.
run_user_timeline =item * help_user_timeline =item * smry_user_timeline
run_ut =item * help_ut =item * smry_ut
Friends Methods
The friends methods provide the handlers for the 'friends' command.
run_friends =item * help_friends =item * smry_friends
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'.
run_friends_timeline =item * help_friends_timeline =item * smry_friends_timeline
run_ft =item * help_ft =item * smry_ft
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'.
run_public_timeline =item * help_public_timeline =item * smry_public_timeline
run_pt =item * help_pt =item * smry_pt
Update Methods
The update methods provide the handlers for the 'update' command. Note that 'say' is an alias for 'update'.
run_update =item * help_update =item * smry_update
run_say =item * help_say =item * smry_say
Reply Methods
The reply methods provide the handlers for the 'replies' command. Note that 're' is an aliases for 'replies'
run_replies =item * help_replies =item * smry_replies
run_re =item * help_re =item * smry_re
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 to optional parameters:
maisha> dm [from|to] [limit]
maisha> dm from
maisha> dm to 10
maisha> dm 5
maisha> dmThe 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.
run_direct_messages =item * help_direct_messages =item * smry_direct_messages
run_dm =item * help_dm =item * smry_dm
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'
run_send_message =item * help_send_message =item * smry_send_message
run_send =item * help_send =item * smry_send
run_sm =item * help_sm =item * smry_sm
Quit Methods
The quit methods provide the handlers for the 'quit' command. Note that both 'quit' and 'q' are aliases to 'exit'
run_quit =item * help_quit =item * smry_quit
run_q =item * help_q =item * smry_q
Post Command Methods
Used to display the current networks list above the command line.
postcmd
SEE ALSO
For further information regarding the commands and configuration, please see the 'maisha' script included with this distribution.
App::Maisha - http://maisha.grango.org
AUTHOR
Copyright (c) 2009 Barbie <barbie@cpan.org> Miss Barbell Productions.
LICENSE
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
See http://www.perl.com/perl/misc/Artistic.html