[GitHub] [tomcat] nightwatchcyber commented on a change in pull request #138: Expanding SSI documentation (bug # 63184)

2019-03-14 Thread GitBox
nightwatchcyber commented on a change in pull request #138: Expanding SSI 
documentation (bug # 63184)
URL: https://github.com/apache/tomcat/pull/138#discussion_r265823838
 
 

 ##
 File path: webapps/docs/ssi-howto.xml
 ##
 @@ -146,27 +146,53 @@ false.
 The directives are:
 
 
-config - !--#config timefmt=%B %Y 
--
-Used to set the format of dates and other items processed by SSI
+config - !--#config errmsg=Error 
occured sizefmt=abbrev timefmt=%B %Y --
+Used to set SSI error message, the format of dates and file sizes processed by 
SSI.
+All are optional but at least one must be used. The available options are as 
follows:
+
+errmsg - error message used for SSI errors
+sizefmt - format used for sizes in the fsize 
directive
+timefmt - format used for timestamps in the 
flastmod directive
 
 
-echo -   !--#echo var=VARIABLE_NAME 
--
+echo -   !--#echo var=VARIABLE_NAME 
encoding=entity --
 will be replaced by the value of the variable.
+
+The optional encoding parameter specifies the type of 
encoding to use.
+Valid values are entity (default), url or 
none.
+NOTE: Using an encoding other than entity can lead to 
security issues.
 
 
-exec -  Used to run commands on the host system.
+exec - !--#exec cmd=file-name 
--
+Used to run commands on the host system.
+
+
+exec - !--#exec cgi=file-name 
--
+This acts the same as the include directive, and doesn't 
actually execute any commands.
+
+
+include -  !--#include file=file-name 
--
+inserts the contents, this is interpreted relative to the current directory.
 
 
 include -  !--#include 
virtual=file-name --
-inserts the contents
+inserts the contents, this is interpreted relative to the document being 
served.
 
 
 flastmod - !--#flastmod 
file=filename.shtml --
-Returns the time that a file was lost modified.
+Returns the time that a file was lost modified, this is interpreted relative 
to the current directory.
+
+
+flastmod - !--#flastmod 
virtual=filename.shtml --
+Returns the time that a file was lost modified, this is interpreted relative 
to the document being served.
 
 
 fsize - !--#fsize file=filename.shtml 
--
-Returns the size of a file.
+Returns the size of a file, this is interpreted relative to the current 
directory.
+
+
+fsize - !--#fsize 
virtual=filename.shtml --
+Returns the size of a file, this is interpreted relative to the document being 
served.
 
 
 Review comment:
   Meaning its not a virtual path, I change the language to clarify


This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[GitHub] [tomcat] nightwatchcyber commented on a change in pull request #138: Expanding SSI documentation (bug # 63184)

2019-03-14 Thread GitBox
nightwatchcyber commented on a change in pull request #138: Expanding SSI 
documentation (bug # 63184)
URL: https://github.com/apache/tomcat/pull/138#discussion_r265823823
 
 

 ##
 File path: webapps/docs/ssi-howto.xml
 ##
 @@ -146,27 +146,53 @@ false.
 The directives are:
 
 
-config - !--#config timefmt=%B %Y 
--
-Used to set the format of dates and other items processed by SSI
+config - !--#config errmsg=Error 
occured sizefmt=abbrev timefmt=%B %Y --
+Used to set SSI error message, the format of dates and file sizes processed by 
SSI.
+All are optional but at least one must be used. The available options are as 
follows:
+
+errmsg - error message used for SSI errors
+sizefmt - format used for sizes in the fsize 
directive
+timefmt - format used for timestamps in the 
flastmod directive
 
 
-echo -   !--#echo var=VARIABLE_NAME 
--
+echo -   !--#echo var=VARIABLE_NAME 
encoding=entity --
 will be replaced by the value of the variable.
+
+The optional encoding parameter specifies the type of 
encoding to use.
+Valid values are entity (default), url or 
none.
+NOTE: Using an encoding other than entity can lead to 
security issues.
 
 
-exec -  Used to run commands on the host system.
+exec - !--#exec cmd=file-name 
--
+Used to run commands on the host system.
+
+
+exec - !--#exec cgi=file-name 
--
+This acts the same as the include directive, and doesn't 
actually execute any commands.
+
+
+include -  !--#include file=file-name 
--
+inserts the contents, this is interpreted relative to the current directory.
 
 
 include -  !--#include 
virtual=file-name --
-inserts the contents
+inserts the contents, this is interpreted relative to the document being 
served.
 
 
 flastmod - !--#flastmod 
file=filename.shtml --
-Returns the time that a file was lost modified.
+Returns the time that a file was lost modified, this is interpreted relative 
to the current directory.
+
+
+flastmod - !--#flastmod 
virtual=filename.shtml --
+Returns the time that a file was lost modified, this is interpreted relative 
to the document being served.
 
 
 fsize - !--#fsize file=filename.shtml 
--
-Returns the size of a file.
+Returns the size of a file, this is interpreted relative to the current 
directory.
+
 
 Review comment:
   Meaning its not a virtual path, I change the language to clarify


This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[GitHub] [tomcat] nightwatchcyber commented on a change in pull request #138: Expanding SSI documentation (bug # 63184)

2019-03-14 Thread GitBox
nightwatchcyber commented on a change in pull request #138: Expanding SSI 
documentation (bug # 63184)
URL: https://github.com/apache/tomcat/pull/138#discussion_r265823804
 
 

 ##
 File path: webapps/docs/ssi-howto.xml
 ##
 @@ -146,27 +146,53 @@ false.
 The directives are:
 
 
-config - !--#config timefmt=%B %Y 
--
-Used to set the format of dates and other items processed by SSI
+config - !--#config errmsg=Error 
occured sizefmt=abbrev timefmt=%B %Y --
+Used to set SSI error message, the format of dates and file sizes processed by 
SSI.
+All are optional but at least one must be used. The available options are as 
follows:
+
+errmsg - error message used for SSI errors
+sizefmt - format used for sizes in the fsize 
directive
+timefmt - format used for timestamps in the 
flastmod directive
 
 
-echo -   !--#echo var=VARIABLE_NAME 
--
+echo -   !--#echo var=VARIABLE_NAME 
encoding=entity --
 will be replaced by the value of the variable.
+
+The optional encoding parameter specifies the type of 
encoding to use.
+Valid values are entity (default), url or 
none.
+NOTE: Using an encoding other than entity can lead to 
security issues.
 
 
-exec -  Used to run commands on the host system.
+exec - !--#exec cmd=file-name 
--
+Used to run commands on the host system.
+
+
+exec - !--#exec cgi=file-name 
--
+This acts the same as the include directive, and doesn't 
actually execute any commands.
+
+
+include -  !--#include file=file-name 
--
+inserts the contents, this is interpreted relative to the current directory.
 
 
 include -  !--#include 
virtual=file-name --
-inserts the contents
+inserts the contents, this is interpreted relative to the document being 
served.
 
 
 flastmod - !--#flastmod 
file=filename.shtml --
-Returns the time that a file was lost modified.
+Returns the time that a file was lost modified, this is interpreted relative 
to the current directory.
+
 
 Review comment:
   Meaning its not a virtual path, I change the language to clarify


This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[GitHub] [tomcat] nightwatchcyber commented on a change in pull request #138: Expanding SSI documentation (bug # 63184)

2019-03-14 Thread GitBox
nightwatchcyber commented on a change in pull request #138: Expanding SSI 
documentation (bug # 63184)
URL: https://github.com/apache/tomcat/pull/138#discussion_r265823744
 
 

 ##
 File path: webapps/docs/ssi-howto.xml
 ##
 @@ -146,27 +146,53 @@ false.
 The directives are:
 
 
-config - !--#config timefmt=%B %Y 
--
-Used to set the format of dates and other items processed by SSI
+config - !--#config errmsg=Error 
occured sizefmt=abbrev timefmt=%B %Y --
+Used to set SSI error message, the format of dates and file sizes processed by 
SSI.
+All are optional but at least one must be used. The available options are as 
follows:
+
+errmsg - error message used for SSI errors
+sizefmt - format used for sizes in the fsize 
directive
+timefmt - format used for timestamps in the 
flastmod directive
 
 
-echo -   !--#echo var=VARIABLE_NAME 
--
+echo -   !--#echo var=VARIABLE_NAME 
encoding=entity --
 will be replaced by the value of the variable.
+
+The optional encoding parameter specifies the type of 
encoding to use.
+Valid values are entity (default), url or 
none.
+NOTE: Using an encoding other than entity can lead to 
security issues.
 
 
-exec -  Used to run commands on the host system.
+exec - !--#exec cmd=file-name 
--
+Used to run commands on the host system.
+
+
+exec - !--#exec cgi=file-name 
--
+This acts the same as the include directive, and doesn't 
actually execute any commands.
+
+
+include -  !--#include file=file-name 
--
+inserts the contents, this is interpreted relative to the current directory.
 
 
 include -  !--#include 
virtual=file-name --
-inserts the contents
+inserts the contents, this is interpreted relative to the document being 
served.
 
 
 flastmod - !--#flastmod 
file=filename.shtml --
-Returns the time that a file was lost modified.
+Returns the time that a file was lost modified, this is interpreted relative 
to the current directory.
+
+
+flastmod - !--#flastmod 
virtual=filename.shtml --
+Returns the time that a file was lost modified, this is interpreted relative 
to the document being served.
 
 
 Review comment:
   fixed


This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org