/[suikacvs]/webroot/commitfeed/readme.html
Suika

Contents of /webroot/commitfeed/readme.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations) (download) (as text)
Mon Nov 24 06:18:00 2008 UTC (17 years, 8 months ago) by wakaba
Branch: MAIN
File MIME type: text/html 
++ ChangeLog	24 Nov 2008 06:17:32 -0000
	* Makefile: Added rules to make |readme.html|.

	* mkcommitfeed.pl: Added documentation.

2008-11-24  Wakaba  <wakaba@suika.fam.cx>

	* .htaccess: New file.

2008-11-24  Wakaba  <wakaba@suika.fam.cx>
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:[email protected]" />
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 &quot;MyProject Commit Log&quot; \
47     --feed-lang langtag \
48     --feed-related-url &quot;<a href="http://example.com/myproject/&quot">http://example.com/myproject/&quot</a>; \
49     --feed-license-url &quot;<a href="http://example.com/myproject/license&quot">http://example.com/myproject/license&quot</a>; \
50     --feed-rights &quot;Copyright or copyleft statement&quot; \
51     &lt; 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 [email protected]</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