
 Twyt - A Twitter client for the easily distracted
---------------------------------------------------

 How to use
------------

   Contents
 ------------
  1. Misc. Commands
  2. Status Message Commands
  3. Direct Message Commands


  1. Misc. Commands
 --------------------

o Show available commands

   twyt help


o Save your username and password to ~/.twytrc (will be chmodded 0600)

   twyt savepass [-u username]

   -u username | --user=username
               Your username. If it has already been set, it can be 
               omitted to only change your password. Using -u after
               your username has been saved will overwrite the first
               username.


  2. Status Message ("tweet") Commands
 ---------------------------------------

o Send a tweet to Twitter (update your status)

   twyt tweet [-u username] [-p pass] A message

   -u | --user  Your Twitter username. Required until savepass is used.
   -p | --pass  Your Twitter password. If omitted you will be prompted. 
                Neither are required if savepass is used.
   A message    Your tweet. If you do not quote the message, characters
                such as ' or " will need to be escaped.


o Delete one of your own previous tweets.

   twyt delete id

   id          Required. The numerical ID of a previous tweet.
               The usertl command is handy for finding your IDs.


o Show 20 most recent statuses in Twitter's public timeline

   twyt publictl [-s since_id]

   -s | --since  Returns only public statuses more recent than the 
                 specified status ID, since_id.

   Note: You will only receive updates, i.e. ones you haven't asked for
   yet, unless you use the --since option.


o Show your, or another person's, timeline

   twyt usertl [-c count] [-s since] [username]

   -c | --count  The number of statuses to retrieve. Limited to 20.
   -s | --since  A date to start the timeline from
   username      The username of the timeline to retrieve. If omitted
                 defaults to your saved username or a username specified
                 with -u or --user= as above. (See savepass)


o Show your, or another person's, friends timeline

   twyt friendstl [-s since] [username]

   -s | --since  A date to start the timeline from
   username      The username of the timeline to retrieve. If omitted
                 defaults to your saved username or a username specified
                 with -u or --user= as above. (See savepass)

   Note: You will only receive updates, i.e. ones you haven't asked for
   yet, unless you use the --since option.


o Show a single status message by ID

   twyt show id

   id           Required. The ID of the status message you want to see.


o Show the Nth page of 20 replies (messages with @yourusername in them)

   twyt replies page

   page         Optional. Shows the pageth page of 20 replies



  3. Direct Message Commands
 -----------------------------

o Send a direct message to another user

   twyt direct [-u username] [-p pass] user A message

   -u | --user  Your Twitter username. Required until savepass is used.
   -p | --pass  Your Twitter password. If omitted you will be prompted. 
                Neither are required if savepass is used.
   user         The user you want to send the message to.
   A message    Your message. If you do not quote the message, characters
                such as ' or " will need to be escaped.


o View the direct messages that were sent to you (max 20 listed)

   twyt directtl [-u username] [-p pass] [-s since] [page]

   -u | --user  Your Twitter username. Required until savepass is used.
   -p | --pass  Your Twitter password. If omitted you will be prompted. 
                Neither are required if savepass is used.
   -s | --since The date or ID of a message to list direct messages from.
   page         List the pageth page of direct messages (default 1)


o View the direct messages that were sent BY you (max 20 listed)

   twyt directsent [-u username] [-p pass] [-s since] [page]

   -u | --user  Your Twitter username. Required until savepass is used.
   -p | --pass  Your Twitter password. If omitted you will be prompted. 
                Neither are required if savepass is used.
   -s | --since The date or ID of a message to list direct messages from.
   page         List the pageth page of direct messages (default 1)


o Delete a direct message that was sent to you.

   twyt directdel id

   id          Required. The numerical ID of a previous direct message.
               The directtl command is handy for finding your IDs.

