From 85717732a0074eb5eed6acbcb1d877ee60d405b5 Mon Sep 17 00:00:00 2001 From: lnu Date: Mon, 25 Jul 2005 10:57:33 +0000 Subject: git-svn-id: svn+ssh://svn.gna.org/svn/feed2imap/trunk/feed2imap@44 f70e237a-67f3-0310-a06c-d2b8a7116972 --- data/man/man1/feed2imap-cleaner.1 | 43 ++++++++++++++ data/man/man1/feed2imap-dumpconfig.1 | 28 +++++++++ data/man/man1/feed2imap-opmlimport.1 | 27 +++++++++ data/man/man1/feed2imap.1 | 79 +++++++++++++------------- data/man/man5/feed2imaprc.5 | 26 +++++++++ manpages/Makefile | 23 ++++++++ manpages/feed2imap-cleaner.xml | 97 ++++++++++++++++++++++++++++++++ manpages/feed2imap-dumpconfig.xml | 77 +++++++++++++++++++++++++ manpages/feed2imap-opmlimport.xml | 73 ++++++++++++++++++++++++ manpages/feed2imap.xml | 106 +++++++++++++++++++++++++++++++++++ manpages/feed2imaprc.xml | 69 +++++++++++++++++++++++ 11 files changed, 607 insertions(+), 41 deletions(-) create mode 100644 data/man/man1/feed2imap-cleaner.1 create mode 100644 data/man/man1/feed2imap-dumpconfig.1 create mode 100644 data/man/man1/feed2imap-opmlimport.1 create mode 100644 data/man/man5/feed2imaprc.5 create mode 100644 manpages/Makefile create mode 100644 manpages/feed2imap-cleaner.xml create mode 100644 manpages/feed2imap-dumpconfig.xml create mode 100644 manpages/feed2imap-opmlimport.xml create mode 100644 manpages/feed2imap.xml create mode 100644 manpages/feed2imaprc.xml diff --git a/data/man/man1/feed2imap-cleaner.1 b/data/man/man1/feed2imap-cleaner.1 new file mode 100644 index 0000000..4f11135 --- /dev/null +++ b/data/man/man1/feed2imap-cleaner.1 @@ -0,0 +1,43 @@ +.TH feed2imap\-cleaner 1 "Jul 25, 2005" +.SH NAME +feed2imap\-cleaner \- Removes old items from IMAP folders +.SH SYNOPSIS +\fBfeed2imap\-cleaner\fR [OPTIONS] +.SH DESCRIPTION +feed2imap\-cleaner deletes old items from IMAP folders specified in the configuration file. The actual query string used to determine whether an item is old is : +"SEEN NOT FLAGGED BEFORE (3 days ago)". Which means that an item WON'T be deleted if it satisfies one of the following conditions : +.TP 0.2i +\(bu +It isn't 3 days old ; +.TP 0.2i +\(bu +It hasn't been read yet ; +.TP 0.2i +\(bu +It is flagged (marked as Important, for example). +.TP +\fB\-d\fR, \fB\-\-dry\-run\fR +Don't remove anything, but show what would be removed if run without this option. +.TP +\fB\-f\fR, \fB\-\-config \fIfile\fB\fR +Use another config file (~/.feed2imaprc is the default). +.SH BUGS +Deletion criterias should probably be more configurable. +.SH "SEE ALSO" +Homepage : +http://home.gna.org/feed2imap/ +.PP +\fBfeed2imaprc\fR(5), +\fBfeed2imap\fR(1) +.SH AUTHOR +Copyright (C) 2005 Lucas Nussbaum lucas@lucas\-nussbaum.net +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by the +Free Software Foundation; either version 2 of the License, or (at your +option) any later version. +.PP +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. diff --git a/data/man/man1/feed2imap-dumpconfig.1 b/data/man/man1/feed2imap-dumpconfig.1 new file mode 100644 index 0000000..65bf426 --- /dev/null +++ b/data/man/man1/feed2imap-dumpconfig.1 @@ -0,0 +1,28 @@ +.TH feed2imap\-dumpconfig 1 "Jul 25, 2005" +.SH NAME +feed2imap\-dumpconfig \- Dump feed2imap config +.SH SYNOPSIS +\fBfeed2imap\-dumpconfig\fR [OPTIONS] +.SH DESCRIPTION +feed2imap\-dumpconfig dumps the content of your feed2imaprc to screen. +.TP +\fB\-f\fR, \fB\-\-config \fIfile\fB\fR +Use another config file (~/.feed2imaprc is the default). +.SH "SEE ALSO" +Homepage : +http://home.gna.org/feed2imap/ +.PP +\fBfeed2imaprc\fR(5), +\fBfeed2imap\fR(1) +.SH AUTHOR +Copyright (C) 2005 Lucas Nussbaum lucas@lucas\-nussbaum.net +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by the +Free Software Foundation; either version 2 of the License, or (at your +option) any later version. +.PP +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. diff --git a/data/man/man1/feed2imap-opmlimport.1 b/data/man/man1/feed2imap-opmlimport.1 new file mode 100644 index 0000000..2702e72 --- /dev/null +++ b/data/man/man1/feed2imap-opmlimport.1 @@ -0,0 +1,27 @@ +.TH feed2imap\-opmlimport 1 "Jul 25, 2005" +.SH NAME +feed2imap\-opmlimport \- Convert an OPML subscription list to a feed2imap config file +.SH SYNOPSIS +\fBfeed2imap\-opmlimport\fR +.SH DESCRIPTION +feed2imap\-opmlimport reads an OPML subscription list on standard input and outputs a feed2imap configuration file on standard output. The resulting configuration file will require some tweaking. +.SH BUGS +Should probably accept parameters to be able to change default values. +.SH "SEE ALSO" +Homepage : +http://home.gna.org/feed2imap/ +.PP +\fBfeed2imaprc\fR(5), +\fBfeed2imap\fR(1) +.SH AUTHOR +Copyright (C) 2005 Lucas Nussbaum lucas@lucas\-nussbaum.net +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by the +Free Software Foundation; either version 2 of the License, or (at your +option) any later version. +.PP +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. diff --git a/data/man/man1/feed2imap.1 b/data/man/man1/feed2imap.1 index 3b92b30..18eebae 100644 --- a/data/man/man1/feed2imap.1 +++ b/data/man/man1/feed2imap.1 @@ -1,45 +1,42 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.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 Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "ALEXANDRIA" 1 "Apr 14, 2004" "" "" +.TH feed2imap 1 "Jul 25, 2005" .SH NAME -alexandria \- manage your book collection -.SH "SYNOPSIS" -.ad l -.hy 0 -.HP 11 -\fBalexandria\fR -.ad -.hy - -.SH "DESCRIPTION" - -.PP -This manual page documents briefly the \fBalexandria\fR command\&. This manual page was written for the Debian GNU/Linux distribution because the original program does not have a manual page\&. - -.PP -Alexandria is a GNOME application to help you manage your book collection\&. It currently does not accept any arguments\&. - +feed2imap \- clever RSS/ATOM feed aggregator +.SH SYNOPSIS +\fBfeed2imap\fR [OPTIONS] +.SH DESCRIPTION +feed2imap is an RSS/Atom feed aggregator. After +Downloading feeds (over HTTP or HTTPS), it uploads them to a specified +folder of an IMAP mail server. The user can then access the feeds using +Mutt, Evolution, Mozilla Thunderbird or even a webmail. +.TP +\fB\-V\fR, \fB\-\-version\fR +Show version information. +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Run in verbose mode. +.TP +\fB\-c\fR, \fB\-\-rebuild\-cache\fR +Rebuilds the cache. Fetches all items and mark them as already seen. Useful if you lose your .feed2imap.cache file. +.TP +\fB\-f\fR, \fB\-\-config \fIfile\fB\fR +Use another config file (~/.feed2imaprc is the default). .SH "SEE ALSO" - +Homepage : +http://home.gna.org/feed2imap/ .PP -\fIhttp://alexandria.rubyforge.org/\fR - +\fBfeed2imaprc\fR(5), +\fBfeed2imap\-cleaner\fR(1), +\fBfeed2imap\-dumpconfig\fR(1), +\fBfeed2imap\-opmlimport\fR(1) .SH AUTHOR -Dafydd Harries. +Copyright (C) 2005 Lucas Nussbaum lucas@lucas\-nussbaum.net +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by the +Free Software Foundation; either version 2 of the License, or (at your +option) any later version. +.PP +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. diff --git a/data/man/man5/feed2imaprc.5 b/data/man/man5/feed2imaprc.5 new file mode 100644 index 0000000..abfc658 --- /dev/null +++ b/data/man/man5/feed2imaprc.5 @@ -0,0 +1,26 @@ +.TH feed2imaprc 5 "Jul 25, 2005" +.SH NAME +feed2imaprc \- feed2imap configuration file +.SH SYNOPSIS +\fBfeed2imaprc\fR is feed2imap's configuration file. It is usually located in \fB~/.feed2imaprc\fR. +.SH EXAMPLE +See \fB/usr/share/doc/feed2imap/examples/feed2imaprc\fR. +.SH BUGS +This manpage should probably give more details. +.SH "SEE ALSO" +Homepage : +http://home.gna.org/feed2imap/ +.PP +\fBfeed2imap\fR(1) +.SH AUTHOR +Copyright (C) 2005 Lucas Nussbaum lucas@lucas\-nussbaum.net +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by the +Free Software Foundation; either version 2 of the License, or (at your +option) any later version. +.PP +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. diff --git a/manpages/Makefile b/manpages/Makefile new file mode 100644 index 0000000..bb2ebd7 --- /dev/null +++ b/manpages/Makefile @@ -0,0 +1,23 @@ +MANDIR := ../data/man + +all: $(MANDIR)/man1/feed2imap.1 $(MANDIR)/man1/feed2imap-cleaner.1 $(MANDIR)/man1/feed2imap-dumpconfig.1 $(MANDIR)/man1/feed2imap-opmlimport.1 $(MANDIR)/man5/feed2imaprc.5 + +$(MANDIR)/man1/feed2imap.1: feed2imap.xml + docbook2x-man $< + cp $$(basename $@) $@ + +$(MANDIR)/man1/feed2imap-cleaner.1: feed2imap-cleaner.xml + docbook2x-man $< + cp $$(basename $@) $@ + +$(MANDIR)/man1/feed2imap-dumpconfig.1: feed2imap-dumpconfig.xml + docbook2x-man $< + cp $$(basename $@) $@ + +$(MANDIR)/man1/feed2imap-opmlimport.1: feed2imap-opmlimport.xml + docbook2x-man $< + cp $$(basename $@) $@ + +$(MANDIR)/man5/feed2imaprc.5: feed2imaprc.xml + docbook2x-man $< + cp $$(basename $@) $@ diff --git a/manpages/feed2imap-cleaner.xml b/manpages/feed2imap-cleaner.xml new file mode 100644 index 0000000..333bd92 --- /dev/null +++ b/manpages/feed2imap-cleaner.xml @@ -0,0 +1,97 @@ + + &program;"> + + + + ]> + + + + &firstname; + &surname; + +
&address;
+ + 2005 + &firstname; &surname; + + Jul 25, 2005 + + + &program; + 1 + + + &program; + Removes old items from IMAP folders + + + + feed2imap-cleaner [OPTIONS] + + + + DESCRIPTION + + feed2imap-cleaner deletes old items from IMAP folders specified in the configuration file. The actual query string used to determine whether an item is old is : + "SEEN NOT FLAGGED BEFORE (3 days ago)". Which means that an item WON'T be deleted if it satisfies one of the following conditions : + + + It isn't 3 days old ; + It hasn't been read yet ; + It is flagged (marked as Important, for example). + + + + + + + + + Don't remove anything, but show what would be removed if run without this option. + + + + + + + + Use another config file (~/.feed2imaprc is the default). + + + + + BUGS + Deletion criterias should probably be more configurable. + + + + SEE ALSO + + Homepage : + http://home.gna.org/feed2imap/ + + + feed2imaprc5, + feed2imap1 + + + + AUTHOR + Copyright (C) 2005 Lucas Nussbaum lucas@lucas-nussbaum.net + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 2 of the License, or (at your + option) any later version. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + + diff --git a/manpages/feed2imap-dumpconfig.xml b/manpages/feed2imap-dumpconfig.xml new file mode 100644 index 0000000..bc1e4dc --- /dev/null +++ b/manpages/feed2imap-dumpconfig.xml @@ -0,0 +1,77 @@ + + &program;"> + + + + ]> + + + + &firstname; + &surname; + +
&address;
+ + 2005 + &firstname; &surname; + + Jul 25, 2005 + + + &program; + 1 + + + &program; + Dump feed2imap config + + + + feed2imap-dumpconfig [OPTIONS] + + + + DESCRIPTION + + feed2imap-dumpconfig dumps the content of your feed2imaprc to screen. + + + + + + + + Use another config file (~/.feed2imaprc is the default). + + + + + SEE ALSO + + Homepage : + http://home.gna.org/feed2imap/ + + + feed2imaprc5, + feed2imap1 + + + + AUTHOR + Copyright (C) 2005 Lucas Nussbaum lucas@lucas-nussbaum.net + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 2 of the License, or (at your + option) any later version. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + + diff --git a/manpages/feed2imap-opmlimport.xml b/manpages/feed2imap-opmlimport.xml new file mode 100644 index 0000000..d8055d9 --- /dev/null +++ b/manpages/feed2imap-opmlimport.xml @@ -0,0 +1,73 @@ + + &program;"> + + + + ]> + + + + &firstname; + &surname; + +
&address;
+ + 2005 + &firstname; &surname; + + Jul 25, 2005 + + + &program; + 1 + + + &program; + Convert an OPML subscription list to a feed2imap config file + + + + feed2imap-opmlimport + + + + DESCRIPTION + + feed2imap-opmlimport reads an OPML subscription list on standard input and outputs a feed2imap configuration file on standard output. The resulting configuration file will require some tweaking. + + + + BUGS + Should probably accept parameters to be able to change default values. + + + + SEE ALSO + + Homepage : + http://home.gna.org/feed2imap/ + + + feed2imaprc5, + feed2imap1 + + + + AUTHOR + Copyright (C) 2005 Lucas Nussbaum lucas@lucas-nussbaum.net + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 2 of the License, or (at your + option) any later version. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + + diff --git a/manpages/feed2imap.xml b/manpages/feed2imap.xml new file mode 100644 index 0000000..75d278f --- /dev/null +++ b/manpages/feed2imap.xml @@ -0,0 +1,106 @@ + + &program;"> + + + + ]> + + + + &firstname; + &surname; + +
&address;
+ + 2005 + &firstname; &surname; + + Jul 25, 2005 + + + &program; + 1 + + + &program; + clever RSS/ATOM feed aggregator + + + + feed2imap [OPTIONS] + + + + DESCRIPTION + + feed2imap is an RSS/Atom feed aggregator. After + Downloading feeds (over HTTP or HTTPS), it uploads them to a specified + folder of an IMAP mail server. The user can then access the feeds using + Mutt, Evolution, Mozilla Thunderbird or even a webmail. + + + + + + + + Show version information. + + + + + + + + Run in verbose mode. + + + + + + + + Rebuilds the cache. Fetches all items and mark them as already seen. Useful if you lose your .feed2imap.cache file. + + + + + + + + Use another config file (~/.feed2imaprc is the default). + + + + + SEE ALSO + + Homepage : + http://home.gna.org/feed2imap/ + + + feed2imaprc5, + feed2imap-cleaner1, + feed2imap-dumpconfig1, + feed2imap-opmlimport1 + + + + AUTHOR + Copyright (C) 2005 Lucas Nussbaum lucas@lucas-nussbaum.net + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 2 of the License, or (at your + option) any later version. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + + diff --git a/manpages/feed2imaprc.xml b/manpages/feed2imaprc.xml new file mode 100644 index 0000000..b2289b3 --- /dev/null +++ b/manpages/feed2imaprc.xml @@ -0,0 +1,69 @@ + + &program;"> + + + + ]> + + + + &firstname; + &surname; + +
&address;
+ + 2005 + &firstname; &surname; + + Jul 25, 2005 + + + &program; + 5 + + + &program; + feed2imap configuration file + + + SYNOPSIS + + feed2imaprc is feed2imap's configuration file. It is usually located in ~/.feed2imaprc. + + + EXAMPLE + See /usr/share/doc/feed2imap/examples/feed2imaprc. + + + BUGS + This manpage should probably give more details. + + + SEE ALSO + + Homepage : + http://home.gna.org/feed2imap/ + + + feed2imap1 + + + + AUTHOR + Copyright (C) 2005 Lucas Nussbaum lucas@lucas-nussbaum.net + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 2 of the License, or (at your + option) any later version. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + + -- cgit v1.2.3-70-g09d2