Permalink
Browse files

- three new reference pages

- small update to README
- cleared few todo items
  • Loading branch information...
docelic committed Mar 24, 2006
1 parent 1c35c56 commit 3c0854c6b506d8ee7f999bfe071331dcf1710740
Showing with 155 additions and 6 deletions.
  1. +6 −4 README
  2. +0 −2 TODO
  3. +37 −0 refs/Glimpse
  4. +75 −0 refs/Jobs
  5. +37 −0 refs/NonTaxableField
View
10 README
@@ -17,10 +17,12 @@ To build the complete documentation set, just run:
make cvs
make
-It's also possible to change OUTPUT/ directory to something else, named
-OUTPUT<yourstring>. However, places where I couldn't have inserted variables
-have OUTPUT/ hardcoded, so OUTPUT is made a symbolic link to the output dir
-of your choice.
+Sometimes you want to build multiple versions of documentation at once
+(for example, one online, one offline, one profiled for Debian GNU etc.).
+It is possible to change OUTPUT/ directory to something else (named
+OUTPUT<yourstring>) to achieve this effect. However, places where I
+couldn't have inserted variables have OUTPUT/ hardcoded, so OUTPUT is still
+made a symbolic link to the output dir of your choice.
Here's an example:
View
2 TODO
@@ -1,7 +1,5 @@
- in iccattut, s/item-field/item-param/ at least on some places.
- Make xmldocs tarball in ftp autoupdated
-- Fix file README, directly at the top it talks about prefixes, OUTPUT dir
- etc without introducing it first.
- Change -latest to version number in tarball download
Outstanding:
View
@@ -0,0 +1,37 @@
+__NAME__ purpose
+specify program path and options for the Glimpse search engine
+__END__
+
+
+__NAME__ see also
+__END__
+
+__NAME__ synopsis
+<group choice='req'>
+ <arg choice='plain'><replaceable>program_path</replaceable></arg>
+ <arg choice='opt' rep='repeat'><replaceable>option</replaceable></arg>
+</group>
+__END__
+
+
+__NAME__ description
+The directive specifies pathname for the <command>glimpse</command> command, used if glimpse
+searches are to be enabled.
+To use <command>glimpseserver</command>, the
+<literal>-C</literal>, <literal>-J</literal> and <literal>-K</literal> options must be
+specified.
+__END__
+
+
+__NAME__ notes
+Glimpse was once-popular search engine in the Linux world, but its non-free status and other
+things called for its replacement. We suggest you use Swish-e which is supported by
+&IC; as well.
+__END__
+
+__NAME__ example: Defining Glimpse
+<programlisting>
+Glimpse /usr/local/bin/glimpse -C -J srch_engine -K2345
+</programlisting>
+__END__
+
View
@@ -0,0 +1,75 @@
+__NAME__ purpose
+define parameters for an Interchange variant of the Unix crontab facility
+__END__
+
+__NAME__ synopsis
+ <arg choice='plain' rep='repeat'>
+ <replaceable>key</replaceable>
+ <replaceable>value</replaceable>
+ </arg>
+__END__
+
+__NAME__ see also
+__END__
+
+__NAME__ description
+</para><para>
+The directive configures Interchange periodic &glos-job;s facility. It accepts a list of key/value
+pairs, where the available keys and their descriptions are:
+<itemizedlist>
+ <listitem><para>base_directory -
+ directory to search for cron jobs. The default is
+ <filename class='directory'>CATROOT/etc/cron/</filename>
+ </para></listitem>
+ <listitem><para>use_global -
+ search for <literal>base_directory</literal> in &glos-ICROOT;
+ and include jobs from the global installation as well
+ </para></listitem>
+ <listitem><para>initialize -
+ a macro to execute once before each job
+ </para></listitem>
+ <listitem><para>autoload -
+ a macro to execute once before each job
+ </para></listitem>
+ <listitem><para>email -
+ e-mail for session reports, if any result from running jobs
+ </para></listitem>
+ <listitem><para>log -
+ logfile for session reports, if any result from running jobs
+ </para></listitem>
+ <listitem><para>add_session -
+ include the current session in the output
+ </para></listitem>
+ <listitem><para>from -
+ self-explanatory e-mail-related option
+ </para></listitem>
+ <listitem><para>subject -
+ self-explanatory e-mail-related option
+ </para></listitem>
+ <listitem><para>reply_to -
+ self-explanatory e-mail-related option
+ </para></listitem>
+ <listitem><para>extra_headers -
+ any additional headers for an e-mail message
+ </para></listitem>
+</itemizedlist>
+__END__
+
+__NAME__ notes
+__END__
+
+__NAME__ example:
+<programlisting>
+</programlisting>
+__END__
+
+__NAME__ example:
+<programlisting>
+</programlisting>
+__END__
+
+__NAME__ missing
+Diff between initialize and autoload
+Log specifies filename or just 1/0 ?
+Exactly what does add_session do
+__END__
View
@@ -0,0 +1,37 @@
+__NAME__ purpose
+specify name of the non-taxable field in the products database
+__END__
+
+
+__NAME__ missing
+__END__
+
+
+__NAME__ see also
+__END__
+
+__NAME__ synopsis
+<group choice='req'>
+ <arg choice='plain'><replaceable>field_name</replaceable></arg>
+</group>
+__END__
+
+
+__NAME__ description
+The directive specifies
+name of the field in the <database>products</database> &glos-database; that,
+set to <literal>1</literal> or <literal>Yes</literal>, sets an item as
+non-&glos-tax;able.
+</para><para>
+Interchange will log an error and tax it anyway if the field doesn't exist
+in the database.
+</para><para>
+An empty definition (the default) disables this feature.
+__END__
+
+__NAME__ example: Defining NonTaxableField
+<programlisting>
+NonTaxableField wholesale
+</programlisting>
+__END__
+

0 comments on commit 3c0854c

Please sign in to comment.