rawdog.1

   1 .TH RAWDOG 1
   2 .SH NAME
   3 rawdog \- an RSS Aggregator Without Delusions Of Grandeur
   4 .SH SYNOPSIS
   5 .B rawdog
   6 .RI [ options ]
   7 .SH DESCRIPTION
   8 This manual page briefly documents the
   9 .B rawdog
  10 command.
  11 .PP
  12 \fBrawdog\fP is an RSS (and other) feed aggregator, based on Mark
  13 Pilgrim's flexible feed parser. \fBrawdog\fP reads articles from a
  14 number of feeds and writes out a single HTML file, based on a template
  15 either provided by the user or generated by rawdog, containing the
  16 latest articles it's seen.
  17 .SH OPTIONS
  18 This program follows the usual GNU command line syntax, with long
  19 options starting with two dashes (`\-'). A summary of options is
  20 included below. For a complete description, see the README file.
  21 .SS General Options
  22 .TP
  23 .BI \-d \ DIR\fP, \ \-\-dir \ DIR
  24 Use
  25 .I DIR
  26 instead of the $HOME/.rawdog directory.
  27 .TP
  28 .B \-N, \-\-no\-locking
  29 Do not lock the state file.
  30 .TP
  31 .B \-v, \-\-verbose
  32 Print more detailed status information.
  33 .TP
  34 .B \-W, \-\-no\-lock\-wait
  35 Exit silently if the state file is locked.
  36 .SS Actions
  37 \fBrawdog\fP will perform these actions in the order given.
  38 .TP
  39 .BI \-a \ URL\fP, \ \-\-add \ URL
  40 Try to find a feed associated with
  41 .I URL
  42 and add it to the config file.
  43 .TP
  44 .BI \-c \ FILE\fP, \ \-\-config \ FILE
  45 Read
  46 .I FILE
  47 as an additional config file; any options provided in
  48 .I FILE
  49 will override those set in the main config file (with the exception of
  50 "feed", which is cumulative).
  51 .I FILE
  52 may be an absolute path or a path relative to your .rawdog directory.
  53 Note that $HOME/.rawdog/config will still be read first even if you
  54 specify this option.
  55 .TP
  56 .BI \-f \ URL\fP, \ \-\-update\-feed \ URL
  57 Update the feed pointed to by
  58 .I URL
  59 immediately, even if its period hasn't elapsed since it was last
  60 updated.
  61 .TP
  62 .B \-l, \ \-\-list
  63 List feeds known at the time of last update.
  64 .TP
  65 .BI \-r \ URL\fP, \ \-\-remove \ URL
  66 Remove feed
  67 .I URL
  68 from the config file.
  69 .TP
  70 .B \-t, \ \-\-show\-template
  71 Print the
  72 .I template
  73 currently in use to stdout.
  74 .TP
  75 .B \-T, \ \-\-show\-itemtemplate
  76 Print the
  77 .I itemtemplate
  78 currently in use to stdout.
  79 .TP
  80 .B \-u, \-\-update
  81 Fetch data from the feeds and store it. This could take some time if
  82 you've got lots of feeds.
  83 .TP
  84 .B \-w, \-\-write
  85 Write out the HTML output file.
  86 .SS Special Actions
  87 If one of these options is specified, \fBrawdog\fP will perform only
  88 that action, then exit.
  89 .TP
  90 .B \-\-help
  91 Provide a brief summary of all the options rawdog supports.
  92 .TP
  93 .BI \-\-upgrade \ OLDDIR\ NEWDIR
  94 Import feed state from rawdog 1.x directory
  95 .I OLDDIR
  96 into rawdog 2.x directory
  97 .IR NEWDIR .
  98 .SH EXAMPLES
  99 \fBrawdog\fP is typically invoked from
 100 .BR cron (1).
 101 The following
 102 .BR crontab (5)
 103 entry would fetch data from feeds and write it to HTML once an hour,
 104 exiting if \fBrawdog\fP is already running:
 105 .PP
 106 .nf
 107 .RS
 108 0 * * * *  rawdog -Wvw
 109 .RE
 110 .fi
 111 .SH FILES
 112 $HOME/.rawdog/config
 113 .SH SEE ALSO
 114 .BR cron (1).
 115 .SH AUTHOR
 116 rawdog was mostly written by Adam Sampson <ats@offog.org>, with
 117 contributions and bug reports from many of rawdog's users.
 118 See rawdog's NEWS file for a complete list of contributors.
 119 .PP
 120 This manual page was originally written by Decklin Foster
 121 <decklin@red\-bean.com>, for the Debian project (but may be used by others).