webroot/commitfeed/readme.html

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>mkcommitfeed.pl - Commit Log Feed Generator</title>
<link rel="stylesheet" href="http://suika.fam.cx/www/style/html/pod.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:wakaba@suika.fam.cx" />
</head>

<body>


<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>

<ul>

        <li><a href="#name">NAME</a></li>
        <li><a href="#synopsis">SYNOPSIS</a></li>
        <li><a href="#description">DESCRIPTION</a></li>
        <li><a href="#standard_input">STANDARD INPUT</a></li>
        <li><a href="#arguments">ARGUMENTS</a></li>
        <li><a href="#author">AUTHOR</a></li>
        <li><a href="#history">HISTORY</a></li>
        <li><a href="#license">LICENSE</a></li>
</ul>

<hr name="index" />
</div>
<!-- INDEX END -->

<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>mkcommitfeed.pl - Commit Log Feed Generator</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
  mkcommitfeed.pl \
    --file-name filename.atom \
    --feed-url <a href="http://example.com/myproject/filename.atom">http://example.com/myproject/filename.atom</a> \
    --feed-title &quot;MyProject Commit Log&quot; \
    --feed-lang langtag \
    --feed-related-url &quot;<a href="http://example.com/myproject/&quot">http://example.com/myproject/&quot</a>; \
    --feed-license-url &quot;<a href="http://example.com/myproject/license&quot">http://example.com/myproject/license&quot</a>; \
    --feed-rights &quot;Copyright or copyleft statement&quot; \
    &lt; changes-in-this-revision.txt</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>The <code>mkcommitfeed.pl</code> script provides a command-line interface to
update an Atom Feed that is intended for providing commit logs for a
software developmenet project.</p>
<p>The script, when invoked, adds an Atom Entry that describes a change
made to the project's repository.</p>
<p>
</p>
<hr />
<h1><a name="standard_input">STANDARD INPUT</a></h1>
<p>A description for the change must be specified to the standard input.
It is used as the plain text content of the atom:content element of
the Entry for the change to add.</p>
<p>Non-ASCII characters are not supported in this version of this script.
Maybe a future version of this script would support UTF-8.</p>
<p>
</p>
<hr />
<h1><a name="arguments">ARGUMENTS</a></h1>
<p>There are command-line options for the script.  Some of them are
required, while the others are optional.  As a general rule, an option
whose name begins with <code>--entry</code> specifies a property for the Entry
to add, while an option whose name begins with <code>--feed</code> specifies a
property for the entire Feed.  Option values for Feed properties might
not be used when updating an existing Feed document.</p>
<dl>
<dt><strong><a name="example" class="item"><code>--entry-author-mail foo@domain.example</code> (optional)</a></strong>

<dd>
<p>Specifies the mail address of the person who made a change.  It is
used as the content of the <code>atom:email</code> element of the <code>atom:author</code>
element of the Entry.</p>
</dd>
<dd>
<p>If this option is not specified, but the standard input includes a
ChangeLog entry in the standard GNU format, then the mail address is
taken from the ChangeLog entry.  Otherwise, <code>atom:email</code> element is
not specified.</p>
</dd>
<dd>
<p>The option value must be an <a href="http://www.ietf.org/rfc/rfc2822.txt" class="rfc">RFC 2822</a> <code>addr-spec</code> that does not match
<code>obs-addr-spec</code> (i.e. standard email address format).  Otherwise the
generated Feed would be non-conforming.</p>
</dd>
</li>
<dt><strong><a name="name" class="item"><code>--entry-author-name author-name</code> (conditionally required)</a></strong>

<dd>
<p>Specifies the human readable name of the person who made a change.  It
is used as the content of the <code>atom:name</code> element of the
<code>atom:author</code> element of the Entry.</p>
</dd>
<dd>
<p>If this option is not specified, but the standard input includes a
ChangeLog entry in the standard GNU format, then the name is taken
from the ChangeLog entry.  If the standard input does not include a
GNU format ChangeLog entry, then the <code>--entry-author-name</code> option
must be specified.</p>
</dd>
<dd>
<p>Non-ASCII characters are not supported in this version of this script.</p>
</dd>
</li>
<dt><strong><a name="description" class="item"><code>--entry-content description</code> (optional)</a></strong>

<dd>
<p>Specifies the description of the change.  It is used as the content of
the <code>atom:content</code> element of the Entry, with <code>type=text</code>.</p>
</dd>
<dd>
<p>If this option is specified, its value is used as if it were from the
standard input and the actual standard input, if any, is ignored.  If
neither this option nor the standard input is specified, then the
description is assumed as the empty string.</p>
</dd>
<dd>
<p>Non-ASCII characters are not supported in this version of this script.</p>
</dd>
</li>
<dt><strong><a name="title" class="item"><code>--entry-title title</code> (optional)</a></strong>

<dd>
<p>Specifies the title of the change.  It is used as the content of the
<code>atom:title</code> element of the Entry, with <code>type=text</code>.</p>
</dd>
<dd>
<p>If this option is not specified, then the date of the change, as well
as the name of the author, is used as title.</p>
</dd>
<dd>
<p>Non-ASCII characters are not supported in this version of this script.</p>
</dd>
</li>
<dt><strong><code>--feed-author-mail foo@domain.example</code> (optional)</strong>

<dd>
<p>Specifies the mail address of the author of the Feed.  It is used as
the content of the <code>atom:email</code> element of the <code>atom:author</code> element
of the Feed.</p>
</dd>
<dd>
<p>This option is ignored if the <code>--feed-author-name</code> option is not
specified.</p>
</dd>
<dd>
<p>If this option is not specified, <code>atom:email</code> element is not
specified.</p>
</dd>
<dd>
<p>The option value must be an <a href="http://www.ietf.org/rfc/rfc2822.txt" class="rfc">RFC 2822</a> <code>addr-spec</code> that does not match
<code>obs-addr-spec</code> (i.e. standard email address format).  Otherwise the
generated Feed would be non-conforming.</p>
</dd>
<dd>
<p>This option is ignored if the Feed already has an <code>atom:author</code>
element.</p>
</dd>
</li>
<dt><strong><code>--feed-author-name author-name</code> (optional)</strong>

<dd>
<p>Specifies the human readable name of the author of the Feed.  It is
used as the content of the <code>atom:name</code> element of the <code>atom:author</code>
element of the Feed.</p>
</dd>
<dd>
<p>If this option is not specified, the <code>atom:author</code> element is not
specified in the Feed.</p>
</dd>
<dd>
<p>Non-ASCII characters are not supported in this version of this script.</p>
</dd>
<dd>
<p>This option is ignored if the Feed already has an <code>atom:author</code>
element.</p>
</dd>
</li>
<dt><strong><a name="url" class="item"><code>--feed-author-url url</code> (optional)</a></strong>

<dd>
<p>Specifies the URI for the author (e.g. URL of the Web page for the
author).  It is used as the content of the <code>atom:uri</code> element of the
<code>atom:author</code> element of the Feed.</p>
</dd>
<dd>
<p>If the <code>--feed-author-name</code> option is not specified, this option is
ignored.</p>
</dd>
<dd>
<p>If this option is not specified, the <code>atom:uri</code> element is not
specified.</p>
</dd>
<dd>
<p>The option value must be a URI reference conforming to <a href="http://www.ietf.org/rfc/rfc3986.txt" class="rfc">RFC 3986</a>.  It
should be an absolute reference unless you understand what is the base
URL that is used to resolve a relative reference.  Non-ASCII
characters (i.e. IRI references) are not supported in this version of
this script.</p>
</dd>
<dd>
<p>This option is ignored if the Feed already has an <code>atom:author</code>
element.</p>
</dd>
</li>
<dt><strong><a name="langtag" class="item"><code>--feed-lang langtag</code> (optional)</a></strong>

<dd>
<p>Specifies the natural language used in textual parts of the Feed.  It
is used as the value of <code>xml:lang</code> attribute of the root element of
the Feed.</p>
</dd>
<dd>
<p>If this option is not specified, the default value <em>i-default</em> is used.</p>
</dd>
<dd>
<p>This option is ignored if the Feed already exists and has a
<code>atom:link</code> element.</p>
</dd>
</li>
<dt><strong><code>--feed-license-url url</code> (optional)</strong>

<dd>
<p>Specifies the URL that describes the license of the Feed.  It is used
as the <code>href</code> attribute value of an <code>atom:link</code> element whose <code>rel</code>
is <code>license</code>.</p>
</dd>
<dd>
<p>If this option is not specified, the <code>atom:link</code> element whose <code>rel</code>
is <code>license</code> is not specified.</p>
</dd>
<dd>
<p>The option value must be a URI reference conforming to <a href="http://www.ietf.org/rfc/rfc3986.txt" class="rfc">RFC 3986</a>.  It
should be an absolute reference unless you understand what is the base
URL that is used to resolve a relative reference.  Non-ASCII
characters (i.e. IRI references) are not supported in this version of
this script.</p>
</dd>
<dd>
<p>This option is ignored if the Feed already has a <code>atom:link</code>
element.</p>
</dd>
</li>
<dt><strong><code>--feed-related-url url</code> (optional)</strong>

<dd>
<p>Specifies a related URL for the Feed.  Usually the URL for the project
Web page should be specified.  It is used as the <code>href</code> attribute
value of an <code>atom:link</code> element whose <code>rel</code> is <code>related</code>.</p>
</dd>
<dd>
<p>If this option is not specified, the <code>atom:link</code> element whose <code>rel</code>
is <code>related</code> is not specified.</p>
</dd>
<dd>
<p>The option value must be a URI reference conforming to <a href="http://www.ietf.org/rfc/rfc3986.txt" class="rfc">RFC 3986</a>.  It
should be an absolute reference unless you understand what is the base
URL that is used to resolve a relative reference.  Non-ASCII
characters (i.e. IRI references) are not supported in this version of
this script.</p>
</dd>
<dd>
<p>This option is ignored if the Feed already has a <code>atom:link</code>
element.</p>
</dd>
</li>
<dt><strong><a name="terms" class="item"><code>--feed-rights license-terms</code> (optional)</a></strong>

<dd>
<p>Specifies the license terms for the Feed.  It is used as the content
of the <code>atom:rights</code> element of the Feed.</p>
</dd>
<dd>
<p>If there is the <code>atom:rights</code> element exists, its value is replaced
by the value of this option.</p>
</dd>
<dd>
<p>If this option is not specified, the <code>atom:rights</code> element is not
added.  If there are already the <code>atom:rights</code> element specified,
however, it is not removed from the Feed.</p>
</dd>
<dd>
<p>Non-ASCII characters are not supported in this version of this script.</p>
</dd>
</li>
<dt><strong><code>--feed-title title</code> (optional)</strong>

<dd>
<p>Specifies the title of the Feed.  It is used as the content of the
<code>atom:title</code> of the Feed.</p>
</dd>
<dd>
<p>If this option is not specified, the default value &quot;ChangeLog&quot; is used.</p>
</dd>
<dd>
<p>If there is Feed exists, then this option is ignored.</p>
</dd>
<dd>
<p>Non-ASCII characters are not supported in this version of this script.</p>
</dd>
</li>
<dt><strong><code>--feed-url url</code> (required)</strong>

<dd>
<p>Specifies the URL of the Feed itself.  It is used in various places,
such as in the <code>href</code> attribute of the <code>atom:link</code> element whose
<code>rel</code> is <code>self</code>.</p>
</dd>
<dd>
<p>The option value must be a URI reference conforming to <a href="http://www.ietf.org/rfc/rfc3986.txt" class="rfc">RFC 3986</a>.  It
should be an absolute reference unless you understand what is the base
URL that is used to resolve a relative reference.  Non-ASCII
characters (i.e. IRI references) are not supported in this version of
this script.</p>
</dd>
</li>
<dt><strong><a name="file" class="item"><code>--file-name path-to-atom-file</code> (required)</a></strong>

<dd>
<p>Specifies the path to the file that contains the Atom Feed.</p>
</dd>
<dd>
<p>If the specified file is not found, then a new file is created.
Otherwise, the existing file is loaded as an Atom Feed and then it is
updated.</p>
</dd>
<dd>
<p>The file, if exists, must be encoded in UTF-8.  The new content of the
file generated by this script is encoded in UTF-8.</p>
</dd>
</li>
<dt><strong><a name="help" class="item"><code>--help</code></a></strong>

<dd>
<p>Shows a help message and aborts.</p>
</dd>
</li>
</dl>
<p>
</p>
<hr />
<h1><a name="author">AUTHOR</a></h1>
<p>Wakaba &lt;<a href="mailto:w@suika.fam.cx">w@suika.fam.cx</a>&gt;.</p>
<p>
</p>
<hr />
<h1><a name="history">HISTORY</a></h1>
<p>This module was originally developed as part of Whatpm
<a href="http://suika.fam.cx/www/markup/html/whatpm/readme">http://suika.fam.cx/www/markup/html/whatpm/readme</a>.</p>
<p>An Atom Feed for updates for this script, which is itself generated by
this script, is available at
<a href="http://suika.fam.cx/commitfeed/commitfeed-commit">http://suika.fam.cx/commitfeed/commitfeed-commit</a>.</p>
<p>
</p>
<hr />
<h1><a name="license">LICENSE</a></h1>
<p>Copyright 2008 Wakaba &lt;<a href="mailto:w@suika.fam.cx">w@suika.fam.cx</a>&gt;</p>
<p>This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.</p>

</body>

</html>
1	wakaba	1.1	<?xml version="1.0" ?>
2			<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3			<html xmlns="http://www.w3.org/1999/xhtml">
4			<head>
5			<title>mkcommitfeed.pl - Commit Log Feed Generator</title>
6			<link rel="stylesheet" href="http://suika.fam.cx/www/style/html/pod.css" type="text/css" />
7			<meta http-equiv="content-type" content="text/html; charset=utf-8" />
8			<link rev="made" href="mailto:wakaba@suika.fam.cx" />
9			</head>
10
11			<body>
12
13
14			<!-- INDEX BEGIN -->
15			<div name="index">
16			<p><a name="__index__"></a></p>
17
18			<ul>
19
20			<li><a href="#name">NAME</a></li>
21			<li><a href="#synopsis">SYNOPSIS</a></li>
22			<li><a href="#description">DESCRIPTION</a></li>
23			<li><a href="#standard_input">STANDARD INPUT</a></li>
24			<li><a href="#arguments">ARGUMENTS</a></li>
25			<li><a href="#author">AUTHOR</a></li>
26			<li><a href="#history">HISTORY</a></li>
27			<li><a href="#license">LICENSE</a></li>
28			</ul>
29
30			<hr name="index" />
31			</div>
32			<!-- INDEX END -->
33
34			<p>
35			</p>
36			<h1><a name="name">NAME</a></h1>
37			<p>mkcommitfeed.pl - Commit Log Feed Generator</p>
38			<p>
39			</p>
40			<hr />
41			<h1><a name="synopsis">SYNOPSIS</a></h1>
42			<pre>
43			mkcommitfeed.pl \
44			--file-name filename.atom \
45			--feed-url <a href="http://example.com/myproject/filename.atom">http://example.com/myproject/filename.atom</a> \
46			--feed-title "MyProject Commit Log" \
47			--feed-lang langtag \
48			--feed-related-url "<a href="http://example.com/myproject/&quot">http://example.com/myproject/&quot</a>; \
49			--feed-license-url "<a href="http://example.com/myproject/license&quot">http://example.com/myproject/license&quot</a>; \
50			--feed-rights "Copyright or copyleft statement" \
51			< changes-in-this-revision.txt</pre>
52			<p>
53			</p>
54			<hr />
55			<h1><a name="description">DESCRIPTION</a></h1>
56			<p>The <code>mkcommitfeed.pl</code> script provides a command-line interface to
57			update an Atom Feed that is intended for providing commit logs for a
58			software developmenet project.</p>
59			<p>The script, when invoked, adds an Atom Entry that describes a change
60			made to the project's repository.</p>
61			<p>
62			</p>
63			<hr />
64			<h1><a name="standard_input">STANDARD INPUT</a></h1>
65			<p>A description for the change must be specified to the standard input.
66			It is used as the plain text content of the atom:content element of
67			the Entry for the change to add.</p>
68			<p>Non-ASCII characters are not supported in this version of this script.
69			Maybe a future version of this script would support UTF-8.</p>
70			<p>
71			</p>
72			<hr />
73			<h1><a name="arguments">ARGUMENTS</a></h1>
74			<p>There are command-line options for the script. Some of them are
75			required, while the others are optional. As a general rule, an option
76			whose name begins with <code>--entry</code> specifies a property for the Entry
77			to add, while an option whose name begins with <code>--feed</code> specifies a
78			property for the entire Feed. Option values for Feed properties might
79			not be used when updating an existing Feed document.</p>
80			<dl>
81			<dt><strong><a name="example" class="item"><code>--entry-author-mail foo@domain.example</code> (optional)</a></strong>
82
83			<dd>
84			<p>Specifies the mail address of the person who made a change. It is
85			used as the content of the <code>atom:email</code> element of the <code>atom:author</code>
86			element of the Entry.</p>
87			</dd>
88			<dd>
89			<p>If this option is not specified, but the standard input includes a
90			ChangeLog entry in the standard GNU format, then the mail address is
91			taken from the ChangeLog entry. Otherwise, <code>atom:email</code> element is
92			not specified.</p>
93			</dd>
94			<dd>
95			<p>The option value must be an <a href="http://www.ietf.org/rfc/rfc2822.txt" class="rfc">RFC 2822</a> <code>addr-spec</code> that does not match
96			<code>obs-addr-spec</code> (i.e. standard email address format). Otherwise the
97			generated Feed would be non-conforming.</p>
98			</dd>
99			</li>
100			<dt><strong><a name="name" class="item"><code>--entry-author-name author-name</code> (conditionally required)</a></strong>
101
102			<dd>
103			<p>Specifies the human readable name of the person who made a change. It
104			is used as the content of the <code>atom:name</code> element of the
105			<code>atom:author</code> element of the Entry.</p>
106			</dd>
107			<dd>
108			<p>If this option is not specified, but the standard input includes a
109			ChangeLog entry in the standard GNU format, then the name is taken
110			from the ChangeLog entry. If the standard input does not include a
111			GNU format ChangeLog entry, then the <code>--entry-author-name</code> option
112			must be specified.</p>
113			</dd>
114			<dd>
115			<p>Non-ASCII characters are not supported in this version of this script.</p>
116			</dd>
117			</li>
118			<dt><strong><a name="description" class="item"><code>--entry-content description</code> (optional)</a></strong>
119
120			<dd>
121			<p>Specifies the description of the change. It is used as the content of
122			the <code>atom:content</code> element of the Entry, with <code>type=text</code>.</p>
123			</dd>
124			<dd>
125			<p>If this option is specified, its value is used as if it were from the
126			standard input and the actual standard input, if any, is ignored. If
127			neither this option nor the standard input is specified, then the
128			description is assumed as the empty string.</p>
129			</dd>
130			<dd>
131			<p>Non-ASCII characters are not supported in this version of this script.</p>
132			</dd>
133			</li>
134			<dt><strong><a name="title" class="item"><code>--entry-title title</code> (optional)</a></strong>
135
136			<dd>
137			<p>Specifies the title of the change. It is used as the content of the
138			<code>atom:title</code> element of the Entry, with <code>type=text</code>.</p>
139			</dd>
140			<dd>
141			<p>If this option is not specified, then the date of the change, as well
142			as the name of the author, is used as title.</p>
143			</dd>
144			<dd>
145			<p>Non-ASCII characters are not supported in this version of this script.</p>
146			</dd>
147			</li>
148			<dt><strong><code>--feed-author-mail foo@domain.example</code> (optional)</strong>
149
150			<dd>
151			<p>Specifies the mail address of the author of the Feed. It is used as
152			the content of the <code>atom:email</code> element of the <code>atom:author</code> element
153			of the Feed.</p>
154			</dd>
155			<dd>
156			<p>This option is ignored if the <code>--feed-author-name</code> option is not
157			specified.</p>
158			</dd>
159			<dd>
160			<p>If this option is not specified, <code>atom:email</code> element is not
161			specified.</p>
162			</dd>
163			<dd>
164			<p>The option value must be an <a href="http://www.ietf.org/rfc/rfc2822.txt" class="rfc">RFC 2822</a> <code>addr-spec</code> that does not match
165			<code>obs-addr-spec</code> (i.e. standard email address format). Otherwise the
166			generated Feed would be non-conforming.</p>
167			</dd>
168			<dd>
169			<p>This option is ignored if the Feed already has an <code>atom:author</code>
170			element.</p>
171			</dd>
172			</li>
173			<dt><strong><code>--feed-author-name author-name</code> (optional)</strong>
174
175			<dd>
176			<p>Specifies the human readable name of the author of the Feed. It is
177			used as the content of the <code>atom:name</code> element of the <code>atom:author</code>
178			element of the Feed.</p>
179			</dd>
180			<dd>
181			<p>If this option is not specified, the <code>atom:author</code> element is not
182			specified in the Feed.</p>
183			</dd>
184			<dd>
185			<p>Non-ASCII characters are not supported in this version of this script.</p>
186			</dd>
187			<dd>
188			<p>This option is ignored if the Feed already has an <code>atom:author</code>
189			element.</p>
190			</dd>
191			</li>
192			<dt><strong><a name="url" class="item"><code>--feed-author-url url</code> (optional)</a></strong>
193
194			<dd>
195			<p>Specifies the URI for the author (e.g. URL of the Web page for the
196			author). It is used as the content of the <code>atom:uri</code> element of the
197			<code>atom:author</code> element of the Feed.</p>
198			</dd>
199			<dd>
200			<p>If the <code>--feed-author-name</code> option is not specified, this option is
201			ignored.</p>
202			</dd>
203			<dd>
204			<p>If this option is not specified, the <code>atom:uri</code> element is not
205			specified.</p>
206			</dd>
207			<dd>
208			<p>The option value must be a URI reference conforming to <a href="http://www.ietf.org/rfc/rfc3986.txt" class="rfc">RFC 3986</a>. It
209			should be an absolute reference unless you understand what is the base
210			URL that is used to resolve a relative reference. Non-ASCII
211			characters (i.e. IRI references) are not supported in this version of
212			this script.</p>
213			</dd>
214			<dd>
215			<p>This option is ignored if the Feed already has an <code>atom:author</code>
216			element.</p>
217			</dd>
218			</li>
219			<dt><strong><a name="langtag" class="item"><code>--feed-lang langtag</code> (optional)</a></strong>
220
221			<dd>
222			<p>Specifies the natural language used in textual parts of the Feed. It
223			is used as the value of <code>xml:lang</code> attribute of the root element of
224			the Feed.</p>
225			</dd>
226			<dd>
227			<p>If this option is not specified, the default value <em>i-default</em> is used.</p>
228			</dd>
229			<dd>
230			<p>This option is ignored if the Feed already exists and has a
231			<code>atom:link</code> element.</p>
232			</dd>
233			</li>
234			<dt><strong><code>--feed-license-url url</code> (optional)</strong>
235
236			<dd>
237			<p>Specifies the URL that describes the license of the Feed. It is used
238			as the <code>href</code> attribute value of an <code>atom:link</code> element whose <code>rel</code>
239			is <code>license</code>.</p>
240			</dd>
241			<dd>
242			<p>If this option is not specified, the <code>atom:link</code> element whose <code>rel</code>
243			is <code>license</code> is not specified.</p>
244			</dd>
245			<dd>
246			<p>The option value must be a URI reference conforming to <a href="http://www.ietf.org/rfc/rfc3986.txt" class="rfc">RFC 3986</a>. It
247			should be an absolute reference unless you understand what is the base
248			URL that is used to resolve a relative reference. Non-ASCII
249			characters (i.e. IRI references) are not supported in this version of
250			this script.</p>
251			</dd>
252			<dd>
253			<p>This option is ignored if the Feed already has a <code>atom:link</code>
254			element.</p>
255			</dd>
256			</li>
257			<dt><strong><code>--feed-related-url url</code> (optional)</strong>
258
259			<dd>
260			<p>Specifies a related URL for the Feed. Usually the URL for the project
261			Web page should be specified. It is used as the <code>href</code> attribute
262			value of an <code>atom:link</code> element whose <code>rel</code> is <code>related</code>.</p>
263			</dd>
264			<dd>
265			<p>If this option is not specified, the <code>atom:link</code> element whose <code>rel</code>
266			is <code>related</code> is not specified.</p>
267			</dd>
268			<dd>
269			<p>The option value must be a URI reference conforming to <a href="http://www.ietf.org/rfc/rfc3986.txt" class="rfc">RFC 3986</a>. It
270			should be an absolute reference unless you understand what is the base
271			URL that is used to resolve a relative reference. Non-ASCII
272			characters (i.e. IRI references) are not supported in this version of
273			this script.</p>
274			</dd>
275			<dd>
276			<p>This option is ignored if the Feed already has a <code>atom:link</code>
277			element.</p>
278			</dd>
279			</li>
280			<dt><strong><a name="terms" class="item"><code>--feed-rights license-terms</code> (optional)</a></strong>
281
282			<dd>
283			<p>Specifies the license terms for the Feed. It is used as the content
284			of the <code>atom:rights</code> element of the Feed.</p>
285			</dd>
286			<dd>
287			<p>If there is the <code>atom:rights</code> element exists, its value is replaced
288			by the value of this option.</p>
289			</dd>
290			<dd>
291			<p>If this option is not specified, the <code>atom:rights</code> element is not
292			added. If there are already the <code>atom:rights</code> element specified,
293			however, it is not removed from the Feed.</p>
294			</dd>
295			<dd>
296			<p>Non-ASCII characters are not supported in this version of this script.</p>
297			</dd>
298			</li>
299			<dt><strong><code>--feed-title title</code> (optional)</strong>
300
301			<dd>
302			<p>Specifies the title of the Feed. It is used as the content of the
303			<code>atom:title</code> of the Feed.</p>
304			</dd>
305			<dd>
306			<p>If this option is not specified, the default value "ChangeLog" is used.</p>
307			</dd>
308			<dd>
309			<p>If there is Feed exists, then this option is ignored.</p>
310			</dd>
311			<dd>
312			<p>Non-ASCII characters are not supported in this version of this script.</p>
313			</dd>
314			</li>
315			<dt><strong><code>--feed-url url</code> (required)</strong>
316
317			<dd>
318			<p>Specifies the URL of the Feed itself. It is used in various places,
319			such as in the <code>href</code> attribute of the <code>atom:link</code> element whose
320			<code>rel</code> is <code>self</code>.</p>
321			</dd>
322			<dd>
323			<p>The option value must be a URI reference conforming to <a href="http://www.ietf.org/rfc/rfc3986.txt" class="rfc">RFC 3986</a>. It
324			should be an absolute reference unless you understand what is the base
325			URL that is used to resolve a relative reference. Non-ASCII
326			characters (i.e. IRI references) are not supported in this version of
327			this script.</p>
328			</dd>
329			</li>
330			<dt><strong><a name="file" class="item"><code>--file-name path-to-atom-file</code> (required)</a></strong>
331
332			<dd>
333			<p>Specifies the path to the file that contains the Atom Feed.</p>
334			</dd>
335			<dd>
336			<p>If the specified file is not found, then a new file is created.
337			Otherwise, the existing file is loaded as an Atom Feed and then it is
338			updated.</p>
339			</dd>
340			<dd>
341			<p>The file, if exists, must be encoded in UTF-8. The new content of the
342			file generated by this script is encoded in UTF-8.</p>
343			</dd>
344			</li>
345			<dt><strong><a name="help" class="item"><code>--help</code></a></strong>
346
347			<dd>
348			<p>Shows a help message and aborts.</p>
349			</dd>
350			</li>
351			</dl>
352			<p>
353			</p>
354			<hr />
355			<h1><a name="author">AUTHOR</a></h1>
356			<p>Wakaba <<a href="mailto:w@suika.fam.cx">w@suika.fam.cx</a>>.</p>
357			<p>
358			</p>
359			<hr />
360			<h1><a name="history">HISTORY</a></h1>
361			<p>This module was originally developed as part of Whatpm
362			<a href="http://suika.fam.cx/www/markup/html/whatpm/readme">http://suika.fam.cx/www/markup/html/whatpm/readme</a>.</p>
363			<p>An Atom Feed for updates for this script, which is itself generated by
364			this script, is available at
365			<a href="http://suika.fam.cx/commitfeed/commitfeed-commit">http://suika.fam.cx/commitfeed/commitfeed-commit</a>.</p>
366			<p>
367			</p>
368			<hr />
369			<h1><a name="license">LICENSE</a></h1>
370			<p>Copyright 2008 Wakaba <<a href="mailto:w@suika.fam.cx">w@suika.fam.cx</a>></p>
371			<p>This program is free software; you can redistribute it and/or
372			modify it under the same terms as Perl itself.</p>
373
374			</body>
375
376			</html>