[docs] xmldocs - docelic modified 29 files
docs at icdevgroup.org
docs at icdevgroup.org
Wed Jul 28 11:35:32 EDT 2004
User: docelic
Date: 2004-07-28 15:35:32 GMT
Added: docbook/symbol-type-skel globvar
Added: refs/CGIWRAP_WORKAROUND control description example synopsis
Added: refs/MV_BAD_LOCK control description example notes synopsis
Added: refs/MV_DOLLAR_ZERO control description example notes
Added: synopsis
Added: refs/MV_FILE control description example notes synopsis
Added: refs/MV_GETPPID_BROKEN control description example notes
Added: synopsis
Added: refs/MV_HELO control description example synopsis
Log:
- docbook/symbol-type-skel/globvar: added globvar placeholder file
(what it should contain is a proper description of global variables
purpose, please add something as I didn't really come up with a reasonable
explanation)
- refs/*/*: added elements
Revision Changes Path
1.1 xmldocs/docbook/symbol-type-skel/globvar
rev 1.1, prev_rev 1.0
Index: globvar
===================================================================
Global variables ....
1.1 xmldocs/refs/CGIWRAP_WORKAROUND/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: fix Cobalt/CGIWrap problem
# default value if applicable (make it short, just like: 0, none, ...)
default: 0
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# Describe what's missing to complete the item, if the autogenerated
# "missing" section is not enough:
missing: explain what's the actual cobalt/cgiwrap problem
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/CGIWRAP_WORKAROUND/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
Implemented to Fix Cobalt/CGIwrap problem. If set to 1, it removes the scriptname from the URL pathinfo.
1.1 xmldocs/refs/CGIWRAP_WORKAROUND/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<!-- Template example. Fill in the title (in title), short description
(in para) and actual program chunk (inside listing/cdata).
Delete those 3 lines of comments. -->
<example>
<title>
Turn on the workaround code
</title>
<para>
Add the following to <filename>interchange.cfg</filename>:
</para>
<programlisting><![CDATA[
Variable CGIWRAP_WORKAROUND 1
]]></programlisting>
</example>
1.1 xmldocs/refs/CGIWRAP_WORKAROUND/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Variable CGIWRAP_WORKAROUND <0|1>
]]></synopsis>
1.1 xmldocs/refs/MV_BAD_LOCK/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: work around a problem in systems with broken lock mechanism
# default value if applicable (make it short, just like: 0, none, ...)
default: 0
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_BAD_LOCK/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
Allow systems with broken locks to not destroy the pidfile lock
by reading the file. Alleviates inability to use
<command>interchange -stop</command>.
1.1 xmldocs/refs/MV_BAD_LOCK/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Turn around the workaround
</title>
<para>
Add the following to <filename>interchange.cfg</filename>:
</para>
<programlisting><![CDATA[
Variable MV_BAD_LOCK 1
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_BAD_LOCK/notes
rev 1.1, prev_rev 1.0
Index: notes
===================================================================
Thanks to Daniel Hutchinson for reporting this problem.
1.1 xmldocs/refs/MV_BAD_LOCK/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Variable MV_BAD_LOCK <0|1>
]]></synopsis>
1.1 xmldocs/refs/MV_DOLLAR_ZERO/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: control visual display of Interchange processes in the process list
# default value if applicable (make it short, just like: 0, none, ...)
default: interchange
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements, use this field:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_DOLLAR_ZERO/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
This determines what Interchange does to Perl's $0 variable, which contains the system's name of the running process, for example in the <citerefentry><refentrytitle>ps</refentrytitle></citerefentry> or <citerefentry><refentrytitle>top</refentrytitle></citerefentry> commands.
</para><para>
Setting the variable to a false value (0 or undefined) leaves the string unchanged. Setting it to 1 displays the process in the form of "interchange --> (CATROOT)". Setting it to a string displays that same string in the process list.
1.1 xmldocs/refs/MV_DOLLAR_ZERO/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Use the predefined value of 1 to set MV_DOLLAR_ZERO
</title>
<para>
Set the following in <filename>interchange.cfg</filename>:
</para>
<programlisting><![CDATA[
Variable MV_DOLLAR_ZERO 1
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_DOLLAR_ZERO/notes
rev 1.1, prev_rev 1.0
Index: notes
===================================================================
Note that this is set globally once only when the Interchange daemon is started, so it's pointless to change the variable after that.
</para><para>
It will also <emphasis>not</emphasis> work on BSD kernels.
1.1 xmldocs/refs/MV_DOLLAR_ZERO/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Variable MV_DOLLAR_ZERO 0
Variable MV_DOLLAR_ZERO 1
Variable MV_DOLLAR_ZERO arbitrary string
]]></synopsis>
1.1 xmldocs/refs/MV_FILE/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: contains the name of the last file read or of an external Perl routine
# default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements, use this field:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_FILE/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
This variable contains the filename of the most recently returned
contents. This variable is not set in the configuration files, but is
manipulated by the Interchange daemon while it is runnning.
1.1 xmldocs/refs/MV_FILE/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<!-- Template example. Fill in the title (in title), short description
(in para) and actual program chunk (inside listing/cdata).
Delete those 3 lines of comments. -->
<example>
<title>
Display the content of the MV_FILE variable
</title>
<para>
Add the follwing to a test Interchange page:
</para>
<programlisting><![CDATA[
The last filename is: @@MV_FILE@@
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_FILE/notes
rev 1.1, prev_rev 1.0
Index: notes
===================================================================
The variable is not intended to be written to.
1.1 xmldocs/refs/MV_FILE/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
@@MV_FILE@@
]]></synopsis>
1.1 xmldocs/refs/MV_GETPPID_BROKEN/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: fix getppid() which is broken on Linux systems with thread-enabled Perl
# default value if applicable (make it short, just like: 0, none, ...)
default: 0
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements, use this field:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_GETPPID_BROKEN/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
The variable enables a fix for broken getppid() on Linux systems with thread-enabled Perl installations. Interchange then uses syscall64 instead of the getppid call.
1.1 xmldocs/refs/MV_GETPPID_BROKEN/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Enabling MV_GETPPID_BROKEN
</title>
<para>
Add the following to <filename>interchange.cfg</filename>:
</para>
<programlisting><![CDATA[
Variable MV_GETPPID_BROKEN 1
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_GETPPID_BROKEN/notes
rev 1.1, prev_rev 1.0
Index: notes
===================================================================
Starting with Interchange 5.0, this directive is present in the default Debian GNU <filename>/etc/interchange/features.cfg</filename> file to let Interchange run on systems with threaded Perl installations.
</para><para>
Running Interchange in production on thread-enabled Perl machines is <emphasis>strongly discouraged</emphasis> (for the time being).
1.1 xmldocs/refs/MV_GETPPID_BROKEN/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Variable MV_GETPPID_BROKEN <0|1>
]]></synopsis>
1.1 xmldocs/refs/MV_HELO/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: the HELO string to send when using SMTP to send mail
# default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements, use this field:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_HELO/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
If SMTP is used to send mail, MV_HELO specifies the HELO string to present to the remote system.
1.1 xmldocs/refs/MV_HELO/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Using SMTP to send mail and setting a HELO string
</title>
<para>
Add the following to <filename>interchange.cfg</filename>:
</para>
<programlisting><![CDATA[
SendMailProgram Net::SMTP
Variable MV_HELO myhost.mydomain.com
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_HELO/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Variable MV_HELO <string>
]]></synopsis>
More information about the docs
mailing list