← Back to branch summary

~ubuntu-branches/ubuntu/trusty/newsbeuter/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/newsbeuter.txt

  • Committer: Bazaar Package Importer
  • Author(s): Nico Golde
  • Date: 2008-05-01 14:51:20 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080501145120-i65avsclnrpl2cfq
Tags: 0.9-1
http://bugs.debian.org/471434
http://bugs.debian.org/470833
http://bugs.debian.org/467201
* New upstream release.
  - Fix problem displaying titles when using zh_CN.UTF-8
    locale (Closes: #471434).
* Add default configuration to set sensible-browser as browser and
  add dirs file to create /etc/newsbeuter (Closes: #470833).
* remove libnxml-depends and libmrss-depends calls in rules and
  related dependency lines in control since they are not needed
  anymore (Closes: #467201).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/newsbeuter.txt
7
7
Newsbeuter is an RSS feedreader. RSS is a number of widely-used XML formats to
8
8
transmit, publish and syndicate articles, for example news or blog articles.
9
9
Newsbeuter is designed to be used on text terminals on Unix or Unix-like
10
 
systems such as Linux, BSD or Mac OS X.
 
10
systems such as Linux, FreeBSD or Mac OS X. NetBSD is currently not supported,
 
11
due to technical limitations in the iconv() implementation.
11
12
 
12
13
Why "Newsbeuter"?
13
14
~~~~~~~~~~~~~~~~
45
46
- libcurl: http://curlm.haxx.se/download.html[]
46
47
- GNU gettext (on systems that don't provide gettext in the libc): ftp://ftp.gnu.org/gnu/gettext/[]
47
48
- pkg-config: http://pkg-config.freedesktop.org/wiki/[]
48
 
- Ruby 1.8 (optional): http://www.ruby-lang.org/[]
49
 
- Swig (optional; required for Ruby support): http://www.swig.org/[]
50
49
 
51
50
If you intend to modify the filter language parser, you will also need Coco/R for C++,
52
51
which you can download from http://www.ssw.uni-linz.ac.at/coco/[]. The Coco/R binary
53
52
must be installed as "coco-cpp" in your PATH. Debian users only need to install
54
53
the package "coco-cpp".
55
54
 
56
 
If you have Ruby 1.8 development libraries installed, the newsbeuter build
57
 
system will attempt to find the appropriate parameters to compile and link
58
 
newsbeuter with Ruby support.
59
 
 
60
55
 
61
56
Compiling and Installing
62
57
~~~~~~~~~~~~~~~~~~~~~~~~
111
106
enqueue|e|Add the podcast download URL of the current article (if any is found) to the podcast download queue (see below for more information on podcast support).
112
107
reload-urls|^R|Reload the URLs configuration file.
113
108
redraw|^L|Redraw the screen.
114
 
run|n/a|Run a Ruby function (only available from within macros, see below).
115
109
cmdline|:|Open the command line.
116
110
set-filter|F|Set a filter.
117
111
select-filter|f|Select a predefined filter.
120
114
edit-flags|^E|Edit the flags of the currently selected article.
121
115
next-unread-feed|^N|Go to the next feed with unread articles. This only works from the article list.
122
116
prev-unread-feed|^P|Go to the previous feed with unread articles. This only works from the article list.
 
117
delete-article|D|Delete the currently selected article.
 
118
purge-deleted|$|Purge all article that are marked as deleted from the article list.
123
119
up|UP|Goes up one item in the list.
124
120
down|DOWN|Goes down one item in the list.
125
121
pageup|PPAGE|Goes up one page in the list.
319
315
save:save <filename>:Save the currently select article to disk. This works in the article list and in the article view.:save ~/important.txt
320
316
set:set <variable>[=<value>]:Set configuration variable <variable> to <value>. If no value is specified, the current value is printed out:set reload-time=15
321
317
tag:tag <tagname>:Only display feeds with the tag <tagname>.:tag news
 
318
goto:goto <case-insensitive substring>:Go to the next feed whose name contains the case-insensitive substring.:goto foo
322
319
n/a:<number>:Jump to the entry with the index <number> (usually seen at the left side of the list). This currently works for the feed list and the article list.:30
323
320
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
324
321
 
572
569
When the user presses the macro prefix ("," by default) and then the "k" key,
573
570
the three operations "open", "reload" and "quit" will be executed subsequently.
574
571
 
575
 
Ruby Support
576
 
~~~~~~~~~~~
577
 
 
578
 
In order to run Ruby functions from within newsbeuter, you first need to load
579
 
a Ruby file into the embedded Ruby interpreter via the configuration file:
580
 
 
581
 
        load "test.rb"
582
 
 
583
 
In our example, the file test.rb looks like this:
584
 
 
585
 
        def dotest
586
 
                $ctrl.get_view.set_status("hello world!")
587
 
        end
588
 
 
589
 
To make a Ruby function callable, you need to define a macro:
590
 
 
591
 
        macro x run "dotest"
592
 
 
593
 
When the macro "x" is run by pressing "," and "x" (see above), the
594
 
(parameter-less) Ruby function "dotest" will be executed, which will display
595
 
"hello world!" in the status line at the bottom of the screen.
596
 
 
597
 
Currently, the available interfaces are (mostly) untested and completely
598
 
undocumented.
599
 
 
600
 
 
601
572
Format Strings
602
573
~~~~~~~~~~~~~~
603
574
 
653
624
T:If the article list displays articles from different feeds, then this identifier contains the title of the feed to which the article belongs.
654
625
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
655
626
 
 
627
.Available Identifiers for notify-format
 
628
[frame="all", grid="all", format="dsv"]
 
629
`30`60~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
630
Identifier:Meaning
 
631
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
632
n:Number of unread articles
 
633
f:Number of unread feeds
 
634
d:Number of new unread articles (i.e. that were added through the last reload)
 
635
D:Number of new unread feeds (i.e. that were added through the last reload)
 
636
 
656
637
Examples:
657
638
 
658
639
        feedlist-format     "%4i %n %11u %t"
659
640
        articlelist-format  "%4i %f %D   %?T?|%-17T|  ?%t"
 
641
        notify-format       "%d new articles (%n unread articles, %f unread feeds)"
660
642
 
661
643
Podcast Support
662
644
~~~~~~~~~~~~~~~