NAME
maisha - Micro-blogging From Your Command Line
SYNOPSIS
maisha
maisha -c mymaisha.ini
maisha -v
maisha -u
maisha -hDESCRIPTION
maisha gives you access to micro-blogging from your command line
OPTIONS
--config | -c
Specify the config file to read from. By default, maisha attempts to read a config file named config.ini in the current directory
--version | -v
Print out the version and exit
--usage | -u
Prints out a basic usage help screen
--help | -h
Print out the manual page.
CONFIGURATION
The configuration file must contain at least one micro-blogging service, with your username and password for that service, all other configuration settings are optional.
The configuration file itself can be in in the INI or YAML format, and will default to looking for '.maisha.ini', '.maisha.yml' or '.maisha.yaml' in the user's home directory.
Application Configuration
The configuration for the application itself are contained within a 'CONFIG' section in your configuration file. All settings are optional, and will default to sensible values should they not be user defined.
prompt
The prompt you wish to see on the command line. This will default to 'twitter>' if not configured.
tag
The tag you wish to have added to the end of an update/say command. This will default to '[from maisha]' if not configured. If you do not wish a tag to be added at all, set the tag to '.' in the configuration file.
order
Describes the order for printing status messages when a timeline command is requested. Will default to 'descending' if not configured. Setting is case insensitive and should be set to 'ascending' or 'asc' to reverse the order.
limit
Describes how many status messages should be printed when a timeline command is requested. Will default to the last 20 if not configured.
Service Configuration
For each service you have available (the default install includes 'Identica' and 'Twitter') include an associated section in your configuration file, providing a username and password for that service. If any service fails to connect, a warning is emitted. If the application is not able to connect to any service, the application will terminate with an error message.
username
Your username login to your network service account
password
Your password login to your network service account
COMMANDS
Note that not all services offer all commands. Where commands are not applicable for a service, and appropriate warning message will be emitted.
friends
Displays the most recent status messages from each of your friends.
friends_timeline | ft [<limit>]
Displays the most recent status messages within your friends timeline.
public_timeline | pt [<limit>]
Displays the most recent status messages within the public timeline.
followers
Displays the most recent status messages from each of your followers.
replies | re [<limit>]
Displays the most recent reply messages.
direct_messages | dm [<limit>]
Displays the most recent direct messages you have received.
send_message | send | sm <user> <message>
Post a direct message to another user. Include the username of the person you wish to send a message to, followed by your message, of upto 140 characters in length.
update | say <message>
Posts a new status message, of upto 140 characters in length.
exit | quit | q
Exits the program.
help
Provides help for a specific command, or provides a summary of the commands available if requested with no arguments.
Example Configuration Files
INI Style Configuration
[CONFIG]
order: asc
tag: .
[Identica]
username: yourlogin
password: yourpassword
[Twitter]
username: yourlogin
password: yourpasswordYAML Style Configuration
--- #YAML:1.0
CONFIG:
order: asc
tag: .
Twitter:
username: yourlogin
password: yourpassword
Identica:
username: yourlogin
password: yourpasswordAUTHOR
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