httpd-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Joshua Slive <jos...@slive.ca>
Subject Re: pathnames in directives
Date Thu, 21 Jun 2001 23:32:54 GMT
Following on Chris' comments, here is a patch to directive-dict.html

This wasn't much work, but changing all the docs to use this consistently
would be a chunk, so I would appreciate some feedback on this in advance.
Are these argument-types clear?  What others should there be?  Is this a
good idea?

Joshua.


Index: directive-dict.html.en
===================================================================
RCS file:
/home/cvs/httpd-docs-1.3/htdocs/manual/mod/directive-dict.html.en,v
retrieving revision 1.4
diff -u -d -b -r1.4 directive-dict.html.en
--- directive-dict.html.en      2000/12/06 05:12:12     1.4
+++ directive-dict.html.en      2001/06/21 23:28:48
@@ -89,12 +89,83 @@
   Generally, the directive name is followed by a series of one or
   more arguments.  Optional arguments are enclosed in square brackets.
   Where an argument can take on more than one possible value, possible
-  values are separated by a vertical bar.  Literal text is presented
-  in the default font, while argument-types for which substitution
-  is necessary are emphasized.  Directives which can take a variable
-  number of arguments will end in "..." indicating that the last
+  values are separated by a vertical bar "|".  Literal text is
+  presented in the default font, while argument-types for which substitution
+  is necessary are <em>emphasized</em>.  Directives which can take a
+  variable number of arguments will end in "..." indicating that the last
   argument is repeated.
   </P>
+
+  <P>
+  Although directives use a great number of different argument types,
+  a few common ones are defined below.</p>
+
+<dl>
+
+<dt><em>url</em></dt>
+
+<dd>A complete Uniform Resource Locator including a scheme, hostname,
+and optional pathname as in
+<code>http://www.example.com/path/to/file.html</code></dd>
+
+<dt><em>url-path</em><dt>
+
+<dd>The part of a <em>url</em> which follows the scheme and hostname as
+in <code>/path/to/file.html</code>.  The <em>url-path</em> represents
+a web-view of a resource, as opposed to a file-system view.</dd>
+
+<dt><em>file-path</em></dt>
+
+<dd>The path to a file in the local file-system beginning with the root
+directory as in
+<code>/usr/local/apache/htdocs/path/to/file.html</code>.
+Unless otherwise specified, a <em>file-path</em> which does not
+begin with a slash will be treated as relative to the
+<a href="core.html#serverroot">ServerRoot</a>.</dd>
+
+
+<dt><em>directory-path</em></dt>
+
+<dd>The path to a directory in the local file-system beginning with
+the root directory as in
+<code>/usr/local/apache/htdocs/path/to/</code>.
+
+<dt><em>filename</em></dt>
+
+<dd>The name of a file with no accompanying path information as in
+<code>file.html</code>.</dd>
+
+<dt><em>regex</em></dt>
+
+<dd>A <a href="../misc/FAQ.html#regex">regular expression</a>, which
+is a way of describing a pattern to match in text.  The directive
+must specify what the <em>regex</em> is matching against.</dd>
+
+<dt><em>extension</em></dt>
+
+<dd>A part of a <em>filename</em> which follows the first dot, and is
+separated from other <em>extension</em>s by a dot as in
+<code>.html</code>.  A <em>filename</em> such as
+<code>file.html.en</code> has two <em>extension</em>s:
+<code>.html</code> and <code>.en</code>.  For Apache directives,
you
+may specify <em>extension</em>s with or without the leading dot.  In
+addition, <em>extension</em>s are not case sensitive.</dd>
+
+<dt><em>mime-type</em></dt>
+
+<dd>A method of describing the format of a file which consists of a
+major format type and a minor format type, separated by a slash
+as in <code>text/html</code>.
+
+<dt><em>env-variable</em></dt>
+
+<dd>The name of an <a href="../env.html">environment variable</a>
+defined in the Apache configuration process.  Note this is not
+necessarily the same as an operating system environment variable.</dd>
+
+
+
+</dl>





---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Mime
View raw message