[docs] xmldocs - docelic modified 10 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat May 21 08:51:30 EDT 2005
User: docelic
Date: 2005-05-21 12:51:29 GMT
Modified: refs ConfigDir DumpStructure ErrorDestination
Modified: HouseKeeping TableRestrict
Added: refs ConfDir DirConfig DumpAllCfg ExecutionLocale
Added: ExtraSecure
Log:
Fixes and new stuff
Revision Changes Path
1.2 +3 -0 xmldocs/refs/ConfigDir
rev 1.2, prev_rev 1.1
Index: ConfigDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfigDir,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ConfigDir 21 Feb 2005 01:16:51 -0000 1.1
+++ ConfigDir 21 May 2005 12:51:29 -0000 1.2
@@ -34,6 +34,9 @@
__NAME__ notes
See the &glos-configuration; glossary entry for complete information
on ⁣ config files.
+</para><para>
+Make sure you don't get confused by the existence of all
+&conf-DirConfig;, &conf-ConfDir; and &conf-ConfigDir;.
__END__
__NAME__ example: Setting ConfigDir
1.3 +3 -2 xmldocs/refs/DumpStructure
rev 1.3, prev_rev 1.2
Index: DumpStructure
===================================================================
RCS file: /var/cvs/xmldocs/refs/DumpStructure,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DumpStructure 8 Dec 2004 12:39:58 -0000 1.2
+++ DumpStructure 21 May 2005 12:51:29 -0000 1.3
@@ -5,8 +5,8 @@
__NAME__ synopsis
<group choice='req'>
- <arg choice='plain'>Yes</arg>
<arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
</group>
__END__
@@ -14,7 +14,8 @@
__NAME__ description
Instruct Interchange to dump the structure of catalogs and the Interchange server to files named <filename><replaceable>catalog_name</replaceable>.structure</filename>. Use this to see how directives have been set.
</para><para>
-The catalog structure files are dumped relative to catalog roots (CATROOTs).
+The catalog structure files are dumped relative to catalog roots
+(&glos-CATROOT;s).
__END__
__NAME__ see also
1.3 +2 -4 xmldocs/refs/ErrorDestination
rev 1.3, prev_rev 1.2
Index: ErrorDestination
===================================================================
RCS file: /var/cvs/xmldocs/refs/ErrorDestination,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ErrorDestination 20 Feb 2005 00:59:50 -0000 1.2
+++ ErrorDestination 21 May 2005 12:51:29 -0000 1.3
@@ -4,10 +4,8 @@
__NAME__ synopsis
-<group choice='req'>
- <arg choice='plain'>tag_or_message</arg>
- <arg choice='plain'>filename</arg>
-</group>
+ <arg choice='plain'><replaceable>tag_or_message</replaceable></arg>
+ <arg choice='plain'><replaceable>filename</replaceable></arg>
__END__
1.4 +3 -0 xmldocs/refs/HouseKeeping
rev 1.4, prev_rev 1.3
Index: HouseKeeping
===================================================================
RCS file: /var/cvs/xmldocs/refs/HouseKeeping,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- HouseKeeping 11 Dec 2004 23:42:45 -0000 1.3
+++ HouseKeeping 21 May 2005 12:51:29 -0000 1.4
@@ -25,3 +25,6 @@
</programlisting>
__END__
+__NAME__ see also
+HouseKeepingCron
+__END__
1.2 +0 -2 xmldocs/refs/TableRestrict
rev 1.2, prev_rev 1.1
Index: TableRestrict
===================================================================
RCS file: /var/cvs/xmldocs/refs/TableRestrict,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TableRestrict 21 May 2005 11:09:24 -0000 1.1
+++ TableRestrict 21 May 2005 12:51:29 -0000 1.2
@@ -4,12 +4,10 @@
__NAME__ synopsis
-<group choice='req'>
<arg choice='plain'><replaceable>database</replaceable></arg>
<arg choice='plain'>
<replaceable>field</replaceable><literal>=</literal><replaceable>value</replaceable>
</arg>
-</group>
__END__
1.1 xmldocs/refs/ConfDir
rev 1.1, prev_rev 1.0
Index: ConfDir
===================================================================
__NAME__ notes
Make sure you don't get confused by the existence of all
&conf-DirConfig;, &conf-ConfDir; and &conf-ConfigDir;.
__END__
1.1 xmldocs/refs/DirConfig
rev 1.1, prev_rev 1.0
Index: DirConfig
===================================================================
__NAME__ purpose
batch-set a bunch of variables (or values in general) from files
__END__
__NAME__ synopsis
<arg choice='plain'><replaceable>directive_name</replaceable></arg>
<arg choice='plain'><replaceable>directory_glob</replaceable></arg>
__END__
__NAME__ description
The directive allows you to batch-set a bunch of variables from files.
</para><para>
<literal><replaceable>directive_name</replaceable></literal> is usually
<literal>Variable</literal>, but can practically be any hash-based directive.
<literal><replaceable>directory_glob</replaceable></literal> is a filespec
that can encompass multiple directories (files are ignored).
</para><para>
The specified directories are read for file <emphasis>names</emphasis> that
contain only word characters, i.e. something that would be a valid
&conf-Variable;. (This alone might make
it unsuitable for some other uses, but picking up the junk from the
in-directory-backup-file people would be intolerable.)
Then the contents of the found files are used to set the variables (or other
values) named after file names.
</para><para>
The source file name is kept in
<varname>$Vend::Cfg->{DirConfig}{Variable}{VARNAME}</varname>,
if <pragma>dynamic_variables</pragma> &glos-pragma; is set.
<pragma>dynamic_variables</pragma> enables <emphasis>dynamic</emphasis>
updating of variables from files.
<pragma>dynamic_variables_files_only</pragma> restricts dynamic variables to
files only — otherwise variables are dynamically read from the
&conf-VariableDatabase; definition as well.
</para><para>
With dynamic variables, all
<code>@_<replaceable>VARIABLE</replaceable>_@</code> and
<code>__<replaceable>VARIABLE</replaceable>__</code> calls are checked
first to see if their source file is defined. If they are — if there is
a hash key present for the source file — even if its contents are blank,
it is returned as the value.
__END__
__NAME__ notes
Make sure you don't get confused by the existence of all
&conf-DirConfig;, &conf-ConfDir; and &conf-ConfigDir;.
__END__
__NAME__ see also
VariableDatabase
__END__
__NAME__ example: Setting DirConfig
<programlisting>
DirConfig Variable templates/foundation/regions
</programlisting>
If the file <filename>NOLEFT_TOP</filename> is present at catalog config time
at the specified location, code <code>__NOLEFT_TOP__</code> encountered on
a page will mimick
<code>[include templates/foundation/regions/NOLEFT_TOP]</code>.
__END__
1.1 xmldocs/refs/DumpAllCfg
rev 1.1, prev_rev 1.0
Index: DumpAllCfg
===================================================================
__NAME__ purpose
dump global Interchange server configuration
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
__END__
__NAME__ description
Instruct &IC; to dump the complete server configuration (with &conf-Include;s expanded) to <filename>allconfigs.cfg</filename> in the &IC; run
directory.
</para><para>
The dump file does not contain catalog configurations.
__END__
__NAME__ see also
DumpStructure
__END__
__NAME__ example: Enabling DumpAllCfg
<programlisting>
DumpAllCfg 1
</programlisting>
__END__
__NAME__ notes
&IC; "run directory" is <filename>/usr/local/interchange/etc/</filename> on
tarball installs, and <filename>/var/run/interchange</filename> on
LSB setups.
</para><para>
&conf-DumpAllCfg; was previously known as "<literal>OutputAllCfg</literal>", but
was renamed to ideologically match &conf-DumpStructure;.
__END__
1.1 xmldocs/refs/ExecutionLocale
rev 1.1, prev_rev 1.0
Index: ExecutionLocale
===================================================================
__NAME__ purpose
specify the lowest-level locale
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>locale definition</arg>
</group>
__END__
__NAME__ description
The directive specifies the "lowest-level" &glos-locale;; the one that
will be re-set on every page so that the daemon cannot even accidentally be
left with a bad locale.
__END__
__NAME__ example: Defining ExecutionLocale
Put the following in &gcf;:
<programlisting>
ExecutionLocale de_DE
</programlisting>
__END__
__NAME__ notes
&conf-ExecutionLocale; defaults to "<literal>C</literal>" and you'll probably
never want to change it. There <emphasis>is</emphasis> the need to change
locale while &IC; is
running, of course, but this is done only for critical code sections and not
for the majority of other, "locale-independent" code.
To see the list of code "groups" that require a locale adjustment, run
<command>locale</command> and <command>man locale</command> on your Unix
system.
__END__
__NAME__ see also
Locale
__END__
__NAME__ author
&mheins;
__END__
1.1 xmldocs/refs/ExtraSecure
rev 1.1, prev_rev 1.0
Index: ExtraSecure
===================================================================
__NAME__ purpose
disallow unencrypted access to pages which are listed under AlwaysSecure
__END__
__NAME__ see also
AlwaysSecure
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
__END__
__NAME__ description
Disallow access to pages which are listed under &conf-AlwaysSecure; unless
the browser is in HTTPS mode.
__END__
__NAME__ example: Enabling ExtraSecure
<programlisting>
ExtraSecure 1
</programlisting>
__END__
More information about the docs
mailing list