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" />
<link rel=feed type="application/atom+xml" href=commitfeed-commit>

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