summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
Diffstat (limited to 'manpages')
-rw-r--r--manpages/Makefile23
-rw-r--r--manpages/feed2imap-cleaner.xml97
-rw-r--r--manpages/feed2imap-dumpconfig.xml77
-rw-r--r--manpages/feed2imap-opmlimport.xml73
-rw-r--r--manpages/feed2imap.xml106
-rw-r--r--manpages/feed2imaprc.xml74
6 files changed, 0 insertions, 450 deletions
diff --git a/manpages/Makefile b/manpages/Makefile
deleted file mode 100644
index bb2ebd7..0000000
--- a/manpages/Makefile
+++ /dev/null
@@ -1,23 +0,0 @@
-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
deleted file mode 100644
index 333bd92..0000000
--- a/manpages/feed2imap-cleaner.xml
+++ /dev/null
@@ -1,97 +0,0 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
- [
- <!ENTITY program "feed2imap-cleaner">
- <!ENTITY command "<command>&program;</command>">
- <!ENTITY firstname "Lucas">
- <!ENTITY surname "Nussbaum">
- <!ENTITY address "lucas@lucas-nussbaum.net">
- ]>
-<refentry>
-<refentryinfo>
- <author>
- <firstname>&firstname;</firstname>
- <surname>&surname;</surname>
- </author>
- <address>&address;</address>
- <copyright>
- <year>2005</year>
- <holder>&firstname; &surname;</holder>
- </copyright>
- <date>Jul 25, 2005</date>
-</refentryinfo>
-<refmeta>
- <refentrytitle>&program;</refentrytitle>
- <manvolnum>1</manvolnum>
-</refmeta>
-<refnamediv>
- <refname>&program;</refname>
- <refpurpose>Removes old items from IMAP folders</refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <cmdsynopsis>
- <command>feed2imap-cleaner</command> [OPTIONS]
- </cmdsynopsis>
-</refsynopsisdiv>
-<refsect1>
- <title>DESCRIPTION</title>
-
- <para><command>feed2imap-cleaner</command> 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 :</para>
-
- <itemizedlist>
- <listitem><para>It isn't 3 days old ;</para></listitem>
- <listitem><para>It hasn't been read yet ;</para></listitem>
- <listitem><para>It is flagged (marked as Important, for example).</para></listitem>
- </itemizedlist>
-
-<variablelist>
- <varlistentry>
- <term>
- <option>-d</option></term><term><option>--dry-run</option>
- </term>
- <listitem>
- <para>Don't remove anything, but show what would be removed if run without this option.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>-f</option></term><term><option>--config <replaceable>file</replaceable></option>
- </term>
- <listitem>
- <para>Use another config file (~/.feed2imaprc is the default).</para>
- </listitem>
- </varlistentry></variablelist>
-</refsect1>
-<refsect1>
- <title>BUGS</title>
- <para>Deletion criterias should probably be more configurable.</para>
-
-</refsect1>
-<refsect1>
- <title>SEE ALSO</title>
-
- <para>Homepage :
- <ulink url="http://home.gna.org/feed2imap/">http://home.gna.org/feed2imap/</ulink></para>
-
- <para>
- <citerefentry><refentrytitle>feed2imaprc</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>feed2imap</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- </para>
-</refsect1>
-<refsect1>
- <title>AUTHOR</title>
- <para>Copyright (C) 2005 Lucas Nussbaum <email>lucas@lucas-nussbaum.net</email></para>
-
- <para>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.</para>
-
- <para>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.</para>
-
-</refsect1>
-</refentry>
diff --git a/manpages/feed2imap-dumpconfig.xml b/manpages/feed2imap-dumpconfig.xml
deleted file mode 100644
index bc1e4dc..0000000
--- a/manpages/feed2imap-dumpconfig.xml
+++ /dev/null
@@ -1,77 +0,0 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
- [
- <!ENTITY program "feed2imap-dumpconfig">
- <!ENTITY command "<command>&program;</command>">
- <!ENTITY firstname "Lucas">
- <!ENTITY surname "Nussbaum">
- <!ENTITY address "lucas@lucas-nussbaum.net">
- ]>
-<refentry>
-<refentryinfo>
- <author>
- <firstname>&firstname;</firstname>
- <surname>&surname;</surname>
- </author>
- <address>&address;</address>
- <copyright>
- <year>2005</year>
- <holder>&firstname; &surname;</holder>
- </copyright>
- <date>Jul 25, 2005</date>
-</refentryinfo>
-<refmeta>
- <refentrytitle>&program;</refentrytitle>
- <manvolnum>1</manvolnum>
-</refmeta>
-<refnamediv>
- <refname>&program;</refname>
- <refpurpose>Dump feed2imap config</refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <cmdsynopsis>
- <command>feed2imap-dumpconfig</command> [OPTIONS]
- </cmdsynopsis>
-</refsynopsisdiv>
-<refsect1>
- <title>DESCRIPTION</title>
-
- <para><command>feed2imap-dumpconfig</command> dumps the content of your feed2imaprc to screen.</para>
-
-<variablelist>
- <varlistentry>
- <term>
- <option>-f</option></term><term><option>--config <replaceable>file</replaceable></option>
- </term>
- <listitem>
- <para>Use another config file (~/.feed2imaprc is the default).</para>
- </listitem>
- </varlistentry></variablelist>
-</refsect1>
-<refsect1>
- <title>SEE ALSO</title>
-
- <para>Homepage :
- <ulink url="http://home.gna.org/feed2imap/">http://home.gna.org/feed2imap/</ulink></para>
-
- <para>
- <citerefentry><refentrytitle>feed2imaprc</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>feed2imap</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- </para>
-</refsect1>
-<refsect1>
- <title>AUTHOR</title>
- <para>Copyright (C) 2005 Lucas Nussbaum <email>lucas@lucas-nussbaum.net</email></para>
-
- <para>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.</para>
-
- <para>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.</para>
-
-</refsect1>
-</refentry>
diff --git a/manpages/feed2imap-opmlimport.xml b/manpages/feed2imap-opmlimport.xml
deleted file mode 100644
index d8055d9..0000000
--- a/manpages/feed2imap-opmlimport.xml
+++ /dev/null
@@ -1,73 +0,0 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
- [
- <!ENTITY program "feed2imap-opmlimport">
- <!ENTITY command "<command>&program;</command>">
- <!ENTITY firstname "Lucas">
- <!ENTITY surname "Nussbaum">
- <!ENTITY address "lucas@lucas-nussbaum.net">
- ]>
-<refentry>
-<refentryinfo>
- <author>
- <firstname>&firstname;</firstname>
- <surname>&surname;</surname>
- </author>
- <address>&address;</address>
- <copyright>
- <year>2005</year>
- <holder>&firstname; &surname;</holder>
- </copyright>
- <date>Jul 25, 2005</date>
-</refentryinfo>
-<refmeta>
- <refentrytitle>&program;</refentrytitle>
- <manvolnum>1</manvolnum>
-</refmeta>
-<refnamediv>
- <refname>&program;</refname>
- <refpurpose>Convert an OPML subscription list to a feed2imap config file</refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <cmdsynopsis>
- <command>feed2imap-opmlimport</command>
- </cmdsynopsis>
-</refsynopsisdiv>
-<refsect1>
- <title>DESCRIPTION</title>
-
- <para><command>feed2imap-opmlimport</command> 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.</para>
-
-</refsect1>
-<refsect1>
- <title>BUGS</title>
- <para>Should probably accept parameters to be able to change default values.</para>
-
-</refsect1>
-<refsect1>
- <title>SEE ALSO</title>
-
- <para>Homepage :
- <ulink url="http://home.gna.org/feed2imap/">http://home.gna.org/feed2imap/</ulink></para>
-
- <para>
- <citerefentry><refentrytitle>feed2imaprc</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>feed2imap</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- </para>
-</refsect1>
-<refsect1>
- <title>AUTHOR</title>
- <para>Copyright (C) 2005 Lucas Nussbaum <email>lucas@lucas-nussbaum.net</email></para>
-
- <para>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.</para>
-
- <para>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.</para>
-
-</refsect1>
-</refentry>
diff --git a/manpages/feed2imap.xml b/manpages/feed2imap.xml
deleted file mode 100644
index c56bdaa..0000000
--- a/manpages/feed2imap.xml
+++ /dev/null
@@ -1,106 +0,0 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
- [
- <!ENTITY program "feed2imap">
- <!ENTITY command "<command>&program;</command>">
- <!ENTITY firstname "Lucas">
- <!ENTITY surname "Nussbaum">
- <!ENTITY address "lucas@lucas-nussbaum.net">
- ]>
-<refentry>
-<refentryinfo>
- <author>
- <firstname>&firstname;</firstname>
- <surname>&surname;</surname>
- </author>
- <address>&address;</address>
- <copyright>
- <year>2005</year>
- <holder>&firstname; &surname;</holder>
- </copyright>
- <date>Jul 25, 2005</date>
-</refentryinfo>
-<refmeta>
- <refentrytitle>&program;</refentrytitle>
- <manvolnum>1</manvolnum>
-</refmeta>
-<refnamediv>
- <refname>&program;</refname>
- <refpurpose>clever RSS/ATOM feed aggregator</refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <cmdsynopsis>
- <command>feed2imap</command> [OPTIONS]
- </cmdsynopsis>
-</refsynopsisdiv>
-<refsect1>
- <title>DESCRIPTION</title>
-
- <para><command>feed2imap</command> 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, or copies them to a local maildir. The user can then access the feeds using
- Mutt, Evolution, Mozilla Thunderbird or even a webmail.</para>
-
-<variablelist>
- <varlistentry>
- <term>
- <option>-V</option></term><term><option>--version</option>
- </term>
- <listitem>
- <para>Show version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>-v</option></term><term><option>--verbose</option>
- </term>
- <listitem>
- <para>Run in verbose mode.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>-c</option></term><term><option>--rebuild-cache</option>
- </term>
- <listitem>
- <para>Rebuilds the cache. Fetches all items and mark them as already seen. Useful if you lose your .feed2imap.cache file.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>-f</option></term><term><option>--config <replaceable>file</replaceable></option>
- </term>
- <listitem>
- <para>Use another config file (~/.feed2imaprc is the default).</para>
- </listitem>
- </varlistentry></variablelist>
-</refsect1>
-<refsect1>
- <title>SEE ALSO</title>
-
- <para>Homepage :
- <ulink url="http://home.gna.org/feed2imap/">http://home.gna.org/feed2imap/</ulink></para>
-
- <para>
- <citerefentry><refentrytitle>feed2imaprc</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>feed2imap-cleaner</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>feed2imap-dumpconfig</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>feed2imap-opmlimport</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- </para>
-</refsect1>
-<refsect1>
- <title>AUTHOR</title>
- <para>Copyright (C) 2005 Lucas Nussbaum <email>lucas@lucas-nussbaum.net</email></para>
-
- <para>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.</para>
-
- <para>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.</para>
-
-</refsect1>
-</refentry>
diff --git a/manpages/feed2imaprc.xml b/manpages/feed2imaprc.xml
deleted file mode 100644
index 7643d3d..0000000
--- a/manpages/feed2imaprc.xml
+++ /dev/null
@@ -1,74 +0,0 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
- [
- <!ENTITY program "feed2imaprc">
- <!ENTITY command "<command>&program;</command>">
- <!ENTITY firstname "Lucas">
- <!ENTITY surname "Nussbaum">
- <!ENTITY address "lucas@lucas-nussbaum.net">
- ]>
-<refentry>
-<refentryinfo>
- <author>
- <firstname>&firstname;</firstname>
- <surname>&surname;</surname>
- </author>
- <address>&address;</address>
- <copyright>
- <year>2005</year>
- <holder>&firstname; &surname;</holder>
- </copyright>
- <date>Jul 25, 2005</date>
-</refentryinfo>
-<refmeta>
- <refentrytitle>&program;</refentrytitle>
- <manvolnum>5</manvolnum>
-</refmeta>
-<refnamediv>
- <refname>&program;</refname>
- <refpurpose>feed2imap configuration file</refpurpose>
-</refnamediv>
-<refsect1>
- <title>SYNOPSIS</title>
-
- <para><filename>feed2imaprc</filename> is feed2imap's configuration file. It is usually located in <filename>~/.feed2imaprc</filename>.</para>
-</refsect1>
-<refsect1>
- <title>EXAMPLE</title>
- <para>See <filename>/usr/share/doc/feed2imap/examples/feed2imaprc</filename>.</para>
-</refsect1>
-<refsect1>
- <title>RESERVED CHARACTERS</title>
- <para>Some characters are reserved in RFC2396 (URI). If you need to include a reserved character in the login/password part of your target URI, replace it with its hex code. For example, @ can be replaced by %40.</para>
-</refsect1>
-<refsect1>
- <title>BUGS</title>
- <para>This manpage should probably give more details. However, the example configuration file is
-very well documented.</para>
-</refsect1>
-<refsect1>
- <title>SEE ALSO</title>
-
- <para>Homepage :
- <ulink url="http://home.gna.org/feed2imap/">http://home.gna.org/feed2imap/</ulink></para>
-
- <para>
- <citerefentry><refentrytitle>feed2imap</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- </para>
-</refsect1>
-<refsect1>
- <title>AUTHOR</title>
- <para>Copyright (C) 2005 Lucas Nussbaum <email>lucas@lucas-nussbaum.net</email></para>
-
- <para>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.</para>
-
- <para>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.</para>
-
-</refsect1>
-</refentry>