%-*-mode:latex-*-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Copyright (C) 1996-2004 Jason Evans <jasone@canonware.com>.
% All rights reserved.
% 
% Redistribution and use in source and binary forms, with or without
% modification, are permitted provided that the following conditions
% are met:
% 1. Redistributions of source code must retain the above copyright
%    notice(s), this list of conditions and the following disclaimer
%    unmodified other than the allowable addition of one or more
%    copyright notices.
% 2. Redistributions in binary form must reproduce the above copyright
%    notice(s), this list of conditions and the following disclaimer in
%    the documentation and/or other materials provided with the
%    distribution.
% 
% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
% EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
% PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
% BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
% WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
% OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
% EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Version: Onyx 5.1.1
%
% onyxdict reference portion of Onyx Manual.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\subsection{onyxdict}
\label{sec:onyxdict}
\index{onyxdict@\onyxop{}{onyxdict}{}}

Various portions of Onyx use the onyxdict dictionary for storage of
miscellaneous objects that normally should not be part of the namespace visible
to dstack searches.

\begin{longtable}{\optableformat{4.10}}
\caption{onyxdict summary}
\\
\hline
\optableent
	{Input(s)}
	{Op/Proc/Var}
	{Output(s)}
	{Description}
\hline \hline
%begin{latexonly}
\endfirsthead
\caption[]{\emph{continued}} \\
\hline
\optableent
	{Input(s)}
	{Op/Proc/Var}
	{Output(s)}
	{Description}
\hline \hline \endhead
\multicolumn{2}{r}{\emph{Continued on next page...}} \endfoot
\hline \endlastfoot
%end{latexonly}
\optableent
	{--}
	{{\bf \htmlref{mpath\_post}{onyxdict:mpath_post}}}
	{array}
	{Get path searched by \htmlref{mrequire}{systemdict:mrequire}.}
\hline
\optableent
	{--}
	{{\bf \htmlref{mpath\_pre}{onyxdict:mpath_pre}}}
	{array}
	{Get path searched by \htmlref{mrequire}{systemdict:mrequire}.}
\hline
\optableent
	{--}
	{{\bf \htmlref{rpath\_post}{onyxdict:rpath_post}}}
	{array}
	{Get path searched by \htmlref{require}{systemdict:require}.}
\hline
\optableent
	{--}
	{{\bf \htmlref{rpath\_pre}{onyxdict:rpath_pre}}}
	{array}
	{Get path searched by \htmlref{require}{systemdict:require}.}
\end{longtable}

\begin{description}
\label{onyxdict:mpath_post}
\index{mpath_post@\onyxop{}{mpath\_post}{}}
\item[{\onyxop{--}{mpath\_post}{array}}: ]
	\begin{description}\item[]
	\item[Input(s): ] None.
	\item[Output(s): ]
		\begin{description}\item[]
		\item[array: ]
			An array of strings.
		\end{description}
	\item[Error(s): ] None.
	\item[Description: ]
		Get an array of strings used by
		\htmlref{mrequire}{systemdict:mrequire} as prefixes for file
		searches.  The elements of the array are tried in the order
		listed.
	\item[Example(s): ]\begin{verbatim}

onyx:0> onyxdict $mpath_post get 1 sprint
[`/usr/local/share/onyx-3.0.0/nxm']
onyx:0>
		\end{verbatim}
	\end{description}
\label{onyxdict:mpath_pre}
\index{mpath_pre@\onyxop{}{mpath\_pre}{}}
\item[{\onyxop{--}{mpath\_pre}{array}}: ]
	\begin{description}\item[]
	\item[Input(s): ] None.
	\item[Output(s): ]
		\begin{description}\item[]
		\item[array: ]
			An array of strings.
		\end{description}
	\item[Error(s): ] None.
	\item[Description: ]
		Get an array of strings used by
		\htmlref{mrequire}{systemdict:mrequire} as prefixes for file
		searches.  The elements of the array are tried in the order
		listed.
	\item[Example(s): ]\begin{verbatim}

onyx:0> onyxdict $mpath_pre get 1 sprint
[`' `.']
onyx:0>
		\end{verbatim}
	\end{description}
\label{onyxdict:rpath_post}
\index{rpath_post@\onyxop{}{rpath\_post}{}}
\item[{\onyxop{--}{rpath\_post}{array}}: ]
	\begin{description}\item[]
	\item[Input(s): ] None.
	\item[Output(s): ]
		\begin{description}\item[]
		\item[array: ]
			An array of strings.
		\end{description}
	\item[Error(s): ] None.
	\item[Description: ]
		Get an array of strings used by
		\htmlref{require}{systemdict:require} as prefixes for file
		searches.  The elements of the array are tried in the order
		listed.
	\item[Example(s): ]\begin{verbatim}

onyx:0> onyxdict $rpath_post get 1 sprint
[`/usr/local/share/onyx-3.0.0/nx']
onyx:0>
		\end{verbatim}
	\end{description}
\label{onyxdict:rpath_pre}
\index{rpath_pre@\onyxop{}{rpath\_pre}{}}
\item[{\onyxop{--}{rpath\_pre}{array}}: ]
	\begin{description}\item[]
	\item[Input(s): ] None.
	\item[Output(s): ]
		\begin{description}\item[]
		\item[array: ]
			An array of strings.
		\end{description}
	\item[Error(s): ] None.
	\item[Description: ]
		Get an array of strings used by
		\htmlref{require}{systemdict:require} as prefixes for file
		searches.  The elements of the array are tried in the order
		listed.
	\item[Example(s): ]\begin{verbatim}

onyx:0> onyxdict $rpath_pre get 1 sprint
[`' `.']
onyx:0>
		\end{verbatim}
	\end{description}
\end{description}
