From f110632621520a3b10f23fe483eae124d58ad936 Mon Sep 17 00:00:00 2001 From: michel-schinz Date: Wed, 31 Mar 2004 19:42:35 +0000 Subject: [PATCH] - adapted to the new stand-alone distribution mode, - fixed a few references to ".scsh-pkg-defaults.scm", - fixed a few typos. --- doc/latex/proposal.tex | 41 +++++++++++++++-------------------------- 1 file changed, 15 insertions(+), 26 deletions(-) diff --git a/doc/latex/proposal.tex b/doc/latex/proposal.tex index 2c5e53b..cd36790 100644 --- a/doc/latex/proposal.tex +++ b/doc/latex/proposal.tex @@ -1,4 +1,4 @@ -%% $Id: proposal.tex,v 1.3 2004/03/21 16:21:55 michel-schinz Exp $ +%% $Id: proposal.tex,v 1.4 2004/03/31 19:42:35 michel-schinz Exp $ %% TODO %% - clean up permissions mess @@ -112,8 +112,6 @@ package are stored below it. The unpacking directory contains at least the following files: \begin{description} -\item[\file{install-pkg}] a script performing the installation of the - package, \item[\file{pkg-def.scm}] a Scheme file containing the installation procedure for the package (see §~\ref{sec:authoring-packages}), \item[\file{README}] a textual file containing a short description of @@ -180,7 +178,7 @@ Currently, the following abstract locations are defined: \item[\location{misc-shared}] Location containing miscellaneous data which does not belong to any directory above, and which is - platform-independant. + platform-independent. \end{description} The directories to which a layout maps these abstract locations are @@ -292,10 +290,10 @@ to track files belonging to a package. \subsection{Installation procedure} \label{sec:inst-proc} -Packages are installed using the \file{install-pkg} script located in -the package archive. This script must be given the name of the prefix -using the \cloption{--prefix} option. It also accepts the following -options: +Packages are installed using the \file{scsh-install-pkg} script, +which is part of the installation library. This script must be given +the name of the prefix using the \cloption{--prefix} option. It also +accepts the following options: \begin{center} \begin{tabular}{lp{.6\textwidth}} \cloption{--layout} name & Specifies the layout to use (see §~\ref{sec:predefined-layouts}). \\ @@ -304,7 +302,7 @@ options: \cloption{--inactive} & Do not activate package after installing it. \\ \cloption{--non-shared-only} & Only install platform-dependent files, if any. \\ \cloption{--force} & Overwrite existing files during installation. \\ - \cloption{--no-user-defaults} & Don't read user defaults in \file{.scsh-pkg-defaults} (see §~\ref{sec:user-preferences}). \\ + \cloption{--no-user-defaults} & Don't read user defaults in \file{.scsh-pkg-defaults.scm} (see §~\ref{sec:user-preferences}). \\ \end{tabular} \end{center} @@ -317,16 +315,16 @@ installation script by storing them in a file called file must contain exactly one Scheme expression whose value is an association list. The keys of this list, which must be symbols, identify options and the values specify the default value for these -options. The contents of this file is implicitely quasi-quoted. +options. The contents of this file is implicitly quasi-quoted. The values stored in this file override the default values of the -options, but they are in turn overriden by the values specified on the +options, but they are in turn overridden by the values specified on the command line of the installation script. Furthermore, it is possible to ask for this file to be completely ignored by passing the \cloption{--no-user-defaults} option to the installation script. \begin{example} - A \file{.scsh-pkg-defaults} file containing the following: + A \file{.scsh-pkg-defaults.scm} file containing the following: \begin{verbatim} ;; Default values for scsh packages installation ((layout . "fhs") @@ -414,21 +412,12 @@ is to write the installation script. This script could be written fully by the package author, but in order to simplify this task a small scsh installation framework is provided. -This framework is composed of several files which are meant to be -included in the package archive. These files are: -\begin{description} -\item[\file{install-pkg}] A trivial \texttt{sh} script which launches - scsh on the main function of the installation library, passing it - all the arguments given by the user. -\item[\file{install-lib.scm}] The code for the installation library, - whose public interface is documented below. -\item[\file{install-lib-module.scm}] Scheme 48 interface and structure - definitions for the installation library. -\end{description} +This framework must be present on the host system before a scsh +package can be installed. -As explained above, when the \file{install-pkg} script is invoked, it -launches scsh on the main function of the installation library, which -does the following: +As explained above, when the \file{scsh-install-pkg} script is +invoked, it launches scsh on the main function of the installation +library, which does the following: \begin{enumerate} \item parse the command line arguments (e.g the \cloption{--prefix} option),