.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.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 Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SUBATOM 1"
.TH SUBATOM 1 "2008-01-07" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
subatom \- produce an atom feed from subversion commits
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& subatom [-m max] [-o output] [-v viewcvs] REPOSITORY_URL [path ...]
\& subatom -c config_file
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBsubatom\fR is a small script to produce an Atom feed from subversion
commits. You can use this with a feed reader to see new commits to
your repository.
.PP
The first argument is the \s-1URL\s0 for your subversion repository. The
remaining arguments are paths within the repository for which you
would like commit messages. If you don't specify any, it will default
to the entire repository.
.PP
The \fI\-m\fR flag states how many entries you would like in the feed.
The default is 30.
.PP
If you pass a filename using the \fI\-o\fR flag, the output will be
written there instead of \s-1STDOUT\s0. If the filename already exists then
the timestamp will be checked and the new feed will only be written if
it actually contains any newer entries. If you will be serving the
feed file using a web server, then doing this enables
If-Modified-Since to work correctly (ie: feed readers will only
download the file if it has actually changed).
.PP
You can pass an \s-1URL\s0 using the \fI\-v\fR flag, and \fBsubatom\fR will create a
link for each commit by appending the revision number to the \s-1URL\s0. For
example a viewcvs \s-1URL\s0 might look like this (on the command line).
.PP
.Vb 1
\& http://example.com/viewcvs/svn/?view=rev&rev=
.Ve
.PP
If the \s-1URL\s0 has question marks or ampersands, don't forget to quote it on
the command line. If you don't, the shell will interpret them and
probably give some odd looking errors.
.PP
If you don't pass in a \s-1URL\s0, a link will be automatically made to the
first file that changed in this commit.
.PP
If you pass an \s-1URL\s0 using the \fI\-s\fR flag, it will be used as the \fIself\fR
link for the feed. Use this if you would like to avoid warnings from
the feed validator.
.SH "CONFIG FILE"
.IX Header "CONFIG FILE"
In order to avoid wrapper scripts calling subatom with lots of parameters,
you can also specify a config file. The format of the file consists of
lines containing key-value pairs separated by whitespace. A blank line
introduces a new stanza. You can generate multiple feeds by specifying
several stanzas.
.PP
The following keywords are recognized.
.IP "\fImax_entries\fR" 4
.IX Item "max_entries"
How many entries should be in the feed? Defaults to 30.
.IP "\fIoutput_file\fR" 4
.IX Item "output_file"
Where should the feed be written to? Must be specified.
.IP "\fIrepos_url\fR" 4
.IX Item "repos_url"
The path to the root of the repository. Must be specified.
.Sp
\&\fB\s-1NB\s0\fR: \fIsubatom\fR likes to have the trailing slash removed, if you get any
complaints, try taking it off.
.IP "\fIpath\fR" 4
.IX Item "path"
Specifies a directory in the repository to monitor commit messages for.
Defaults to '/'.
.IP "\fIself_url\fR" 4
.IX Item "self_url"
Specifies the \s-1URL\s0 of the feed that will be produced. No default.
.IP "\fIviewcvs_url\fR" 4
.IX Item "viewcvs_url"
Specifies an \s-1URL\s0 prefix which will have the revision number appended to
produce the link for each commit. For example, if you have a trac setup,
use something like this:
.Sp
.Vb 1
\& viewcvs_url http://dev.rubyonrails.org/changeset/
.Ve
.IP "\fIfeed_title\fR" 4
.IX Item "feed_title"
Specify the title for the feed as a whole. Defaults to \*(L"Recent
commits to \f(CW$repos_url\fR\*(R".
.Sh "\s-1EXAMPLE\s0"
.IX Subsection "EXAMPLE"
.Vb 6
\& output_file /www/svn.atom
\& path /trunk
\& repos_url http://svn.collab.net/repos/svn
\& self_url http://localhost/svn.atom
\& viewcvs_url http://svn.collab.net/viewvc/svn?view=rev&revision=
\& feed_title Subversion Changes
.Ve
.PP
.Vb 5
\& output_file /www/rails.atom
\& path /trunk
\& repos_url http://dev.rubyonrails.org/svn/rails
\& self_url http://localhost/rails.atom
\& viewcvs_url http://dev.rubyonrails.org/changeset/
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
XML::Atom
.PP
.PP
.SH "AUTHOR"
.IX Header "AUTHOR"
Dominic Mitchell
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2004 by Dominic Mitchell. All rights reserved.
.PP
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
.IP "1." 4
Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
.IP "2." 4
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
.PP
\&\s-1THIS\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1PROVIDED\s0 \s-1BY\s0 \s-1AUTHOR\s0 \s-1AND\s0 \s-1CONTRIBUTORS\s0 ``\s-1AS\s0 \s-1IS\s0'' \s-1AND\s0
\&\s-1ANY\s0 \s-1EXPRESS\s0 \s-1OR\s0 \s-1IMPLIED\s0 \s-1WARRANTIES\s0, \s-1INCLUDING\s0, \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0, \s-1THE\s0
\&\s-1IMPLIED\s0 \s-1WARRANTIES\s0 \s-1OF\s0 \s-1MERCHANTABILITY\s0 \s-1AND\s0 \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0
\&\s-1ARE\s0 \s-1DISCLAIMED\s0. \s-1IN\s0 \s-1NO\s0 \s-1EVENT\s0 \s-1SHALL\s0 \s-1AUTHOR\s0 \s-1OR\s0 \s-1CONTRIBUTORS\s0 \s-1BE\s0 \s-1LIABLE\s0
\&\s-1FOR\s0 \s-1ANY\s0 \s-1DIRECT\s0, \s-1INDIRECT\s0, \s-1INCIDENTAL\s0, \s-1SPECIAL\s0, \s-1EXEMPLARY\s0, \s-1OR\s0 \s-1CONSEQUENTIAL\s0
\&\s-1DAMAGES\s0 (\s-1INCLUDING\s0, \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0, \s-1PROCUREMENT\s0 \s-1OF\s0 \s-1SUBSTITUTE\s0 \s-1GOODS\s0
\&\s-1OR\s0 \s-1SERVICES\s0; \s-1LOSS\s0 \s-1OF\s0 \s-1USE\s0, \s-1DATA\s0, \s-1OR\s0 \s-1PROFITS\s0; \s-1OR\s0 \s-1BUSINESS\s0 \s-1INTERRUPTION\s0)
\&\s-1HOWEVER\s0 \s-1CAUSED\s0 \s-1AND\s0 \s-1ON\s0 \s-1ANY\s0 \s-1THEORY\s0 \s-1OF\s0 \s-1LIABILITY\s0, \s-1WHETHER\s0 \s-1IN\s0 \s-1CONTRACT\s0, \s-1STRICT\s0
\&\s-1LIABILITY\s0, \s-1OR\s0 \s-1TORT\s0 (\s-1INCLUDING\s0 \s-1NEGLIGENCE\s0 \s-1OR\s0 \s-1OTHERWISE\s0) \s-1ARISING\s0 \s-1IN\s0 \s-1ANY\s0 \s-1WAY\s0
\&\s-1OUT\s0 \s-1OF\s0 \s-1THE\s0 \s-1USE\s0 \s-1OF\s0 \s-1THIS\s0 \s-1SOFTWARE\s0, \s-1EVEN\s0 \s-1IF\s0 \s-1ADVISED\s0 \s-1OF\s0 \s-1THE\s0 \s-1POSSIBILITY\s0 \s-1OF\s0
\&\s-1SUCH\s0 \s-1DAMAGE\s0.