<commit_before>% @(#) $Id$

\section{Reference}

\subsection{Software Requirements}

Mapyrus requires:
\begin{itemize}
\item
Java 2 Runtime Environment, Standard Edition, (J2RE) v1.4 or higher,
or Java 2 Software Developers Kit, Standard Edition (J2SDK) v1.4 or higher.
\item
The Ghostscript PostScript interpreter from 
\texttt{http://www.ghostscript.com}
if creation of PDF files is required.
\end{itemize}

\subsection{Usage}

The Mapyrus software is contained in a single Java JAR file.
Start Mapyrus in a Java interpreter with the following command.

\vspace{10pt}
\texttt{java -classpath \textit{install-dir}/mapyrus.jar org.mapyrus.Mapyrus \textit{filename} \dots}
\vspace{10pt}

\textit{install-path} is the directory in which
Mapyrus is installed.  \textit{filename} is the name of a file
or a URL for Mapyrus to read from.  If \textit{filename} is \texttt{-}
then standard input is read.  If several filenames and URLs are
given then they are read in turn.

Variables passed to Mapyrus using the Java \texttt{-D} option
are available in the Mapyrus interpreter.  Other JAR files
to be used in combination with Mapyrus are included in the
\texttt{-classpath} option.

\vspace{10pt}
\texttt{java -D\textit{variable}=\textit{value} \dots\ -classpath \textit{install-dir}/mapyrus.jar:\textit{jarfile} org.mapyrus.Mapyrus \textit{filename}}
\vspace{10pt}

Mapyrus runs as an HTTP Server when started with the
\texttt{-s} option.

\vspace{10pt}
\texttt{java -classpath \textit{install-dir}/mapyrus.jar:\textit{jarfile} org.mapyrus.Mapyrus -s \textit{port} \textit{filename} \dots}
\vspace{10pt}

\subsubsection{Startup Configuration}

The variables available for configuring Mapyrus at startup are
shown in Table \ref{startupvariables}.

\begin{table}[htb]
\begin{tabular}{|l|p{7cm}|}
\hline
Variable & Description \\
\hline
\hline

\texttt{Mapyrus.rgb.file=\textit{filename}} &
Defines an X Windows color names file to use for color
name lookup in the
\texttt{color} command.  Default value is
\texttt{/usr/lib/X11/rgb.txt} \\

\hline

\texttt{java.util.logging.config.file=\textit{filename}} &
Defines file controlling logging for the
HTTP Server option.
See the Java Logging Overview
\footnote{Available from 
\texttt{http://java.sun.com/j2se/1.4/docs/guide/util/logging/overview.html}}
and Java java.util.LogManager API documentation
\footnote{Available from
\texttt{http://java.sun.com/j2se/1.4.2/docs/api/java/util/logging/LogManager.html}}
for format of the file defining logging properties.
Default logging writes only errors to error output. \\

\hline

\texttt{jdbc.drivers=\textit{class}} &
Defines class containing JDBC 1.0 (or higher) driver to load at startup.
A JDBC driver is required for connecting to a relational database and
is provided as part of a relational database.
See the Java JDBC DriverManager API documentation
\footnote{Available from
\texttt{http://java.sun.com/j2se/1.4.2/docs/api/java/sql/DriverManager.html}}
for details.
The JAR file containing the class must be included in the \texttt{-classpath}
option when starting Mapyrus. \\

\hline
\end{tabular}
\caption{Startup Variables}
\label{startupvariables}
\end{table}

\subsection{Language}

Mapyrus interprets commands read from one or more plain text files.
Each command begins on a separate line.

Any part of a line following a hash (\texttt{\#}) character that is not part of
a literal string is interpreted as a comment and is ignored.  Leading and
trailing spaces or tabs on a line are also ignored.  A backslash
(\texttt{\textbackslash}) character at the end of a line is interpreted as a
line continuation and the line and next line are joined into a single line.

A line beginning with the word \texttt{include}, followed by a filename
or URL includes commands from another file.

Each command is passed zero or more arguments separated by commas.
An argument is a number, a string literal in single quotes (\texttt{\'})
or double quotes (\texttt{\"}), a variable name, an array, an
array element or an expression.

An expression contains arguments and operators and functions
on those arguments, like in BASIC, C, or Python.
Available operators are shown in Table \ref{operators}.
Available functions are shown in Table \ref{functions}.


\begin{table}[htb]
\begin{tabular}{|l|p{7cm}|}
\hline
Operator & Description \\
\hline
\hline

\texttt{(}, \texttt{)} & parentheses \\
<commit_msg>Describe \nnn octal sequence.<commit_after>% @(#) $Id$

\section{Reference}

\subsection{Software Requirements}

Mapyrus requires:
\begin{itemize}
\item
Java 2 Runtime Environment, Standard Edition, (J2RE) v1.4 or higher,
or Java 2 Software Developers Kit, Standard Edition (J2SDK) v1.4 or higher.
\item
The Ghostscript PostScript interpreter from 
\texttt{http://www.ghostscript.com}
if creation of PDF files is required.
\end{itemize}

\subsection{Usage}

The Mapyrus software is contained in a single Java JAR file.
Start Mapyrus in a Java interpreter with the following command.

\vspace{10pt}
\texttt{java -classpath \textit{install-dir}/mapyrus.jar org.mapyrus.Mapyrus \textit{filename} \dots}
\vspace{10pt}

\textit{install-path} is the directory in which
Mapyrus is installed.  \textit{filename} is the name of a file
or a URL for Mapyrus to read from.  If \textit{filename} is \texttt{-}
then standard input is read.  If several filenames and URLs are
given then they are read in turn.

Variables passed to Mapyrus using the Java \texttt{-D} option
are available in the Mapyrus interpreter.  Other JAR files
to be used in combination with Mapyrus are included in the
\texttt{-classpath} option.

\vspace{10pt}
\texttt{java -D\textit{variable}=\textit{value} \dots\ -classpath \textit{install-dir}/mapyrus.jar:\textit{jarfile} org.mapyrus.Mapyrus \textit{filename}}
\vspace{10pt}

Mapyrus runs as an HTTP Server when started with the
\texttt{-s} option.

\vspace{10pt}
\texttt{java -classpath \textit{install-dir}/mapyrus.jar:\textit{jarfile} org.mapyrus.Mapyrus -s \textit{port} \textit{filename} \dots}
\vspace{10pt}

\subsubsection{Startup Configuration}

The variables available for configuring Mapyrus at startup are
shown in Table \ref{startupvariables}.

\begin{table}[htb]
\begin{tabular}{|l|p{7cm}|}
\hline
Variable & Description \\
\hline
\hline

\texttt{Mapyrus.rgb.file=\textit{filename}} &
Defines an X Windows color names file to use for color
name lookup in the
\texttt{color} command.  Default value is
\texttt{/usr/lib/X11/rgb.txt} \\

\hline

\texttt{java.util.logging.config.file=\textit{filename}} &
Defines file controlling logging for the
HTTP Server option.
See the Java Logging Overview
\footnote{Available from 
\texttt{http://java.sun.com/j2se/1.4/docs/guide/util/logging/overview.html}}
and Java java.util.LogManager API documentation
\footnote{Available from
\texttt{http://java.sun.com/j2se/1.4.2/docs/api/java/util/logging/LogManager.html}}
for format of the file defining logging properties.
Default logging writes only errors to error output. \\

\hline

\texttt{jdbc.drivers=\textit{class}} &
Defines class containing JDBC 1.0 (or higher) driver to load at startup.
A JDBC driver is required for connecting to a relational database and
is provided as part of a relational database.
See the Java JDBC DriverManager API documentation
\footnote{Available from
\texttt{http://java.sun.com/j2se/1.4.2/docs/api/java/sql/DriverManager.html}}
for details.
The JAR file containing the class must be included in the \texttt{-classpath}
option when starting Mapyrus. \\

\hline
\end{tabular}
\caption{Startup Variables}
\label{startupvariables}
\end{table}

\subsection{Language}

Mapyrus interprets commands read from one or more plain text files.
Each command begins on a separate line.

Any part of a line following a hash (\texttt{\#}) character that is not part of
a literal string is interpreted as a comment and is ignored.  Leading and
trailing spaces or tabs on a line are also ignored.  A backslash
(\texttt{\textbackslash}) character at the end of a line is interpreted as a
line continuation and the line and next line are joined into a single line.

A line beginning with the word \texttt{include}, followed by a filename
or URL includes commands from another file.

Each command is passed zero or more arguments separated by commas.
An argument is a number, a string literal in single quotes (\texttt{\'})
or double quotes (\texttt{\"}), a variable name, an array, an
array element or an expression.

The character sequence (\texttt{\textbackslash{}\textit{nnn}}) in
a string literal is interpreted as an octal character code (where
\texttt{\textit{nnn}} is one to three digits).

An expression contains arguments and operators and functions
on those arguments, like in BASIC, C, or Python.
Available operators are shown in Table \ref{operators}.
Available functions are shown in Table \ref{functions}.


\begin{table}[htb]
\begin{tabular}{|l|p{7cm}|}
\hline
Operator & Description \\
\hline
\hline

\texttt{(}, \texttt{)} & parentheses \\

{'fraction_non_alphanumeric': 0.09875167186803388, 'fraction_numerical': 0.008247882300490415, 'mean_word_length': 4.549165120593692, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1511748', 'n_tokens_mistral': 2724, 'n_tokens_neox': 2635, 'n_words': 1067}