# Sample curn configuration file # # $Id: sample.cfg 7002 2007-08-15 03:32:08Z bmc $ # --------------------------------------------------------------------------- ############################################################################# # curn section: Configuration items that apply globally. Note that the # various sites are specified in their own sections, to # permit site-specific configuration. ############################################################################# [curn] # --------------------------------------------------------------------------- # DataPersisterClass: The fully-qualified class name of the class that saves # and restores curn data. This class must extend the # org.clapper.curn.DataPersister class and is responsible # for handling its own configuration items. # # If this parameter is not specified, curn will use its # org.clapper.curn.XMLDataPersister class, which saves # data to and restores data from the XML file specified # by the CacheFile parameter. # # OPTIONAL. Default: org.clapper.curn.XMLDataPersister DataPersisterClass: org.clapper.curn.XMLDataPersister # --------------------------------------------------------------------------- # CacheFile: The full path to the file in which curn should cache URLs. # curn uses the cache file to keep track of which URLs it # has already received and displayed, and when it received them. # Under normal operation, curn won't display a URL it has # already displayed and cached. # # This path may contain the ~ metacharacter, to denote the # invoking user's home directory. # # The use of a cache can be disabled by omitting this parameter. # Use the "NoCacheUpdate" parameter to tell curn to read, # but not update, the cache. # # This parameter is only honoroed by the # org.clapper.curn.XMLDataPersister class. # # See also: Configuration parameter "NoCacheUpdate" # Configuration parameter "TotalCacheBackups" # Command line parameter -C, --no-cache # # OPTIONAL. Default: None CacheFile: ${system:user.home}/curn/curn.cache # --------------------------------------------------------------------------- # CacheBackup: Specifies a full path to a cache backup file. If this # parameter is set, curn will copy the cache to this backup file # before overwriting the cache. # # This parameter is only honoroed by the # org.clapper.curn.XMLDataPersister class. # # DEPRECATED. As of curn 2.6, this parameter is no longer used. Use the # "TotalCacheBackups" parameter, instead. # #CacheBackup: # --------------------------------------------------------------------------- # TotalCacheBackups: Total number of cache backups to keep. If this parameter # is greater than 0, then curn will keep this many numbered # copies of the backup file. A value of 0 (or less than 0) # means don't back up the cache. # # This parameter is only honoroed by the # org.clapper.curn.XMLDataPersister class. # # See also: Configuration parameter "CacheFile" # # OPTIONAL. Default: 0 #TotalCacheBackups: 0 # --------------------------------------------------------------------------- # NoCacheUpdate: If set to "true" (and if a cache file is specified), # this parameter tells curn to read the cache file and # honor its contents, but not to update it on disk. # # See also: Configuration parameter "CacheFile" # Command line parameter -u, --noupdate # # OPTIONAL. Default: false #NoCacheUpdate: false # --------------------------------------------------------------------------- # DaysToCache: Default maximum number of days to cache an already-read URL. # This parameter is used when the configuration section for a # particular site lacks its own "DaysToCache" value. URLs # older than this many days are tossed from the cache when # it's read, which means curn forgets that it saw them before. # A value of 0 renders the cache useless (i.e., ensures that # curn always forgets URLs that are cached). The special value # "NoLimit" keeps items in the cache forever. # # OPTIONAL. Default: 365 #DaysToCache: 365 # --------------------------------------------------------------------------- # GzipDownload: Directs curn to use the "Accept-Encoding: gzip" HTTP # header when retrieving an RSS feed from an HTTP server. # Since RSS feeds are XML, they typically compress well; # retrieving gzipped data, rather than the uncompressed HTML, # can save a significant amount of time and network # bandwidth--provided, of course, the remote HTTP server # honors the "Accept-Encoding" header, which it is not # required to do. This global value is used when the # configuration section for a particular feed does not supply # its own "GzipDownload" value. # # OPTIONAL. Default: true #GzipDownload: true # --------------------------------------------------------------------------- # AllowEmbeddedHTML: Default setting for whether or not to allow embedded # HTML in certain RSS feed elements, such as # description, author, etc. Some RSS formats permit # embedded HTML. Setting this parameter to "true" # preserves any embedded HTML markup within a feed; # setting this parameter to "false" causes embedded HTML # to be stripped. # # Note that certain output handlers will strip HTML # regardless of this setting. An output handler that # produces text, for instance, is not required to # support embedded HTML. # # This parameter can be overridden on a per-feed basis. # # OPTIONAL. Default: false #AllowEmbeddedHTML: false # --------------------------------------------------------------------------- # UserAgent: The default HTTP User-Agent header to use. This configuration # parameter permits you to have curn masquerade as a browser to the # remote system. This global value is used when the configuration # section for a particular feed does not supply its own "UserAgent" # value. # # OPTIONAL. Default: "curn/x.y.z (+http://www.clapper.org/software/java/curn/)" # (where "x.y.z" is the current curn version number) #UserAgent: Mozilla/5.0 (X11; U; FreeBSD i686; en-US; rv:1.7.3) Gecko/20040922 # --------------------------------------------------------------------------- # SortBy: Default method to use to sort items within each feed. This # is used when the configuration section for a particular feed # lacks its own "SortBy" value. # # Valid values: # # time - Sort by timestamp, if present. Current time is assumed # for any item without a timestamp. # title - Sort by item title, if present. Any item without a title # is sorted as if its title were the empty string. # none - Don't sort. (i.e., Leave items in the order they appear # in the XML.) # # OPTIONAL. Default: none #SortBy: none # --------------------------------------------------------------------------- # MaxThreads: Maximum number of concurrent threads to spawn to retrieve # the RSS feeds. A value of 1 (the smallest legal value) causes # curn to retrieve the feeds serially. Values greater than 1 # cause curn to spawn up to that many threads to retrieve the # feeds concurrently. # # See also: Command line option --threads # # OPTIONAL. Default: 5 #MaxThreads: 5 # --------------------------------------------------------------------------- # SummaryOnly: Some RSS feeds provide a description for each item, in addition # to the (brief) title. Setting "SummaryOnly" to "true" (or # "yes") suppresses display of the description. This parameter # can be overridden on a per-site basis. This global value sets # the default value. # # DEPRECATED. Use "ReplaceEmptyContentWith" instead. # # OPTIONAL. Default: false #SummaryOnly: false # --------------------------------------------------------------------------- # ReplaceEmptyContentWith: What to do when a summary is missing. # Legal values: # # nothing: leave summary empty # content: replace summary with content, if any # title: replace summary with title # # OPTIONAL. Default: nothing ReplaceEmptyContentWith: nothing # --------------------------------------------------------------------------- # MaxSummarySize: If you're displaying the summary (see the SummaryOnly # parameter), you can optionally set a maximum size for the # summary. curn will truncate any summary that is longer than # the maximum number of summary characters, adding a trailing # ellipsis to indicate the truncation. A value of 0 disables # truncation. # # This parameter may be overridden on a per-feed basis. This # global value sets the default value. # # OPTIONAL. Default: 0 (i.e., no limit) #MaxSummarySize: 0 # --------------------------------------------------------------------------- # ShowRSSVersion: Show the RSS version associated with each site's feed. # # See also: Command line options --rss-version, -r, --no-rss-version, -R # # OPTIONAL. Default: false #ShowRSSVersion: false # --------------------------------------------------------------------------- # ShowDates: Show the dates for each feed and item, if available. # # See also: Command line options --show-dates, -d, --no-dates, -D # # OPTIONAL. Default: false #ShowDates: false # --------------------------------------------------------------------------- # ShowAuthors: Show the authors for each item, if available. This global # value can be overridden on a per-feed basis. # # See also: Command line options --show-authors, -a, --no-authors, -A # # OPTIONAL. Default: false #ShowAuthors: false # --------------------------------------------------------------------------- # ParserClass: The full name of the underlying parser class to be used. # This class must implement the org.clapper.curn.RSSParser # interface. It can be a first-class parser of its own, or # it can be nothing more than an interface to a third party # RSS parser class. # # One parser is shipped with curn: # # org.clapper.curn.parser.rome.RSSParserAdapter # An adapter class that makes the Rome parser # work with curn. # # Any class that implements org.clapper.parser.RSSParser # may be used as a value for ParserClass. # # OPTIONAL. Default: org.clapper.curn.parser.rome.RSSParserAdapter #ParserClass: org.clapper.curn.parser.rome.RSSParserAdapter # --------------------------------------------------------------------------- # GzipDownload: Directs curn to use the "Accept-Encoding: gzip" HTTP # header when retrieving an RSS feed from an HTTP server. # Since RSS feeds are XML, they typically compress well; # retrieving gzipped data, rather than the uncompressed HTML, # can save a significant amount of time and network # bandwidth--provided, of course, the remote HTTP server # honors the "Accept-Encoding" header, which it is not # required to do. This global value is used when the # configuration section for a particular feed does not supply # its own "GzipDownload" value. # # OPTIONAL. Default: true #GzipDownload: true # --------------------------------------------------------------------------- # SMTPHost: The SMTP host to use to mail the output. This option is only # honored if email addresses are specified via the "MailOutputTo" # parameter. # # OPTIONAL. Default: localhost #SMTPHost: localhost # --------------------------------------------------------------------------- # MailFrom: The email address to use as the sender. The address can be a full # RFC 2822-compliant address (e.g., "Joe Blow "). # This option is only honored if email addresses are specified via # the "MailOutputTo" parameter. # # OPTIONAL. Default: An address is constructed from the name of the user # running curn and the name of the machine where curn is running. #MailFrom: Curn User # --------------------------------------------------------------------------- # MailOutputTo: List of email addresses to received curn output. # # OPTIONAL. Default: None #MailOutputTo: # --------------------------------------------------------------------------- # MailOutputTo: List of email addresses to received curn output. # # OPTIONAL. Default: None # --------------------------------------------------------------------------- # MailSubject: The email subject to use for emailed curn output. This option # is only honored if email addresses are specified via the # "MailOutputTo" parameter. # # OPTIONAL. Default: "RSS Feeds" #MailSubject: RSS Feeds # --------------------------------------------------------------------------- # IgnoreArticlesOlderThan: Provides a way to ignore articles that are # older than a certain interval. Intervals are # expressed in a natural language syntax. For # instance: # # IgnoreArticlesOlderThan: 3 days # IgnoreArticlesOlderThan: 1 week # IgnoreArticlesOlderThan: 365 days # IgnoreArticlesOlderThan: 12 hours, 30 minutes # # Valid interval names (in English) are: # # millisecond, milliseconds, ms # second, seconds, sec, secs # minute, minutes, min, mins # hour, hours, hr, hrs # day, days # week, weeks # # "year" and "month" are not supported, to avoid # the irregularity of leaps years and different # month lengths, respectively. # # This value specifies the default for feeds that # don't specify their own values. # # OPTIONAL. Default: none (i.e., articles aren't ignored by age) #IgnoreArticlesOlderThan ############################################################################# # Section for an output handler. The section name must start with the string # "OutputHandler" and must be unique. The portion of the string following # the "OutputHandler" prefix can be anything (subject to normal configuration # file syntax constraints). e.g., "outputHandler1", "outputHandler_foo", etc. # # All "OutputHandler" sections support two parameters: # # Class: Specifies the full class name of the output handler. # Any class that implements the org.clapper.curn.OutputHandler # interface is acceptable. # # This parameter is required. # # Disabled: If set to "true", then the output handler is skipped. If # set to "false" or not present, then the output handler is # enabled. This configuration parameter makes it easy to enable # or disable an output handler, without having to comment it # out. # # This parameter is optional. # # All other parameters are captured and passed to the output handler # object's initialization method, but curn itself does not interpret them # at all. Each output handler class may have its own special parameters (or # it may support no parameters at all). # # If multiple "OutputHandler" sections are present, curn will pass the # parsed RSS data to an instance of each class, in the order the classes # appear in the configuration file. If email addresses are specified on the # command line, curn will buffer the output produced by each output handler, # if any; curn will then send each separate output stream as # "multipart/alternative" attachments in the resulting email message. # Otherwise, curn will display the first output stream it gets back on # standard output. Regardless of whether email addresses are specified on # the command line or not, all output handlers will be invoked (unless, of # course, an error occurs.) # # It's not required that an output handler actually hand output back to # curn. For example, the TextOutputHandler and HTMLOutputHandler classes # can be configured to save their output, but not report it back to curn. # # If no "OutputHandler" sections are present in the configuration file, # curn skips the RSS XML parsing phase. (There's not reason to parse the # XML if there are no output handlers to process the parsed feed data.) # If there are no output handlers, curn may or may not download individual # feeds. If a given feed has no "SaveAs" setting, and there are no output # handlers, then curn skips the feed entirely. After all, there's no sense # wasting time downloading the feed, if the feed isn't being parsed or # saved. However, if the feed has a "SaveAs" setting, curn will download it # (if it has changed) and save it even if it's not parsing the XML. ############################################################################# [OutputHandlerFreeMarkerHTML] # org.clapper.curn.output.freemarker.FreeMarkerOutputHandler # # Writes parsed RSS data according to a FreeMarker template # # Additional parameters: # # SaveAs: Save a copy of the generated output to a specified file. # SaveOnly: If "true", save the generated output to the "SaveAs" file, but # don't provide any output to curn. If "false" or absent, provide # output to curn. # SavedBackups: Number of saved backups to keep. If this value is non-zero, # the handler will backup the "SaveAs" file before overwriting # it. Up to "SavedBackups" total backed-up files will be kept. # Defaults to 0, for no saved backups. # ShowCurnInfo: If "true", display the curn version and other configuration # information in the generated output. If "false", suppress # that information. # Encoding: Desired output encoding (character set). Defaults to the # default Java encoding for the platform. # Title: Title for the output document (if honored by the template). # TemplateFile: Location of the template file. See the Curn Users Guide for # a complete description of this parameter. # ExtraText: Extra text to be included in the output (if honored by the # template). # Disabled: "true" to disable (i.e., ignore) the output handler, "false" # to use it. Defaults to false. Setting "Disabled" to "true" # is a simple way to turn the output handler off without having # to comment it out. Class: org.clapper.curn.output.freemarker.FreeMarkerOutputHandler SaveAs: ${system:user.home}/curn/output.html #SavedBackups: 0 #SaveOnly: false #Disabled: true Title: News Feeds Encoding: ISO-8859-1 TemplateFile: builtin html #ExtraText: [OutputHandlerScript] # org.clapper.curn.output.script.ScriptOutputHandler # # Call an Apache Jakarta Bean Scripting Framework-based script to generate # the output. # # Additional parameters: # # Script: Path to the script # Language: The script language, as recognized by BSF # SaveAs: Save a copy of the text to a specified file. # SaveOnly: If "true", save the text to the "SaveAs" file, but don't # provide any output to curn. If "false" or absent, provide # output to curn. # SavedBackups: Number of saved backups to keep. If this value is non-zero, # the handler will backup the "SaveAs" file before overwriting # it. Up to "SavedBackups" total backed-up files will be kept. # Defaults to 0, for no saved backups. # ShowCurnInfo: If "true", display the curn version and other configuration # information in the generated output. If "false", suppress # that information. # Disabled: "true" to disable (i.e., ignore) the output handler, "false" # to use it. Defaults to false. Setting "Disabled" to "true" # is a simple way to turn the output handler off without having # to comment it out. # # The script may also have parameters of its own. Class: org.clapper.curn.output.script.ScriptOutputHandler Disabled: true Script: ${system:user.home}/curn/generate_output.py Language: jython #SaveAs: ${system:user.home}/curn/rss-py.txt #SaveOnly: false #SavedBackups: 0 ShowCurnInfo: true ############################################################################# # Section for an RSS site. The section name must start with the string # "Feed" and must be unique. The portion of the string following the "Feed" # prefix can be anything (subject to normal configuration file syntax # constraints). e.g.: "Feed01", "Feed5", "Feed_nyt_politics", etc. ############################################################################# [Feed1] # --------------------------------------------------------------------------- # URL: The fully-qualified URL for the feed # # REQUIRED. URL: http://www.example.org/rss/nytimes/politics.xml # --------------------------------------------------------------------------- # AllowEmbeddedHTML: Whether or not to allow embedded HTML in certain RSS # feed elements, such as description, author, etc. Some # RSS formats permit embedded HTML. Setting this # parameter to "true" preserves any embedded HTML markup # within a feed; setting this parameter to "false" # causes embedded HTML to be stripped. # # Note that certain output handlers will strip HTML # regardless of this setting. An output handler that # produces text, for instance, is not required to # support embedded HTML. # # This parameter overrides the global default, set in # the [curn] section. # # OPTIONAL. Default: the value of "AllowEmbeddedHTML" in the [curn] section. #AllowEmbeddedHTML: false # --------------------------------------------------------------------------- # DaysToCache: Maximum number of days to cache an already-read URL for this # site. URLs older than this are tossed from the cache when # it's read, which means curn forgets that it saw them # before. A value of 0 renders the cache useless (i.e., # ensures that curn always forgets URLs that are cached). The # special value "NoLimit" keeps items in the cache forever. # # OPTIONAL. Default: The value of the global "DaysToCache" parameter, or # 365 if that's not set #DaysToCache: 365 # --------------------------------------------------------------------------- # Disabled: If set to "true", then this feed is disabled. If set to "false" # or if not present, then this feed is enabled. This configuration # parameter makes it easy to enable or disable a feed, without # having to comment out all its settings. # # OPTIONAL. Default: false Disabled: false # --------------------------------------------------------------------------- # EditItemURL: Apply the specified regular expression edit to each of the # site's RSS item URLS. The value for this option consists of # a Perl 5-style substitution applied to the URL. For example: # # 1. Remove all the parameters from the URL: # # 's/?.*$//' # # 2. Remove a "redirect" CGI from a site whose URLs look # like: http://www.example.com/redir.cgi?http://... # # 's+http://www.example.com/cgi-bin/redir.cgi?++' # # The substitution syntax supports perl's $1, $2, etc., # grouping syntax. For instance: # # 's/^([a-z]+)foo(.*)$/$1bar$2/' # # The substitution syntax supports the following perl-like # modifiers, which are appended to the end of the # substitution command. # # g Substitute for all occurrences of the regular # expression, not just the first one. # i Do case-insensitive pattern matching. Case-sensitive # pattern matching is the default. # m Treat the string is consisting of multiple lines. # This modifier changes the meaning of "^" and "$" so # that they match just after or just before, # respectively, a line terminator or the end of the # input sequence. By default these expressions only # match at the beginning and the end of the entire # input sequence. # # Single quoting the edit string is highly recommended. See # the curn User's Guide for more details. # # OPTIONAL. Default: none #EditItemURL: # --------------------------------------------------------------------------- # ForceEncoding: Force curn to ignore the character set encoding advertised # by the remote server (if any), and use the character set # specified by this configuration parameter, instead. This # is useful in the following cases: # # - the remote HTTP server doesn't supply an HTTP # Content-Encoding header, and the local (Java) default # encoding doesn't match the document's encoding # - the remote HTTP server supplies the wrong encoding # - the feed is a "file" URL, and the default "file" URL # encoding of "utf-8" isn't correct # # This value should be a character set encoding that's # recognized by the Java runtime environment. # # OPTIONAL. Default: the server- or document-supplied character set encoding, # if present; otherwise, the encoding of the Java VM that's # running curn. #ForceEncoding: utf-8 # --------------------------------------------------------------------------- # GzipDownload: Directs curn to use the "Accept-Encoding: gzip" HTTP # header when retrieving this feed from the HTTP server. # Since RSS feeds are XML, they typically compress well; # retrieving gzipped data, rather than the uncompressed HTML, # can save a significant amount of time and network # bandwidth--provided, of course, the remote HTTP server # honors the "Accept-Encoding" header, which it is not # required to do. This value overrides the global "GzipDownload" # value in the [curn] section. # # OPTIONAL. Default: true #GzipDownload: true # --------------------------------------------------------------------------- # IgnoreDuplicateTitles: If true, curn will ignore any item whose title # matches the title of another item in the feed. # (It only compares titles within the feed itself; # it does not compare against titles of cached items.) # Titles are compared without regard to upper or # lower case. # # This feature (hack, really) is useful for sites # (like Yahoo! News) whose feeds often contain # duplicate items that have different IDs and # different URLs (and thus appear to be unique). # # OPTIONAL. Default: false IgnoreDuplicateTitles: false # --------------------------------------------------------------------------- # IgnoreArticlesOlderThan: Provides a way to ignore articles that are # older than a certain interval. Intervals are # expressed in a natural language syntax. For # instance: # # IgnoreArticlesOlderThan: 3 days # IgnoreArticlesOlderThan: 1 week # IgnoreArticlesOlderThan: 365 days # IgnoreArticlesOlderThan: 12 hours, 30 minutes # # Valid interval names (in English) are: # # millisecond, milliseconds, ms # second, seconds, sec, secs # minute, minutes, min, mins # hour, hours, hr, hrs # day, days # week, weeks # # "year" and "month" are not supported, to avoid # the irregularity of leaps years and different # month lengths, respectively. # # This value overrides the global # "IgnoreArticlesOlderThan" setting. # # OPTIONAL. Default: the value of the global setting. #IgnoreArticlesOlderThan # --------------------------------------------------------------------------- # MaxSummarySize: If you're displaying the summary (see the SummaryOnly # parameter), you can optionally set a maximum size for the # summary. curn will truncate any summary that is longer than # the maximum number of summary characters, adding a trailing # ellipsis to indicate the truncation. A value of 0 # disables truncation. This parameter in a feed section # overrides the global MaxSummarySize parameter. # # OPTIONAL. Default: value of the global MaxSummarySize parameter, or 0 #MaxSummarySize: 0 # --------------------------------------------------------------------------- # PreparseEdit: A parameter in a Feed section that starts with # "PreparseEdit" (e.g., "PreparseEdit1", "PreparseEdit2", # etc.) defines a substitution to be applied to the # downloaded XML file before it is parsed. As with # the EditItemURL option, the value for this option # this option consists of a Perl 5-style substitution. # # This capability is rarely needed, but it's sometimes # useful for sites that serve unparseable, but easily # fixed, XML. For instance, one news site I read has an # RSS channel whose title always contains an unescaped # "&". The XML parser will not parse that feed; however, # a simple preparse edit command of: # # 's/ & / \& /g' # # fixes the problem. # # The substitution syntax supports perl's $1, $2, etc., # grouping syntax. For instance: # # 's/^([a-z]+)foo(.*)$/$1bar$2/' # # The substitution syntax supports the following perl-like # modifiers, which are appended to the end of the # substitution command. # # g Substitute for all occurrences of the regular # expression, not just the first one. # i Do case-insensitive pattern matching. Case-sensitive # pattern matching is the default. # m Treat the string is consisting of multiple lines. # This modifier changes the meaning of "^" and "$" so # that they match just after or just before, # respectively, a line terminator or the end of the # input sequence. By default these expressions only # match at the beginning and the end of the entire # input sequence. # # Single quoting the edit string is highly recommended. See # the curn User's Guide for more details. # # Multiple instances of this parameter are permitted, as # long as each instance's name begins with "PreparseEdit" # and contains a unique suffix. # # OPTIONAL. Default: none #PreparseEdit1: # --------------------------------------------------------------------------- # PruneURLs: If set to "true", then all item URLs from this site are # displayed without HTTP parameters. If set to "false", then URLs # are displayed exactly as they appear in the RSS feed. # # OPTIONAL. Default: false PruneURLs: false # --------------------------------------------------------------------------- # ReplaceEmptyContentWith: What to do when a summary is missing. # Legal values: # # nothing: leave summary empty # content: replace summary with content, if any # title: replace summary with title # # OPTIONAL. Default: the value of the global "ReplaceEmptyContentWith" # parameter, or "nothing" if that's not set. ReplaceEmptyContentWith: nothing # --------------------------------------------------------------------------- # SaveAs: If set, this parameter specifies the path to a file where curn # should save the raw downloaded contents of this feed, whenever it # downloads the feed. This can be useful if you have a master # version of curn that downloads and caches a bunch of feeds, with # multiple "slave" versions of curn that then run against the # downloaded files. # # This configuration item takes a command line-style value: # # [--backups total_backups] [--type rsstype] [--encoding enc] path # # where: # # - specifies how many backups (i.e., previous # versions) of the generated RSS file to keep. For instance, a # value of 5 means "keep 5 previous versions of the file, plus # the one from the current run." This is the best way to keep # RSS files from previous curn runs. The backup files have # version numbers preceding their extensions. For instance, if # the output file is foo.xml, and total_backups is 2, curn # will keep foo.0.xml and foo.1.xml. The file with the largest # version number is the oldest one. If not specified, this # parameter defaults to 0, which means "no backups". # # - is optional and specifies the desired encoding of # the file. It defaults to "utf-8". # # - is the path to the file where the raw RSS data should # be written # OPTIONAL. Default: none #SaveAs: /path/to/file.xml # --------------------------------------------------------------------------- # SaveAsEncoding: If set, this parameter specifies the encoding to use when # saving the file. This parameter is ignored unless SaveAs # is also specified. # # DEPRECATED. Use the --encoding option to the "SaveAs" # parameter, instead. # # OPTIONAL. Default: utf-8 #SaveAsEncoding: utf-8 # --------------------------------------------------------------------------- # SaveOnly: If set to "true", and if "SaveAs" is set to something, then the # feed is downloaded and saved to the "SaveAs" file, but it is # not parsed and not processed. # # OPTIONAL. Default: false #SaveOnly: false # --------------------------------------------------------------------------- # SaveAsRSS: If set, this parameter specifies that the parsed feed data # should be rewritten in the specified RSS format and saved to # the specified file. This configuration item takes a command # line-style value: # # [--backups total_backups] [--type rsstype] [--encoding enc] path # # where: # # - specifies how many backups (i.e., previous # versions) of the generated RSS file to keep. For instance, a # value of 5 means "keep 5 previous versions of the file, plus # the one from the current run." This is the best way to keep # RSS files from previous curn runs. The backup files have # version numbers preceding their extensions. For instance, if # the output file is foo.xml, and total_backups is 2, curn # will keep foo.0.xml and foo.1.xml. The file with the largest # version number is the oldest one. If not specified, this # parameter defaults to 0, which means "no backups". # # - is the type of RSS output to generate. Currently, # "rss1", "rss2" and "atom" are the supported values. # # - is optional and specifies the desired encoding of # the file. It defaults to "utf-8". # # - is the path to the file where the RSS output should # be written # # Note that only the new data in the feed is converted to RSS. # # EXAMPLE: # # SaveAsRSS: rss2 ${system:user.home}/.curn/rss/foo.xml iso-8859-1 # # OPTIONAL. Default: none #SaveAsRSS: # --------------------------------------------------------------------------- # SaveRSSOnly: If set to "true", and if "SaveAsRSS" is set to something, then # the feed is downloaded, parsed, and converted to RSS, but all # subsequent processing is suppressed. # # OPTIONAL. Default: false #SaveRSSOnly: false # --------------------------------------------------------------------------- # ShowAuthors: Show the authors for each item, if available. This value # overrides the global "ShowAuthors" value. # # See also: Command line options --show-authors, -a, --no-authors, -A # # OPTIONAL. Default: false #ShowAuthors: false # --------------------------------------------------------------------------- # SortBy: Sort items in this feed by one of several criteria. # # Valid values: # # time - Sort by timestamp, if present. Current time is assumed # for any item without a timestamp. # title - Sort by item title, if present. Any item without a title # is sorted as if its title were the empty string. # none - Don't sort. (i.e., Leave items in the order they appear # in the XML.) # # OPTIONAL. Default: the value of the global SortBy parameter, or none #SortBy: none # --------------------------------------------------------------------------- # SummaryOnly: Some RSS feeds provide a description for each item, in addition # to the (brief) title. Setting "SummaryOnly" to "true" (or # "yes") suppresses display of the description. This parameter # in a feed section overrides the global SummaryOnly parameter. # # DEPRECATED. Use "ReplaceEmptyContentWith" instead. # # OPTIONAL. Default: the value of the global SummaryOnly option, or false #SummaryOnly: false # --------------------------------------------------------------------------- # TitleOverride: Specifies a string to be used as the site's title, instead # of the title supplied in the RSS feed. Useful when the # feed-supplied title isn't appropriate or useful. # # OPTIONAL. Default: none #TitleOverride: # --------------------------------------------------------------------------- # UserAgent: The HTTP User-Agent header to use when retrieving this feed. # # OPTIONAL. Default: Whatever the global "UserAgent" parameter is set to, or # the default curn user agent string, if the global # "UserAgent" parameter isn't set. #UserAgent: Mozilla/5.0 (X11; U; FreeBSD i686; en-US; rv:1.7.3) Gecko/20040922