From: Joshua Slive Date: Tue, 17 Jul 2001 20:20:21 +0000 (+0000) Subject: Bringing forward from 1.3: Changes to standardize the "argument types" X-Git-Tag: 2.0.21~47 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e13a4cc672d38503a82de03308644bbdc86bdad4;p=apache Bringing forward from 1.3: Changes to standardize the "argument types" in the syntax entires. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@89568 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/core.html b/docs/manual/mod/core.html index 24f83c9f1c..178e6fe5b6 100644 --- a/docs/manual/mod/core.html +++ b/docs/manual/mod/core.html @@ -432,7 +432,7 @@ with filenames missing the .gif extension.

Syntax: <Directory directory> +>Syntax: <Directory directory-path> ... </Directory>
REL="Help" >Status: Core.

-<Directory> and </Directory> are used to enclose a group of -directives which will apply only to the named directory and sub-directories -of that directory. Any directive which is allowed in a directory -context may be used. Directory is either the full path to a directory, -or a wild-card string. In a wild-card string, `?' matches any single character, -and `*' matches any sequences of characters. As of Apache 1.3, you -may also use `[]' character ranges like in the shell. Also as of Apache 1.3 -none of the wildcards match a `/' character, which more closely mimics the -behaviour of Unix shells. -Example: -

+<Directory> and </Directory> are used to enclose a group
+of directives which will apply only to the named directory and
+sub-directories of that directory. Any directive which is allowed in a
+directory context may be used. Directory-path is either the
+full path to a directory, or a wild-card string. In a wild-card
+string, `?' matches any single character, and `*' matches any
+sequences of characters.  As of Apache 1.3, you may also use `[]'
+character ranges like in the shell.  Also as of Apache 1.3 none of the
+wildcards match a `/' character, which more closely mimics the
+behaviour of Unix shells.  Example: 
    <Directory /usr/local/httpd/htdocs>
    Options Indexes FollowSymLinks
    </Directory>
@@ -601,7 +600,7 @@ different sections are combined when a request is received
 Syntax: DocumentRoot directory-filename

+>Syntax: DocumentRoot directory-path

 
 
  • output a simple hardcoded error message
 
  • output a customized message
-
  • redirect to a local URL to handle the problem/error
-
  • redirect to an external URL to handle the problem/error
+
  • redirect to a local URL-path to handle the problem/error
+
  • redirect to an external URL to handle the problem/error
 
 
 
    The first option is the default, while options 2-4 are configured
@@ -707,7 +706,7 @@ responses.
    
 Syntax: ErrorLog filename|syslog[:facility]
+>Syntax: ErrorLog file-path|syslog[:facility]
 
    
 
    
  REL="Help"
 >Status:     core
    
 
-The error log directive sets the name of the file to which the server will log
-any errors it encounters. If the filename does not begin with a slash (/)
-then it is assumed to be relative to the ServerRoot.
-If the filename begins with a pipe (|) then it is assumed to be a command to
-spawn to handle the error log.
+The error log directive sets the name of the file to which the server
+will log any errors it encounters. If the file-path does not
+begin with a slash (/) then it is assumed to be relative to the ServerRoot.  If the file-path begins
+with a pipe (|) then it is assumed to be a command to spawn to handle
+the error log.
 
 
    Apache 1.3 and above:
 Using syslog instead of a filename enables logging via syslogd(8)
@@ -1069,7 +1069,7 @@ simple multiple-module tests.
 
     
    
 
 
    Include directive
    
-Syntax: Include filename
    
+Syntax: Include file-path|directory-path
    
 
 Syntax: <Location URL>
+>Syntax: <Location URL-path|URL>
 ... </Location>
    
 Syntax: ServerPath pathname
    
+>Syntax: ServerPath directory-path
    
 name-based virtual hosts.
 Syntax: ServerRoot directory-filename
    
+>Syntax: ServerRoot directory-path
    
 emphasized.  Directives which can take a variable number of
+  arguments will end in "..." indicating that the last argument is
+  repeated.
   
    
 
+  
    
+  Directives use a great number of different argument types.
+  A few common ones are defined below.
    
+
+
     
+
+
    URL
     
+
+
    A complete Uniform Resource Locator including a scheme, hostname,
+and optional pathname as in
+http://www.example.com/path/to/file.html
    
+
+
    URL-path
    
+
+
    The part of a url which follows the scheme and hostname
+as in /path/to/file.html.  The url-path
+represents a web-view of a resource, as opposed to a file-system
+view.
    
+
+
    file-path
    
+
+
    The path to a file in the local file-system beginning with the
+root directory as in
+/usr/local/apache/htdocs/path/to/file.html.  Unless
+otherwise specified, a file-path which does not begin with a
+slash will be treated as relative to the ServerRoot.
    
+
+
    directory-path
    
+
+
    The path to a directory in the local file-system beginning with
+the root directory as in
+/usr/local/apache/htdocs/path/to/.
+
+
    filename
    
+
+
    The name of a file with no accompanying path information as in
+file.html.
    
+
+
    regex
    
+
+
    A regular expression, which
+is a way of describing a pattern to match in text.  The directive
+definition will specify what the regex is matching
+against.
    
+
+
    extension
    
+
+
    In general, this is the part of the filename which
+follows the last dot.  However, Apache recognizes multiple filename
+extensions, so if a filename contains more than one dot, each
+dot-separated part of the filename following the first dot is an
+extension.  For example, the filename
+file.html.en contains two extensions: .html
+and .en.  For Apache directives, you may specify
+extensions with or without the leading dot.  In addition,
+extensions are not case sensitive.
    
+
+
    MIME-type
    
+
+
    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 text/html.
+
+
    env-variable
    
+
+
    The name of an environment variable
+defined in the Apache configuration process.  Note this is not
+necessarily the same as an operating system environment variable.  See
+the environment variable documentation for
+more details.
    
+ 
+
    
+
   
    
   
    Default
    
   
    
@@ -103,7 +179,9 @@
   from your configuration entirely, the Apache Web server will behave as
   though you set it to a particular value), it is described here.  If
   there is no default value, this section should say
-  "None".
+  "None".  Note that the default listed here is not
+  necessarily the same as the value the directive takes in the
+  default httpd.conf distributed with the server.
   
    
 
   
    
diff --git a/docs/manual/mod/directive-dict.html.en b/docs/manual/mod/directive-dict.html.en
index 8b2f6679fb..5b82c29b60 100644
--- a/docs/manual/mod/directive-dict.html.en
+++ b/docs/manual/mod/directive-dict.html.en
@@ -87,15 +87,91 @@
   configuration file.  This syntax is extremely directive-specific, 
   and is described in detail in the directive's definition.  
   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
-  argument is repeated.
+  more space-separated arguments.  If an argument contains a space,
+  the argument must be enclosed in double quotes.  Optional arguments
+  are enclosed in square brackets.  Where an argument can take on more
+  than one possible value, the possible values are separated by
+  vertical bars "|".  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 argument is
+  repeated.
   
    
 
+  
    
+  Directives use a great number of different argument types.
+  A few common ones are defined below.
    
+
+
     
+
+
    URL
     
+
+
    A complete Uniform Resource Locator including a scheme, hostname,
+and optional pathname as in
+http://www.example.com/path/to/file.html
    
+
+
    URL-path
    
+
+
    The part of a url which follows the scheme and hostname
+as in /path/to/file.html.  The url-path
+represents a web-view of a resource, as opposed to a file-system
+view.
    
+
+
    file-path
    
+
+
    The path to a file in the local file-system beginning with the
+root directory as in
+/usr/local/apache/htdocs/path/to/file.html.  Unless
+otherwise specified, a file-path which does not begin with a
+slash will be treated as relative to the ServerRoot.
    
+
+
    directory-path
    
+
+
    The path to a directory in the local file-system beginning with
+the root directory as in
+/usr/local/apache/htdocs/path/to/.
+
+
    filename
    
+
+
    The name of a file with no accompanying path information as in
+file.html.
    
+
+
    regex
    
+
+
    A regular expression, which
+is a way of describing a pattern to match in text.  The directive
+definition will specify what the regex is matching
+against.
    
+
+
    extension
    
+
+
    In general, this is the part of the filename which
+follows the last dot.  However, Apache recognizes multiple filename
+extensions, so if a filename contains more than one dot, each
+dot-separated part of the filename following the first dot is an
+extension.  For example, the filename
+file.html.en contains two extensions: .html
+and .en.  For Apache directives, you may specify
+extensions with or without the leading dot.  In addition,
+extensions are not case sensitive.
    
+
+
    MIME-type
    
+
+
    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 text/html.
+
+
    env-variable
    
+
+
    The name of an environment variable
+defined in the Apache configuration process.  Note this is not
+necessarily the same as an operating system environment variable.  See
+the environment variable documentation for
+more details.
    
+ 
+
    
+
   
    
   
    Default
    
   
    
@@ -103,7 +179,9 @@
   from your configuration entirely, the Apache Web server will behave as
   though you set it to a particular value), it is described here.  If
   there is no default value, this section should say
-  "None".
+  "None".  Note that the default listed here is not
+  necessarily the same as the value the directive takes in the
+  default httpd.conf distributed with the server.