svn: /pear/peardoc/trunk/ja/ channels/scs/commands/addcategory.xml channels/scs/commands/addmaintainer.xml channels/scs/commands/create.xml channels/scs/commands/release.xml channels/scs/commands/update.xml channels/scs/commands.xml channels/scs/intro.xml channels/scs.xml channels/whatarethey.xml
[email protected] (Yoshinari Takaoka)
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <[email protected]> |
mumumu Mon, 07 Dec 2009 00:12:31 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=291782
Log:
- sync with en.
Changed paths:
A pear/peardoc/trunk/ja/channels/
A pear/peardoc/trunk/ja/channels/scs/
A pear/peardoc/trunk/ja/channels/scs/commands/
A pear/peardoc/trunk/ja/channels/scs/commands/addcategory.xml
A pear/peardoc/trunk/ja/channels/scs/commands/addmaintainer.xml
A pear/peardoc/trunk/ja/channels/scs/commands/create.xml
A pear/peardoc/trunk/ja/channels/scs/commands/release.xml
A pear/peardoc/trunk/ja/channels/scs/commands/update.xml
A pear/peardoc/trunk/ja/channels/scs/commands.xml
A pear/peardoc/trunk/ja/channels/scs/intro.xml
A pear/peardoc/trunk/ja/channels/scs.xml
A pear/peardoc/trunk/ja/channels/whatarethey.xml
svn-diffs-291782.txt
(text/x-diff, 10.9 KB)
Added: pear/peardoc/trunk/ja/channels/scs/commands/addcategory.xml =================================================================== --- pear/peardoc/trunk/ja/channels/scs/commands/addcategory.xml (rev 0) +++ pear/peardoc/trunk/ja/channels/scs/commands/addcategory.xml 2009-12-07 00:12:31 UTC (rev 291782) @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs.commands.addcategory"> + <info><title>add-category - adds a package category</title></info> + <para> + The <literal>add-category</literal> command adds a category to the channel. + </para> + <para> + <screen> + pearscs add-cateogry category + </screen> + </para> + <para> + This command adds a category to the channel for grouping related packages. + </para> +</section> \ No newline at end of file Added: pear/peardoc/trunk/ja/channels/scs/commands/addmaintainer.xml =================================================================== --- pear/peardoc/trunk/ja/channels/scs/commands/addmaintainer.xml (rev 0) +++ pear/peardoc/trunk/ja/channels/scs/commands/addmaintainer.xml 2009-12-07 00:12:31 UTC (rev 291782) @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs.commands.addmaintainer"> + <info><title>add-maintainer - adds a maintainer</title></info> + <para> + The <literal>add-maintainer</literal> command adds a maintainer's handle + to the list of channel maintainers. + </para> + <para> + <screen> + pearscs add-maintainer handle + </screen> + </para> + <para> + This command adds the handle of a maintainer to the local channel. It is not + necessary to add maintainers before releasing a package, as they will + automatically be added or updated. + </para> +</section> \ No newline at end of file Added: pear/peardoc/trunk/ja/channels/scs/commands/create.xml =================================================================== --- pear/peardoc/trunk/ja/channels/scs/commands/create.xml (rev 0) +++ pear/peardoc/trunk/ja/channels/scs/commands/create.xml 2009-12-07 00:12:31 UTC (rev 291782) @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs.commands.create"> + <info><title>create - creates a PEAR channel</title></info> + <para> + The <literal>create</literal> command creates a PEAR channel on the + local filesystem, including the channel.xml file and the get and rest + directories. This command assumes you are currently at the web root + for the channel you wish to create, unless you pass the path to where the + channel.xml file will be created. The local root can be a subdirectory + off of your webserver, but you should be in that subdirectory when + executing this command. + </para> + <para> + <screen> + pearscs create pear.example.com summary [alias] [./channel.xml] + </screen> + </para> + <para> + Required arguments are the channel name and channel summary. + + For example pear.example.com or can also be a subdirectory such as + www.example.com/pear. + </para> + <para> + The alias is a short name which can be used to refer to your PEAR channel. + + If one is not specified, SimpleChannelServer will attempt to create one for + you. + + </para> + <para> + If the path to a channel.xml file is specified, the directory given will be + used to create the channel.xml, get, and rest directories for the channel. + If no path is specified, SimpleChannelServer will use the current directory. + </para> +</section> Added: pear/peardoc/trunk/ja/channels/scs/commands/release.xml =================================================================== --- pear/peardoc/trunk/ja/channels/scs/commands/release.xml (rev 0) +++ pear/peardoc/trunk/ja/channels/scs/commands/release.xml 2009-12-07 00:12:31 UTC (rev 291782) @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs.commands.release"> + <info><title>release - releases a PEAR package to the channel</title></info> + <para> + The <literal>release</literal> command releases a package to your PEAR + channel. + </para> + <para> + <screen> + pearscs release MyPackage-1.0.0.tgz handle + </screen> + </para> + <para> + The file must be a valid PEAR package, and can be either the package.xml + file, or a compressed and optionally signed .tgz file. + </para> + <para> + The <literal>handle</literal> attribute should be a lead maintainer for the + package, as who released this version will be stored within the channel's + xml files. + </para> +</section> Added: pear/peardoc/trunk/ja/channels/scs/commands/update.xml =================================================================== --- pear/peardoc/trunk/ja/channels/scs/commands/update.xml (rev 0) +++ pear/peardoc/trunk/ja/channels/scs/commands/update.xml 2009-12-07 00:12:31 UTC (rev 291782) @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs.commands.update"> + <info><title>update - updates the xml files for the local channel</title></info> + <para> + The <literal>update</literal> command re-generates the xml files for all + releases. + </para> + <para> + <screen> + pearscs update [./channel.xml] + </screen> + </para> + <para> + This command updates the associated xml files for all releases present in the + get directory. + </para> +</section> \ No newline at end of file Added: pear/peardoc/trunk/ja/channels/scs/commands.xml =================================================================== --- pear/peardoc/trunk/ja/channels/scs/commands.xml (rev 0) +++ pear/peardoc/trunk/ja/channels/scs/commands.xml 2009-12-07 00:12:31 UTC (rev 291782) @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section xmlns="http://docbook.org/ns/docbook" version="lillet" xmlns:phd="http://www.php.net/ns/phd" xml:id="channels.scs.commands"> + <info><title>Commands Available In PEAR2_SimpleChannelServer</title></info> + + <!-- this thing does not work whatsoever. --> + <phd:toc phd:toc-depth="3" phd:element="channels.scs.commands"/> + <simpara> + Commands available for the pearscs command-line script. + </simpara> + + &channels.scs.commands.create; + &channels.scs.commands.release; + &channels.scs.commands.update; + &channels.scs.commands.addmaintainer; + &channels.scs.commands.addcategory; +</section> Added: pear/peardoc/trunk/ja/channels/scs/intro.xml =================================================================== --- pear/peardoc/trunk/ja/channels/scs/intro.xml (rev 0) +++ pear/peardoc/trunk/ja/channels/scs/intro.xml 2009-12-07 00:12:31 UTC (rev 291782) @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="utf-8"?> +<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs.intro"> + <info><title>Introduction to PEAR2_SimpleChannelServer</title></info> + + <para> + The SimpleChannelServer package allows developers to create a + PEAR compatible channel server to distribute packages. This channel server + is simple in that it only works with the local filesystem to create the + necessary files for package distribution. + </para> + <note> + <para> + At a minimum, the ability to post files to the webspace where your channel + will be hosted. + </para> + </note> + <para> + It is possible to host your PEAR channel on webspace such as Google + Code, just use the webpath to the svn directory as your channel name, + and be sure to set the correct svn:mime-type on the xml files. + </para> + <para> + To get started, simply download the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://svn.php.net/viewvc/pear2/sandbox/SimpleChannelServer/trunk/pearscs.phar?view=co">pearscs.phar</link> + file to your local filesystem, and execute the <literal>pearscs.phar</literal> + file with the <literal>create</literal> command. Then, build the rest of + the channel using the <link linkend="channels.scs.commands">other SimpleChannelServer commands</link>. + </para> +</section> Added: pear/peardoc/trunk/ja/channels/scs.xml =================================================================== --- pear/peardoc/trunk/ja/channels/scs.xml (rev 0) +++ pear/peardoc/trunk/ja/channels/scs.xml 2009-12-07 00:12:31 UTC (rev 291782) @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.scs"> + <info> + <title>Creating your own channel with Pyrus and PEAR2_SimpleChannelServer</title> + <author><personname><firstname>Brett</firstname><surname>Bieber</surname></personname></author> + <date>2009-07-01</date> + </info> + + <para> + Documentation is a work in progress. + </para> + + &channels.scs.intro; + &channels.scs.commands; + </chapter> Added: pear/peardoc/trunk/ja/channels/whatarethey.xml =================================================================== --- pear/peardoc/trunk/ja/channels/whatarethey.xml (rev 0) +++ pear/peardoc/trunk/ja/channels/whatarethey.xml 2009-12-07 00:12:31 UTC (rev 291782) @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="channels.whatarethey"> + <info> + <title>channel.xml, REST, XML-RPC</title> + <author><personname><firstname>Gregory</firstname><surname>Beaver</surname></personname></author> + <date>2009-06-25</date> + </info> + + <para> + What is a PEAR Channel? PEAR Channels make it possible to take advantage of + the strengths of the PEAR Installer and Pyrus for your own personal packages. + A channel is simply a website that provides packages for download and a few + extra meta-information files. + </para> + <para> + A familiar example of a channel is + <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://pear.php.net">pear.php.net</link>. + This channel was the first channel, and defines the standards to which other + channels must adhere. Each channel has a <link linkend="guide.migrating.channels.xml">channel.xml</link> + file in its document root (such as <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://pear.php.net/channel.xml"> + http://pear.php.net/channel.xml</link>) and a series of files utilizing the + <literal>REST</literal> (Representational State Transfer) paradigm to describe + the packages available for installation and download. The <literal>pear.php.net</literal> + channel's <literal>REST</literal> files can be viewed at <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://pear.php.net/rest"> + http://pear.php.net/rest</link>. + </para> + + &guide.migrating.channels.xml; + &core.rest; + &guide.migrating.channels.xmlrpcfunctions; + </chapter>