Barbie > App-Maisha > maisha

Download:
App-Maisha-0.21.tar.gz

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

maisha - Micro-blogging From Your Command Line

SYNOPSIS ^

   maisha
   maisha -c mymaisha.ini
   maisha -v
   maisha -u
   maisha -h

DESCRIPTION ^

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 several different formats, XML, YAML, JSON, Windows INI files and even pure Perl are all supported, provided you have the correct distributions to support those file formats. As a guide the following are known to work with this application:

  Config::Tiny    - INI file format
  JSON            - JSON file format
  JSON::Syck      - JSON file format
  XML::Simple     - XML file format
  YAML            - YAML file format
  YAML::Syck      - YAML file format

For further options for other file formats see Config::Tiny for more information. See also examples listed further below.

By default the INI and YAML file formats are used, with the application looking for a default configuration file in your $HOME directory, named '.maisha.ini', '.maisha.yml' or '.maisha.yaml'.

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.

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.

COMMANDS ^

Note that not all services offer all commands. Where commands are not applicable for a service, and appropriate warning message will be emitted.

Example Configuration Files

INI Style Configuration

Requires Config::Tiny to be available.

  [CONFIG]
  order=asc
  tag=.

  [Identica]
  username=yourlogin

  [Twitter]
  username=yourlogin
  password=yourpassword

YAML Style Configuration

Requires YAML or YAML::Syck to be available.

  --- #YAML:1.0
  CONFIG:
    order: asc
    tag: .
  
  Twitter:
    username: yourlogin
  
  Identica:
    username: yourlogin
    password: yourpassword

Perl Style Configuration

No additional dependencies required.

  {
    CONFIG      => {'order': 'asc','tag': '.'},
    Twitter     => {'username': 'yourlogin'},
    Identica    => {'username': 'yourlogin','password': 'yourpassword'},
  }

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: