| 140 | =head1 SYNOPSIS |
---|
| 141 | |
---|
| 142 | % bloglines2email |
---|
| 143 | % bloglines2email --conf=/path/to/bloglines2email.conf --test --verbose |
---|
| 144 | |
---|
| 145 | =head1 DESCRIPTION |
---|
| 146 | |
---|
| 147 | C<bloglines2email> is a command line application that fetches |
---|
| 148 | Bloglines unread items via Bloglines Web Services and sends them as |
---|
| 149 | HTML mail to your address (Gmail is preferrable). It gives you an easy |
---|
| 150 | way to manage, browse and search Blog entries rather than using |
---|
| 151 | Bloglines interface directly. |
---|
| 152 | |
---|
| 153 | You'd better run this app by crontab like every 5 minutes. |
---|
| 154 | |
---|
| 155 | =head1 REQUIREMENT |
---|
| 156 | |
---|
| 157 | This app requires perl 5.8.0 with following Perl modules installed on your box. |
---|
| 158 | |
---|
| 159 | =over 4 |
---|
| 160 | |
---|
| 161 | =item DateTime |
---|
| 162 | |
---|
| 163 | =item DateTime::Format::Mail |
---|
| 164 | |
---|
| 165 | =item MIME::Lite |
---|
| 166 | |
---|
| 167 | =item Template |
---|
| 168 | |
---|
| 169 | =item WebService::Bloglines |
---|
| 170 | |
---|
| 171 | =item YAML |
---|
| 172 | |
---|
| 173 | =back |
---|
| 174 | |
---|
| 175 | =head1 OPTIONS |
---|
| 176 | |
---|
| 177 | This application has following command line options. |
---|
| 178 | |
---|
| 179 | =over 4 |
---|
| 180 | |
---|
| 181 | =item --test |
---|
| 182 | |
---|
| 183 | Doesn't mark unread items as read. Default: mark read. |
---|
| 184 | |
---|
| 185 | =item --verbose |
---|
| 186 | |
---|
| 187 | Gives diagnostic messages to STDERR. Default: no verbose. |
---|
| 188 | |
---|
| 189 | =item --conf |
---|
| 190 | |
---|
| 191 | Specifies a path of configuration YAML file. Default: |
---|
| 192 | C<bloglines2email.conf> in the same directory as script. |
---|
| 193 | |
---|
| 194 | =back |
---|
| 195 | |
---|
| 196 | =head1 CONFIGURATION |
---|
| 197 | |
---|
| 198 | This app uses C<bloglines2email.conf> that sits beside the script in |
---|
| 199 | the same directory (or you can specify the file path using C<--conf> |
---|
| 200 | option). The distribution has a sample configuration file named |
---|
| 201 | C<bloglines2email.conf.sample> that you can use by copying. |
---|
| 202 | |
---|
| 203 | The config file uses YAML syntax and most of the directives are self-discriptive. |
---|
| 204 | |
---|
| 205 | =over 4 |
---|
| 206 | |
---|
| 207 | =item username, password |
---|
| 208 | |
---|
| 209 | Set your username and password for Bloglines. |
---|
| 210 | |
---|
| 211 | =item mailto |
---|
| 212 | |
---|
| 213 | Set email address that this app sends emails to. Gmail address is recommended. |
---|
| 214 | |
---|
| 215 | =item mailfrom |
---|
| 216 | |
---|
| 217 | Set email address that this app uses for C<From:> header. |
---|
| 218 | |
---|
| 219 | =item mailroute |
---|
| 220 | |
---|
| 221 | Set how to send emails. Default is to use SMTP. |
---|
| 222 | |
---|
| 223 | =item group-items (Optional) |
---|
| 224 | |
---|
| 225 | With this directive on (set to 1), C<bloglines2email> groups updated |
---|
| 226 | items per feed. That reduces a volume of emails sent, and enables a |
---|
| 227 | better user experience with Gmail, thanks to the conversation |
---|
| 228 | threading based on C<Subject> header. Strongly recommended. |
---|
| 229 | |
---|
| 230 | =item date-timezone (Optional) |
---|
| 231 | |
---|
| 232 | Sets Date timezone for outgoing email C<Date:> header and I<Posted on> |
---|
| 233 | phrase inside email body. Default is to use local timezone on your machine. |
---|
| 234 | |
---|
| 235 | =item delicious-username (Optional) |
---|
| 236 | |
---|
| 237 | Sets your del.icio.us username. With this option set, the email body |
---|
| 238 | will have I<Post to del.icio.us> link, which is a handy shortcut for |
---|
| 239 | bookmarking items to the social bookmarking service. |
---|
| 240 | |
---|
| 241 | =head1 DEVELOPMENT |
---|
| 242 | |
---|
| 243 | The newest version is always available via subversion: |
---|
| 244 | |
---|
| 245 | svn://svn.bulknews.net/public/bloglines2email/trunk |
---|
| 246 | |
---|
| 247 | And you can browse the files via ViewCVS at: |
---|
| 248 | |
---|
| 249 | http://svn.bulknews.net/viewcvs/public/bloglines2email/trunk |
---|
| 250 | |
---|
| 251 | Feel free to send patches or suggestions to E<lt>miyagawa@bulknews.netE<gt> |
---|
| 252 | |
---|