.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "RAGGLE 1" .TH RAGGLE 1 "2005-12-10" "perl v5.8.7" "User Contributed Perl Documentation" .SH "NAME" raggle \- Console RSS aggregator. .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBraggle\fR [\fB\-aAhlvV\fR] [\fB\-\-add\fR [\fIurl\fR]] [\fB\-\-ascii\fR] [\fB\-\-default\-config\fR] [\fB\-\-diag\fR] [\fB\-\-force\fR] [\fB\-\-help\fR] [\fB\-\-list\fR] [\fB\-\-lock\-title\fR] [\fB\-\-purge\fR] [\fB\-\-save\-items\fR] [\fB\-\-server\fR [\fIport\fR]] [\fB\-\-sort\fR] [\fB\-\-unlock\-title\fR] [\fB\-\-unsave\-items\fR] [\fB\-\-usage\fR] [\fB\-\-verbose\fR] [\fB\-\-version\fR] [\fB\-c\fR \fIfile\fR] [\fB\-\-config\fR \fIfile\fR] [\fB\-d\fR \fIfeed\fR] [\fB\-\-delete\fR \fIfeed\fR] [\fB\-e\fR \fIfeed\fR] [\fB\-\-edit\fR \fIfeed\fR] [\fB\-\-export\-opml\fR \fIfile\fR] [\fB\-f\fR \fIstring\fR] [\fB\-\-find\-feeds\fR \fIstring\fR] [\fB\-\-import\-opml\fR \fIfile\fR/\fIuri\fR] [\fB\-i\fR \fIfeed\fR] [\fB\-\-invalidate\fR \fIfeed\fR] [\fB\-\-max\fR \fInum\fR] [\fB\-p\fR \fIpriority\fR] [\fB\-\-priority\fR \fIpriority\fR] [\fB\-r\fR \fIrefresh_time\fR] [\fB\-\-refresh\fR \fIrefresh_time\fR] [\fB\-t\fR \fItitle\fR] [\fB\-\-title\fR \fItitle\fR] [\fB\-u\fR \fIurl\fR] [\fB\-\-url\fR \fIurl\fR] [\fB\-\-U\fR \fIfeed\fR] [\fB\-\-update\fR \fIfeed\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBraggle\fR is a curses-based \s-1RSS\s0 aggregator. .PP The following options are available: .IP "\fB\-a\fR [\fIurl\fR] \fB\-\-add\fR [\fIurl\fR]" 5 .IX Item "-a [url] --add [url]" Add a new feed. You can optionally specify \fIurl\fR, otherwise it requires \fB\-\-url\fR. .IP "\fB\-A\fR \fB\-\-ascii\fR" 5 .IX Item "-A --ascii" Use \s-1ASCII\s0 graphics for windows. .IP "\fB\-c\fR \fIfile\fR \fB\-\-config\fR \fIfile\fR" 5 .IX Item "-c file --config file" Use \fIfile\fR as an alternate configuration file. .IP "\fB\-d\fR \fIfeed\fR \fB\-\-delete\fR \fIfeed\fR" 5 .IX Item "-d feed --delete feed" Delete \fIfeed\fR from the feed list. .IP "\fB\-\-default\-config\fR" 5 .IX Item "--default-config" Print out the default configuration of Raggle in a format suitable for your config.rb file. .IP "\fB\-\-diag\fR" 5 .IX Item "--diag" Print out full stack traces, and other diagnostic information intended for bug hunting. .IP "\fB\-e\fR \fIfeed\fR \fB\-\-edit\fR \fIfeed\fR" 5 .IX Item "-e feed --edit feed" Edit \fIfeed\fR's information. .IP "\fB\-\-export\-opml\fR \fIfile\fR" 5 .IX Item "--export-opml file" Export all feeds to \fIfile\fR in \s-1OPML\s0 format. .IP "\fB\-f\fR \fIstring\fR \fB\-\-find\fR \fIstring\fR" 5 .IX Item "-f string --find string" Find a feed containing \fIstring\fR (uses Syndic8). .IP "\fB\-\-force\fR" 5 .IX Item "--force" Force an edit/addition to succeed even if it wants to do things that are generally unwise. .IP "\fB\-h\fR \fB\-\-help\fR \fB\-\-usage\fR" 5 .IX Item "-h --help --usage" Show usage information. .IP "\fB\-\-import\-opml\fR \fIfile\fR/\fIuri\fR" 5 .IX Item "--import-opml file/uri" Import feeds from an \s-1OPML\s0 format \fIfile\fR or \fIuri\fR. .IP "\fB\-i\fR \fIfeed\fR \fB\-\-invalidate\fR \fIfeed\fR" 5 .IX Item "-i feed --invalidate feed" Invalidate \fIfeed\fR (force it to be refreshed). If \-1 is given as \&\fIfeed\fR then all feeds are updated. .IP "\fB\-l\fR \fB\-\-list\fR" 5 .IX Item "-l --list" List current feeds. Use \-v or \-\-verbose to display extra info. .IP "\fB\-\-lock\-title\fR" 5 .IX Item "--lock-title" Lock the title of a feed (blocks updating of a feed's title from data in the feed itself), used with \fB\-\-add\fR or \fB\-\-edit\fR. .IP "\fB\-\-max\fR \fInum\fR" 5 .IX Item "--max num" Set the maximum number of items in a feed to \fInum\fR. Automatically sets \&\-\-save\-items. .IP "\fB\-p\fR \fIpriority\fR \fB\-\-priority\fR \fIpriority\fR" 5 .IX Item "-p priority --priority priority" Set the feed priority to \fIpriority\fR. 0 is the default, higher values will sort a feed closer to the top. .IP "\fB\-\-purge\fR" 5 .IX Item "--purge" Purge deleted feeds from the feed cache. .IP "\fB\-r\fR \fIrefresh_time\fR \fB\-\-refresh\fR \fIrefresh_time\fR" 5 .IX Item "-r refresh_time --refresh refresh_time" Set a feed's refresh time to \fIrefresh_time\fR; used with \fB\-\-add\fR or \fB\-\-edit\fR. .IP "\fB\-\-save\-items\fR" 5 .IX Item "--save-items" Save all old items from a feed rather than replacing them with newly fetched ones; used with \fB\-\-add\fR or \fB\-\-edit\fR. .IP "\fB\-\-server\fR [\fIport\fR]" 5 .IX Item "--server [port]" Run Raggle in \s-1HTTP\s0 server mode, optionally specifying a \fIport\fR. .IP "\fB\-\-sort\fR" 5 .IX Item "--sort" Sort feed list by priority then by title, case\-insensitive. .IP "\fB\-t\fR \fItitle\fR \fB\-\-title\fR \fItitle\fR" 5 .IX Item "-t title --title title" Set a feed's title to \fItitle\fR, used with \fB\-\-add\fR or \fB\-\-edit\fR. .IP "\fB\-\-unlock\-title\fR" 5 .IX Item "--unlock-title" Reverse the actions of \fB\-\-lock\-title\fR, causing it to be updated from the title stored in the \s-1RSS\s0 feed; used with \fB\-\-add\fR or \&\fB\-\-edit\fR. .IP "\fB\-\-unsave\-items\fR" 5 .IX Item "--unsave-items" Reverse the actions of \fB\-\-save\-items\fR, cause old items to be removed from the feed cache; used with \fB\-\-add\fR or \fB\-\-edit\fR. .IP "\fB\-U\fR \fIfeed\fR \fB\-\-update\fR \fIfeed\fR" 5 .IX Item "-U feed --update feed" Update the specified feed (or \fIall\fR for all feeds). .IP "\fB\-u\fR \fIurl\fR \fB\-\-url\fR \fIurl\fR" 5 .IX Item "-u url --url url" Set the \s-1URL\s0 from which to retrieve a feed to \fIurl\fR, used with \&\fB\-\-add\fR or \fB\-\-edit\fR. .IP "\fB\-v\fR \fB\-\-verbose\fR" 5 .IX Item "-v --verbose" Turns on verbose output, displaying extra info on the command line. .IP "\fB\-V\fR \fB\-\-version\fR" 5 .IX Item "-V --version" Show \fBraggle\fR version. .SH "KEYS: MOTION" .IX Header "KEYS: MOTION" .IP "\fIF12\fR, \fIq\fR" 5 .IX Item "F12, q" Quit \fBraggle\fR .IP "\fIRight Arrow\fR, \fITab\fR, \fIl\fR" 5 .IX Item "Right Arrow, Tab, l" Move to the next window. .IP "\fILeft Arrow\fR, \fIh\fR" 5 .IX Item "Left Arrow, h" Move to the previous window. .IP "\fIUp Arrow\fR, \fIk\fR" 5 .IX Item "Up Arrow, k" Scroll up. .IP "\fIDown Arrow\fR, \fIj\fR" 5 .IX Item "Down Arrow, j" Scroll down. .IP "\fIEnd\fR, \fI$\fR, \fIG\fR" 5 .IX Item "End, $, G" Scroll to bottom. .IP "\fIHome\fR, \fI0\fR, \fIg\fR" 5 .IX Item "Home, 0, g" Scroll to top. .IP "\fIPageUp\fR" 5 .IX Item "PageUp" Scroll up one page. .IP "\fIPageDown\fR" 5 .IX Item "PageDown" Scroll down one page. .SH "KEYS: INTERACTION" .IX Header "KEYS: INTERACTION" .IP "\fIReturn\fR, \fISpace\fR" 5 .IX Item "Return, Space" Select item. .IP "\fIo\fR" 5 .IX Item "o" Open the current feed or item's link in your browser. .IP "\fI1\fR through \fI9\fR" 5 .IX Item "1 through 9" Open a link from the current story in your browser. Link numbers are given at the bottom of the description window. .IP "\fIu\fR" 5 .IX Item "u" Move item up. .IP "\fId\fR" 5 .IX Item "d" Move item down. .IP "\fIa\fR" 5 .IX Item "a" Add a feed. Will add the currently selected feed after a search via \fIf\fR, otherwise you will be prompted for the address. .IP "\fIO\fR" 5 .IX Item "O" Import or export an \s-1OPML\s0 copy of your feed list. If the given name is an existing file or a \s-1URI\s0, it will be imported; otherwise, a new \s-1OPML\s0 file will be created with the given name. .IP "\fIe\fR" 5 .IX Item "e" Edit the current feed's options to your liking. .IP "\fII\fR" 5 .IX Item "I" Invalidate the current feed, causing a refresh. .IP "\fIDelete\fR" 5 .IX Item "Delete" Delete feed or item. .IP "\fIy\fR" 5 .IX Item "y" Undelete all items in the current feed. .IP "\fI/\fR" 5 .IX Item "/" Find an entry. .IP "\fIf\fR" 5 .IX Item "f" Search for a feed via Syndic8. .IP "\fIp\fR" 5 .IX Item "p" Select previous unread item. .IP "\fIn\fR" 5 .IX Item "n" Select next unread item. .IP "\fIm\fR" 5 .IX Item "m" Mark all items as read. .IP "\fIM\fR" 5 .IX Item "M" Mark all items as unread. .IP "\fIN\fR" 5 .IX Item "N" Mark current item as unread. .IP "\fIs\fR" 5 .IX Item "s" Sort list. .IP "\fIr\fR" 5 .IX Item "r" Lower the current feed's sorting priority. .IP "\fIR\fR" 5 .IX Item "R" Raise the current feed's sorting priority. .IP "\fIc\fR" 5 .IX Item "c" Select a feed category to view. .IP "\fIC\fR" 5 .IX Item "C" Close the current window. .SH "KEYS: SYSTEM" .IX Header "KEYS: SYSTEM" .IP "\fI!\fR" 5 .IX Item "!" Run a shell in the foreground (exit from it to get back to \fBraggle\fR) .IP "\fI?\fR" 5 .IX Item "?" Show current key bindings. .IP "\fI\e\fR" 5 .IX Item "" View item source. .IP "\fIU\fR" 5 .IX Item "U" Start a manual update of feeds. .IP "\fIS\fR" 5 .IX Item "S" Start a manual save of feeds and configuration. .IP "\fIC\-l\fR" 5 .IX Item "C-l" Redraw the screen. .SH "EXAMPLES" .IX Header "EXAMPLES" Add a feed called \*(L"Bar\*(R" updating every 2 hours. $ raggle \-\-add \-t Bar \-\-url http://foo.com/bar.rss \-\-refresh 120 .Sp Add a feed called \*(L"Baz\*(R" that will sort to the top. $ raggle \-a \-t \*(L"Baz\*(R" \-u http://foo.com/baz.rss \-\-priority 10 .Sp Change the refresh time of the \*(L"Bar\*(R" feed to update every hour. $ raggle \-\-edit 1 \-\-refresh 60 .Sp Don't update feed #1's title from the \s-1RSS\s0. $ raggle \-e 1 \-\-lock\-title .Sp Keep old items associated with feed #16. $ raggle \-e 16 \-\-save\-items .Sp Update feed #1's title from the \s-1RSS\s0 info. $ raggle \-e 1 \-\-unlock\-title .Sp Change the \s-1URL\s0 of feed #3. $ raggle \-e 3 \-u http://www.slashdot.org/slashdot.rss .Sp Export all feeds to foo.opml $ raggle \-\-export\-opml foo.opml .Sp Import all feeds from foo.opml, and set their refresh time to 90 minutes. $ raggle \-\-import\-opml foo.opml \-r 90 .Sp Import all feeds from foo.opml, and set their refresh time to 90 minutes. $ raggle \-\-import\-opml foo.opml \-r 90 .Sp Find feed matching the string \*(L"halffull\*(R" $ raggle \-\-find halffull .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .IP "\fB\s-1BROWSER\s0\fR" 5 .IX Item "BROWSER" Used to find a suitable web browser (see \fB\s-1RAGGLE_BROWSER\s0\fR). .IP "\fB\s-1HOME\s0\fR" 5 .IX Item "HOME" Used to find the Raggle configuration directory. .IP "\fBhttp_proxy\fR" 5 .IX Item "http_proxy" \&\s-1HTTP\s0 Proxy server, in the format "http://\fIhost\fR:\fIport\fR/". .IP "\fBno_proxy\fR" 5 .IX Item "no_proxy" Comma-delimited list of hosts and domains to connect directly to (only applicable if you're using an \s-1HTTP\s0 proxy). .IP "\fB\s-1PATH\s0\fR" 5 .IX Item "PATH" Used to find a suitable web browser (see \fB\s-1RAGGLE_BROWSER\s0\fR). .IP "\fB\s-1RAGGLE_BROWSER\s0\fR" 5 .IX Item "RAGGLE_BROWSER" Path to the web browser Raggle should use when a feed item is opened. If \fB\s-1RAGGLE_BROWSER\s0\fR isn't set, Raggle checks \&\fB\s-1BROWSER\s0\fR, then looks for common command-line browsers in \fB\s-1PATH\s0\fR. Note: this behavior can be overridden by setting the 'browser' config directive in your Raggle configuration file. .IP "\fB\s-1RAGGLE_WEB_DATA\s0\fR" 5 .IX Item "RAGGLE_WEB_DATA" Used to find the web interface data files. If it's not set, Raggle looks for a directory called \*(L"web_ui\*(R" in the configuration directory. .IP "\fB\s-1SHELL\s0\fR" 5 .IX Item "SHELL" Shell to launch when invoking a sub\-shell. .IP "\fB\s-1WINDOW\s0\fR" 5 .IX Item "WINDOW" Used to determine if Raggle is running in screen. .SH "BUGS" .IX Header "BUGS" .IP "\fB*\fR" 5 .IX Item "*" Pressing Ctrl-C while adding a feed will cause Raggle to exit unexpectedly, not cancel. .IP "\fB*\fR" 5 .IX Item "*" It's possible that feeds.yaml will be mistakenly written as an Array rather than a FeedList for no apparent reason. .IP "\fB*\fR" 5 .IX Item "*" Possibly more! Please report any you find to <\fIraggle\-dev@raggle.org\fR> .SH "HISTORY" .IX Header "HISTORY" .IP "\fBraggle\fR 0.1 was released on 23 Jun, 2003" 5 .IX Item "raggle 0.1 was released on 23 Jun, 2003" .PD 0 .IP "\fBraggle\fR 0.2 was released on 17 Aug, 2003" 5 .IX Item "raggle 0.2 was released on 17 Aug, 2003" .IP "\fBraggle\fR 0.3 was released on 20 Feb, 2004" 5 .IX Item "raggle 0.3 was released on 20 Feb, 2004" .IP "\fBraggle\fR 0.4 was released on 15 Mar, 2005" 5 .IX Item "raggle 0.4 was released on 15 Mar, 2005" .PD .SH "AUTHORS" .IX Header "AUTHORS" .IP "Paul Duncan <\fIpabs@pablotron.org\fR>," 5 .IX Item "Paul Duncan ," .PD 0 .IP "Richard Lowe <\fIrichlowe@richlowe.net\fR>," 5 .IX Item "Richard Lowe ," .IP "Ville Aine <\fIvaine@cs.helsinki.fi\fR>," 5 .IX Item "Ville Aine ," .IP "Thomas Kirchner <\fIredshift@halffull.org\fR>" 5 .IX Item "Thomas Kirchner "