Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 120 lines (60 sloc) 4.206 kb
def8934 Making some changes to the distribution to make it easier for it to b…
crnelson authored
1 =head1 NAME
2
3 tircd - An ircd proxy to the twitter API
4
5 =head1 DESCRIPTION
6
7 tircd presents twitter as an irc channel. You can connect to tircd with any irc client, and twitter as if you were on irc
8
9 =head1 INSTALLATION
10
11 tircd requires a recent version of perl, and the following modules:
12
13 L<POE>
14
15 L<POE::Filter::IRCD>
16
17 L<Net::Twitter>
18
19 You can install them all by running:
20
21 C<cpan -i POE POE::Filter::IRCD Net::Twitter>
22
23 =head1 USAGE
24
25 =over
26
27 =item Running tircd
28
29 C<./tircd.pl [/path/to/tircd.cfg]>
30
3d39cfe Minor documentation updates
crnelson authored
31 When started, tircd will look for a configuration file in the following places:
32
33 F<tircd.cfg> (in the current directory)
34
35 F<~/.tircd>
36
37 F</etc/tircd.cfg>
38
def8934 Making some changes to the distribution to make it easier for it to b…
crnelson authored
39 You can specify an alternate path to the configuration file on the commandline if you want to keep the configuration in another location.
40
41 =item Connecting
42
43 By default, tircd listens on localhost port 6667.
44
45 When connecting to tircd, you must ensure that your NICK is set to your twitter username, and that you send PASS with your twitter password.
46
47 With many irc clients you can do this by issuing the command /SERVER [hostname running tircd] 6667 <your twitter password> <your twitter username>. Check your client's documentation for the appropirate syntax.
48
49 Once connected JOIN #twitter to get started. The channel #twitter is where you will perform most opertions
50
51 =item Updating your status
52
53 To update your status on twitter, simply send a message to the #twitter channel. The server will keep your most recent update in the topic at all times.
54
55 =item Getting your friend's status
56
57 When users you follow update their status, it will be sent to the channel as a message from them.
58
59 @replies are also sent to the channel as messages.
60
61 =item Listing the users you follow
62
63 Each user you follow will be in the #twitter channel. If you follow a new user outside of tircd, that user will join the channel the first time they update their status. People who follow you back are given voice (+v) to indicate that fact.
64
65
66 =item Direct Messages
67
68 Direct messages to you will show up as a private message from the user.
69
70 To send a direct message, simply send a private message to the user you want to dm.
71
72 =item Getting additional information on users
73
74 You can /who or /whois a user to view their Location / Bio / Website. Their last status update (and time sent) will also be returned.
75
76 Issuing a /whois on your own user name will also provide the number of API calls that have been used in the last hour.
77
78 =item Following new users
79
80 To begin following a new user, simply /invite them to #twitter. The user will join the channel if the request to follow was successful. If you attempt to invite a user who protects their updates, you will receive a notice that you have requested to follow them. The user will join the channel if they accept your request and update their status.
81
82 =item Unfollowing / removing users
83
84 To stop following a user, /kick them from #twitter.
85
86 =item Blocking users
87
88 To block a user /ban them.
89 There is currently no way to get a list of users you've currently blocked via the API, so listing the bans in #twitter will only return users you've blocked in the current session.
90
91 =item Unblocking users
92
93 To unblock a user /unban them.
94
8cada4d Updated to version 0.7
crnelson authored
95 =item Multiple Channels / Groups
96
97 If you want to create a channel with just a subset of the people you follow, you can /join <any channel> and then /invite them to the channel. tircd will send a user's updates to #twitter and any other channels you have invited a user to.
98
99 =item Search
100
101 If you want to have updated search results for a specific term delivered, you can /join <any channel> then set the /topic for the channnel to your search query. Results that match that query will be sent to that channel. The /topic can be almost anything supported by the twitter search (see http://search.twitter.com/operators for exmaples). Using the 'near' option is not currently supported.
102
def8934 Making some changes to the distribution to make it easier for it to b…
crnelson authored
103 =back
104
105 =head1 AUTHOR
106
107 Chris Nelson <cnelson@crazybrain.org>
108
109 =head1 LICENSE
110
111 This module may be used, modified, and distributed under the same terms as Perl itself. Please see the license that came with your Perl distribution for details.
112
113 =head1 SEE ALSO
114
115 L<POE>
116
117 L<POE::Filter::IRCD>
118
119 L<Net::Twitter>
Something went wrong with that request. Please try again.