You are viewing a plain text version of this content. The canonical link for it is here.
Posted to mod_ftp-commits@incubator.apache.org by sc...@apache.org on 2006/11/14 17:11:54 UTC
svn commit: r474873 [3/3] - in /incubator/mod_ftp/trunk/docs/manual: ./
CovalentFTP.pdf ftp/ ftp/index.html.en ftp/index.xml ftp/index.xml.meta
mod/ mod/mod_ftp.xml mod/mod_ftp.xml.meta
Added: incubator/mod_ftp/trunk/docs/manual/ftp/index.html.en
URL: http://svn.apache.org/viewvc/incubator/mod_ftp/trunk/docs/manual/ftp/index.html.en?view=auto&rev=474873
==============================================================================
--- incubator/mod_ftp/trunk/docs/manual/ftp/index.html.en (added)
+++ incubator/mod_ftp/trunk/docs/manual/ftp/index.html.en Tue Nov 14 09:11:53 2006
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!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" lang="en" xml:lang="en"><head><!--
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ -->
+<title>Apache FTP Protocol Support - Apache HTTP Server</title>
+<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
+<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
+<link href="../images/favicon.ico" rel="shortcut icon" /></head>
+<body id="manual-page"><div id="page-header">
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.3</p>
+<img alt="" src="../images/feather.gif" /></div>
+<div class="up"><a href="../"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.3</a></div><div id="page-content"><div id="preamble"><h1>Apache FTP Protocol Support</h1>
+<div class="toplang">
+<p><span>Available Languages: </span><a href="../en/ftp/" title="English"> en </a></p>
+</div>
+
+<p>This is the FTP Protocol Module</p>
+</div>
+<div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#documentation">Documentation</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#mod-ftp">mod_ftp</a></li>
+</ul></div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="documentation" id="documentation">Documentation</a></h2>
+<p>This section will have a table of contents to the documentation
+files in this directory</p>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="mod-ftp" id="mod-ftp">mod_ftp</a></h2>
+<p>Extensive documentation on the directives provided by this module
+can be found in the <a href="../mod/mod_ftp.html">mod_ftp reference
+documentation</a>.
+</p>
+</div></div>
+<div class="bottomlang">
+<p><span>Available Languages: </span><a href="../en/ftp/" title="English"> en </a></p>
+</div><div id="footer">
+<p class="apache">Copyright 2006 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
+</body></html>
\ No newline at end of file
Added: incubator/mod_ftp/trunk/docs/manual/ftp/index.xml
URL: http://svn.apache.org/viewvc/incubator/mod_ftp/trunk/docs/manual/ftp/index.xml?view=auto&rev=474873
==============================================================================
--- incubator/mod_ftp/trunk/docs/manual/ftp/index.xml (added)
+++ incubator/mod_ftp/trunk/docs/manual/ftp/index.xml Tue Nov 14 09:11:53 2006
@@ -0,0 +1,50 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 420990 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!--
+ Original Copyright (c) Covalent Technologies 2001-2005
+
+ FTP Protocol module for Apache 2.0
+-->
+
+<manualpage metafile="index.xml.meta">
+<parentdocument href="../"/>
+
+<title>Apache FTP Protocol Support</title>
+
+<summary>
+<p>This is the FTP Protocol Module</p>
+</summary>
+
+<section id="documentation"><title>Documentation</title>
+<p>This section will have a table of contents to the documentation
+files in this directory</p>
+</section>
+
+<section id="mod-ftp"><title>mod_ftp</title>
+<p>Extensive documentation on the directives provided by this module
+can be found in the <a href="../mod/mod_ftp.html">mod_ftp reference
+documentation</a>.
+</p>
+</section>
+
+</manualpage>
Added: incubator/mod_ftp/trunk/docs/manual/ftp/index.xml.meta
URL: http://svn.apache.org/viewvc/incubator/mod_ftp/trunk/docs/manual/ftp/index.xml.meta?view=auto&rev=474873
==============================================================================
--- incubator/mod_ftp/trunk/docs/manual/ftp/index.xml.meta (added)
+++ incubator/mod_ftp/trunk/docs/manual/ftp/index.xml.meta Tue Nov 14 09:11:53 2006
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<metafile>
+ <basename>index</basename>
+ <path>/ftp/</path>
+ <relpath>..</relpath>
+
+ <variants>
+ <variant>en</variant>
+ </variants>
+</metafile>
Added: incubator/mod_ftp/trunk/docs/manual/mod/mod_ftp.xml
URL: http://svn.apache.org/viewvc/incubator/mod_ftp/trunk/docs/manual/mod/mod_ftp.xml?view=auto&rev=474873
==============================================================================
--- incubator/mod_ftp/trunk/docs/manual/mod/mod_ftp.xml (added)
+++ incubator/mod_ftp/trunk/docs/manual/mod/mod_ftp.xml Tue Nov 14 09:11:53 2006
@@ -0,0 +1,186 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!--
+ Original Copyright (c) Covalent Technologies 2001-2005
+
+ FTP Protocol module for Apache 2.0
+-->
+
+<!--<modulesynopsis> is the root tag and must surround all other tags.
+The sequence of tags is important and must be followed in order for
+the document to validate. -->
+<modulesynopsis>
+
+<!-- module name in lower case; must be identical to base filename -->
+<name>mod_template</name>
+
+<!-- A very short (less than one sentence) description of the
+module; begins with a capital, but does not end with a period, nor
+does it refer to "this module" -->
+<description>Demonstrates the module documentation format</description>
+
+<!-- From:
+http://httpd.apache.org/docs-2.0/mod/module-dict.html#Status -->
+<status>experimental</status>
+
+<!-- As in:
+http://httpd.apache.org/docs-2.0/mod/module-dict.html#SourceFile -->
+<sourcefile>mod_template.c</sourcefile>
+
+<!-- As in:
+http://httpd.apache.org/docs-2.0/mod/module-dict.html#ModuleIdentifier -->
+<identifier>template_module</identifier>
+
+<!-- Optional: as in:
+http://httpd.apache.org/docs-2.0/mod/module-dict.html#Compatibility -->
+<compatibility>Not actually available in any version</compatibility>
+
+
+<summary>
+<!-- Optional but strongly recommended: A one to three paragraph
+summary of what the module does and how to use it. Text cannot be
+placed directly, but rather must be inside paragraphs, examples,
+notes, etc. -->
+
+<p>This is a template and demonstration of the proper documentation format
+for Apache HTTP Server modules.</p>
+
+<example><title>Example</title>
+# Examples are always helpful.<br />
+TemplateDirective On<br />
+</example>
+
+<note type="warning">
+Don't try to actually use this module, since it doesn't exist.
+</note>
+
+</summary>
+
+<!-- References to other documents or directives -->
+<seealso><a href="...">Useful document</a></seealso>
+<seealso><directive module="mod_useful">Useful</directive></seealso>
+<seealso><module>mod_useful</module></seealso>
+
+<!-- Any number of sections may be included below -->
+<section id="moredocs"><title>Additional Documentation</title>
+
+<p>More detailed information about the module in general (as opposed to
+the individual directives) can follow in sections containing titles.</p>
+
+<p>The <code>id</code> attribute will be translated into a hypertext
+anchor target.</p>
+
+<p>References to directives should use the directive tag: <directive
+module="mod_template">TemplateDirective</directive>. References to
+modules should use the module tag
+<module>mod_template.xml</module>.</p>
+
+</section>
+
+
+<directivesynopsis>
+<!-- Exact name of directive in mixed case -->
+<name>TemplateDirective</name>
+
+<!-- A very short (less than one sentence) description of the
+directive; begins with a capital, but does not end with a period -->
+<description>Changes absolutely nothing</description>
+
+<!-- As in:
+http://httpd.apache.org/docs-2.0/mod/directive-dict.html#Syntax -->
+<syntax>TemplateDirective One|Two|Thee <em>file-path</em>
+[<em>env-variable</em>] [<em>env-variable</em>] ...</syntax>
+
+<!-- Optional: Plain text only, exactly as the dirctive would appear in
+the config file, as in:
+http://httpd.apache.org/docs-2.0/mod/directive-dict.html#Default -->
+<default>TemplateDirective Two /usr/local/apache</default>
+
+<!-- Each context as in:
+http://httpd.apache.org/docs-2.0/mod/directive-dict.html#Context
+is placed in a separate context tag -->
+<contextlist><context>Directory</context><context>.htaccess</context>
+</contextlist>
+
+<!-- Required if and only if the contextlist includes .htacccess, as in
+http://httpd.apache.org/docs-2.0/mod/directive-dict.html#Override -->
+<override>FileInfo</override>
+
+<!-- Used only if the same directive is implemented by multiple modules.
+Otherwise, the module will be automatically be grabbed from above. -->
+<modulelist><module>mod_template</module>
+<module>mod_othermodule</module>
+</modulelist>
+
+<!-- Used only if the status for the directive differs from the status
+for the module as a whole. As in:
+http://httpd.apache.org/docs-2.0/mod/directive-dict.html#Status -->
+<status>Experimental</status>
+
+<!-- Optional, as in:
+http://httpd.apache.org/docs-2.0/mod/directive-dict.html#Compatibility -->
+<compatibility>Does not really exist</compatibility>
+
+<!-- Detailed description of what the directive does and how to use it -->
+<usage>
+
+<p>Only the block tags p, example, note, blockquote, ul, and ol can be
+used directly under usage. The pre tag is also allowed, but its use
+is discourage. Inside a paragraph, the tags em, strong, a, code,
+directive, module, and br are allowed.</p>
+
+<p>The directive tag (when the module attribute is given) and the
+module tag automatically create links. For "section" directives like
+<Directory>, a special format is used: <directive module="core"
+type="section">Directory</directive>. The angle brackets will be
+added automatically for display.</p>
+
+<p>The example and note tag have optional <title>s. The note
+tag also has a "type" attribute that can be set to "warning".</p>
+
+<p>All content must be well-formed xml. This means closing tags must
+be used in the correct places, and unclosed tags must be written as such:
+<br />.</p>
+</usage>
+
+<!-- Any number of seealso references can be used for each directive -->
+<seealso><directive module="template.xml">Location</directive></seealso>
+</directivesynopsis>
+
+<!-- If a directive from this module is documented in another module,
+then a special format of the directivesynopsis tag can be used to
+reference it. -->
+<directivesynopsis location="othermodule">
+<name>OtherDirective</name>
+</directivesynopsis>
+
+<!-- If the directive marks a "section" like Directory, Location, etc,
+another special format is used -->
+<directivesynopsis type="section">
+<!-- The angle brackets are *not* included in the name. They will be
+added automatically for display -->
+<name>Location</name>
+<!-- Continue as before -->
+</directivesynopsis>
+
+</modulesynopsis>
+
Added: incubator/mod_ftp/trunk/docs/manual/mod/mod_ftp.xml.meta
URL: http://svn.apache.org/viewvc/incubator/mod_ftp/trunk/docs/manual/mod/mod_ftp.xml.meta?view=auto&rev=474873
==============================================================================
--- incubator/mod_ftp/trunk/docs/manual/mod/mod_ftp.xml.meta (added)
+++ incubator/mod_ftp/trunk/docs/manual/mod/mod_ftp.xml.meta Tue Nov 14 09:11:53 2006
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<metafile>
+ <basename>mod_ftp</basename>
+ <path>/mod/</path>
+ <relpath>..</relpath>
+
+ <variants>
+ <variant>en</variant>
+ </variants>
+</metafile>