Mitter/CHEAT-CODES

========================
Hidden options in Mitter
========================

Mitter have some options that are not completely visible to the user.
Those options reside in the config file (usually ``.mitter.ini`` in
the user home directory) and can affect the application behaviour or
appearance.

Config Format
=============
Before changing anything, you must be aware of the format of the
config file. It's a format called "INI file", where options are
separated by sections. Sections have square brackets around them while
options have an equal sign separating the option name and the option
value. Here is a small example, with a section called *Section* and an
option called *option* with the value *value*::

  [Section]
  option = value


Network Manager
===============
The Network Manager is responsible for managing all the network layers
and provide a single point of access to them for the interfaces. The
network manager uses the ``NetworkManager`` section:

*timeout*
  Timeout for requests, in seconds. This value is (or should) be
  used by all networks. If a quests takes longer than those seconds,
  it will be canceled and the result, a failure. Default value is
  120. Note that only Python 2.6 supports timeout parameters the calls
  Mitter uses.

*save_count*
  Number of operations till the configuration file is saved again.
  Most networks will save their status in the config file, but not
  request it to be saved immediately (nor should they: In case
  something wrong happens, the state in the config file will not be
  reasonable when mitter is run again.) A value of 0 means the
  Network Manager will save the config file after each round of
  requests to all networks (failing or succeding); for devices that
  use flash drives as storage, it's recommended some large value
  (since those storage devices have a lifetime based on the number
  of writes.) Default is '5'.

*proxy*
  The HTTP proxy to be used. Notice that on Windows and OS X systems,
  the system wide proxy will be used, so you don't need to worry about
  this.

Twitter
=======
Twitter is the most famous micro-blogging website and the original
network supported by Mitter. It have the following options:

*https*
  A boolean value (can accept either "True" or "False" as values)
  indicating that HTTPS (secure HTTP) should be used.

*server_url*
  Points to the URL to be used for insecure requests. If *https* is
  False, all requests will go to this URL.

*secure_server_url*
  Points to the URL to be used for secure requests. If *https* is
  True, all requests will go to this URL.

*last_tweet*
  Twitter supports a "since_id" on requests, allowing less (or more)
  requests to be made to retrieve information since the last time
  the user saw their messages. Mitter uses it on every request to
  get just the new messages instead of everything (and not miss any
  tweets in case you leave Mitter close for awhile.) If this value
  is does not exist in the config file, Mitter will request only the
  first page and update this values.

*last_reply*
  Works exactly like *last_tweet*, except for replies.

*message_threshold*
  Twitter uses 20 messages per page, but due their caching mecanism,
  some pages may have less than 20 message on each page (in other
  words, it works like this: they have the result pages set already,
  but when you request something, they finally check if there are
  deleted tweets in it and, if there are any, they are removed
  there, but no new messages are added.) If the number of messages
  is below the threshold, Mitter will not request the next page. The
  default value is '16', or 80% of the default page size.

PyGTK
=====
PyGTK is the default graphical interface. It have the following
options:

*refresh_interval*
  The refresh interval to check for new messages, in minutes.
  Default value is '5'.

*statusicon*
  Display the status icon in the systray. Default is True.

*width*
  Window width, in pixels. It stars with 450, but it's updated when
  Mitter closes.

*height*
  Window height, in pixels. It starts with 300, but it's updated
  when Mitter closes.

*position_x*
  Horizontal position of the window in the screen. It starts with 5,
  but it's saved when Mitter closes.

*position_y*
  Vertical position of the window in the screen. It starts with 5,
  but it's saved when Mitter closes.

*link_colour*
  Color to be used when displaying links. Default value is 'blue';
  it accepts any X11 named colours or hex triplests (like the ones
  used in HTML.)

*spell_check*
  Boolean indicating if the spell checker should be used. To have
  spell checkers enabled, you must have PyAspell installed, so it's
  checked once and, if PyAspell is not installed, will be set as
  False and not checked again. If you install PyAspell after Mitter
  is run the first time, you must manually update this value.

*unread_char*
  The character to indicate a message is unread. The default value is
  '●', which is a bullet in HTML. Beware that not all HTML
  characters are accepted.

*unfavourite_char*
  The character to indicate that a message is not marked as favourite.
  The default value is '★', which is a hallow star. Beware that
  not all HTML characters are accepted.

*favourite_char*
  The character to indicate that a message is marked as favourite. The
  defualt value is '☆', which is a filled star. Beware that not
  all HTML charcters are accepted.

*protected_char*
  The character to indicate that a message is marked as
  protected/private. The default value is
  "<small>(protected)</small>", which is the string (protected) with a
  smaller font. Beware that not all HTML characters are accepted.

*window_title*
  String to be used as window title, which can be updated every time a new
  message or reply appears. Mitter provides 4 variables that can be used:
  - {message_count}: Number of unread messages;
  - {message}: The translatable word for "messages";
  - {replies_count}: Number of unread replies;
  - {replies}: The translatable word for "replies".