Skip to content

Commit

Permalink
Commit v4.beta1
Browse files Browse the repository at this point in the history
  • Loading branch information
gap committed Jul 18, 1997
1 parent 6c7882b commit 9f78d7c
Show file tree
Hide file tree
Showing 147 changed files with 26,535 additions and 8,574 deletions.
63 changes: 63 additions & 0 deletions bin/gap.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
#!/bin/sh
#############################################################################
##
## gap.sh GAP Martin Schoenert
##
## This is a shell script for the UNIX operating system that starts GAP.
## This is the place where you make all the necessary customizations.
## Then copy this file to a directory in your search path, e.g., '~/bin'.
## If you later move GAP to another location you must only change this file.
##


#############################################################################
##
## GAP_DIR . . . . . . . . . . . . . . . . . . . . directory where GAP lives
##
## Set 'GAP_DIR' to the name of the directory where you have installed GAP,
## i.e., the directory with the subdirectories 'lib', 'grp', 'doc', etc.
## The default is '/usr/local/lib/gap3r4p4', which is a standard location.
## You have to change this unless you have installed GAP in this location.
##
if [ "x$GAP_DIR" = "x" ]; then
GAP_DIR=/usr/local/lib/gap4beta
fi


#############################################################################
##
## GAP_MEM . . . . . . . . . . . . . . . . . . . amount of initial workspace
##
## Set 'GAP_MEM' to the amount of memory GAP shall use as initial workspace.
## The default is 8 MByte, which is the minimal reasonable amount of memory.
## You have to change it if you want GAP to use a larger initial workspace.
## If you are not going to run GAP in parallel with other programs you may
## want to set this value close to the amount of memory your computer has.
##
if [ "x$GAP_MEM" = "x" ]; then
GAP_MEM=8m
fi


#############################################################################
##
## GAP_PRG . . . . . . . . . . . . . . . . . name of the executable program
##
## Set 'GAP_PRG' to the name of the executable program of the GAP kernel.
## The default is '`hostname'/gap'. You can either change this to
## '<target>/gap' where <target> is the target you have selected during the
## compilation or create a symbolic link from <target> to '`hostname`' in
## the 'bin' directory.
##
if [ "x$GAP_PRG" = "x" ]; then
GAP_PRG=`hostname`/gap
fi


#############################################################################
##
## GAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . run GAP
##
## You probably should not change this line, which finally starts GAP.
##
exec $GAP_DIR/bin/$GAP_PRG -m $GAP_MEM -l $GAP_DIR $*
187 changes: 138 additions & 49 deletions doc/ext/document.tex
View file
Original file line number Diff line number Diff line change
@@ -1,61 +1,140 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%W document.tex GAP documentation Frank Celler
%%
%H @(#)$Id$
%%
%Y Copyright 1997, Lehrstuhl D fuer Mathematik, RWTH Aachen, Germany
%%
%% This file describes the manual format.
%%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\Chapter{Manual Format}

This chapter describes the manual format used to produces the {\GAP}
manual and the on-line help. The {\TeX} source of the manual is also
used to generated the on-line help. Therefore some restriction apply to
the {\TeX} macros one can use. These restriction are described in
This chapter describes the manual format used to produces the {\GAP}
manual and the on-line help. The {\TeX} source of the manual is also
used to generated the on-line help. Therefore some restriction apply to
the {\TeX} macros one should use. These restriction are described in
sections "TeX Macros" and "Examples, Lists, and Verbatim".

The first sections "Manual Files" and "Chapters and Sections" describe
the general layout of the files in case you need to write your own
package documentation.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\Section{Manual Files}

`\\TitlePage''
`\\TableOfContents'
`\\FrontMatters'
`\\Chapters'
`\\Input'
`\\Appendices'
`\\Index'
The main {\TeX} is called ``manual.tex''. This file should contain only
the following commands:

\begintt
\input ../gapmacro.tex
\BeginningOfBook{name-of-book}
\UseReferences{book1}
...
\UseReferences{bookn}
\TitlePage{title}
\TableOfContents
\FrontMatter
\Input{file1}
...
\Input{filen}
\Chapters
\Input{file1}
...
\Input{filen}
\Appendices
\Input{file1}
...
\Input{filen}
\Answers
\Bibliography
\Index
\EndOfBook
\endtt

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\Section{Chapters and Sections}
The first line inputs the file ``gapmacro.tex''. If you are writing a
share package either copy this file or use a relative path. The former
method will always work but requires you to keep the file consistent with
the system while the latter forces users to change the ``manual.tex''
file if they are installing a package in a private location. See also
Section "ref:GAP Root Directory" in the reference manual.

The command `\\Chapter\{<chaptername>\}' starts a new chapter named
<chaptername>, a chapter beginns with an introduction to the chapter and
is followed be sections created with the `\\Section\{<secname>\}'
command. The strings <chaptername> and <secname> are automatically
available as references.
`\\BeginningOfBook' starts the book, `name-of-book' is used for
cross-references, see "Labels and References". If you are writing a
share package use the name of your package here.

If your manual consists of more then one book the command
`\\UseReferences' can be used to load the labels of the other books in
case cross-references occur. `booki' is the path of the directory
containing the book whose references you want to load. If you are
writing a share package and you need to reference the main {\GAP} manual,
use `\\UseReferences' for each book you want to reference. However, as
said above this requires changes to the ``manual.tex'' file if the
package is not installed in the standard location.

*Example*

If your ``manual.tex'' lives in ``pkg/qwer/doc'' and you want to use
references to the tutorial use

\begintt
\UseReferences{../../../doc/tut}
\endtt

`\\TitlePage' produces a page containing the `title'.

`\\TableOfContents' produces a table of contents.

\\Section{<secname>}\null
`\\FrontMatter' starts the front matter chapters like a copyright notice
or a preface.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \Chapter{title}\par \Section{title}\par
make chapter or section title. Automatically generates table of
% contents, a label and an index entry. \Section{...}\null
inhibits labels and indexing.
% \FrontMatter, \Chapters, \Appendices parts of the book
% \Bibliography, \TableOfContents make these chapters automatically
% \Index make index without chapter head
`\\Chapters' starts the chapters of the manual, which are included via
`\\Input'. For the chapter format see Section "Chapters and Sections".

% \>function( arguments )!{ index subentry }
% \>`a binop b'{binary operation}!{ index subentry }
make a heading for a subsection explaining a function or a binary
operation. This automatically generates a label and an index entry
(with optional subentry).
% \){\fmark ...}
the same without label and index entry. \fmark is the triangle.
`\\Appendices' starts the appendices. `\\Answers' produces an answers
chapter, see "Excersises and Answers". `\\Bibliography' produces a
bibliography, and `\\Index' an index.

These last three probably won't occur in the tutorial.
Finally `\\EndOfBook' closes the book.

*Example*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Assume you have a share package ``qwert'' with two chapters ``Qwert'' and
``Extending Qwert'', a copyright notice, a preface, no exercises, then
your ``manual.tex'' would basically like:

\begintt
\input gapmacro.tex
\BeginningOfBook{qwert}
\TitlePage{
\centerline{\titlefont The Share Package ``qwert''}
\centerline{\secfont by}
\centerline{\titlefont Q. Mustermensch}
}
\FrontMatter
\TableOfContents
\Input{copyrght}
\Input{preface}
\Chapters
\Input{qwert}
\Input{extend}
\Appendices
\Index
\EndOfBook
\endtt

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\Section{Chapters and Sections}

The command `\\Chapter\{<chaptername>\}' starts a new chapter named
<chaptername>, a chapter begins with an introduction to the chapter and
is followed be sections created with the `\\Section\{<secname>\}'
command. The strings <chaptername> and <secname> are automatically
available as references.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\Section{TeX Macros}

As the manual pages are also used as on-line help and are automatically
Expand All @@ -79,11 +158,11 @@

`\<text>' &
sets the text in italics. This can also be used inside `\$...\$' and
`{`...'}'. Use `\<' to get a less than sign. `\<text>' is used to
denote a variable which is a argument of a function, a typically
application is the description of a function.
`{`...'}'. Use `\\\<' to get a less than sign. `\<text>' is used to
denote a variable which is an argument of a function, a typical
application is the description of a function:
\begintt
Group( <U> )
\>Group( <U> )
The function `Group' constructs a group $G$ isomorphic to <U>.
\endtt

Expand All @@ -101,21 +180,27 @@

`"ref"' &
produces a reference to a label. References are generated by the
`\\Chapter', `\\Section', *@WHAT ELSE@* commands.
`\\Chapter', `\\Section', see "Labels and References".

`\\index\{...\}' &
defines an index entry. Index entries are also used for the section
index `tutorial.six' used by the on-line help.
index ``tutorial.six'' used by the on-line help.

`\\GAP' &
`\{\\GAP\}' &
typesets {\GAP}.

`\\>' &
*@explaination missing@*

`\\)' &
*@explaination missing@*

\enditems

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\Section{Examples, Lists, and Verbatim}

In order to produces a list of items with descriptions use the
In order to produce a list of items with descriptions use the
`\\beginitems', `\\enditems' environment.

For examples, the following list describes `base', `knownBase', and
Expand Down Expand Up @@ -171,7 +256,7 @@
Other non-{\GAP} examples are typeset using the `\\begintt', `\\endtt'
environment.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\Section{Using TeX macros}

As described in "TeX Macros" the use of macros should be restricted to
Expand All @@ -180,5 +265,9 @@
lattice. In this case you should provide an alternative for the on-line
help.

*@WHAT IS EXACT SYNTAX?@*
*@NOT SUPPORTED YET@*


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%E document.tex . . . . . . . . . . . . . . . . . . . . . . . ends here
16 changes: 16 additions & 0 deletions doc/ext/manual.mst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
preamble ""
postamble "\n"
group_skip "\n"
headings_flag 1
heading_prefix "\\letter "
numhead_positive "{}"
symhead_positive "{}"
item_0 "\n "
item_1 "\n \\sub "
item_01 "\n \\sub "
item_x1 ", "
item_2 "\n \\subsub "
item_12 "\n \\subsub "
item_x2 ", "
page_compositor "--"
line_max 1000
Loading

0 comments on commit 9f78d7c

Please sign in to comment.