diff options
Diffstat (limited to 'system/doc/installation_guide')
| -rw-r--r-- | system/doc/installation_guide/Makefile | 100 | ||||
| -rw-r--r-- | system/doc/installation_guide/book.xml | 43 | ||||
| -rw-r--r-- | system/doc/installation_guide/install.xml | 148 | ||||
| -rw-r--r-- | system/doc/installation_guide/make.dep | 13 | ||||
| -rw-r--r-- | system/doc/installation_guide/note.gif | bin | 0 -> 1539 bytes | |||
| -rw-r--r-- | system/doc/installation_guide/part.xml | 37 | ||||
| -rw-r--r-- | system/doc/installation_guide/verification.xml | 102 | ||||
| -rw-r--r-- | system/doc/installation_guide/warning.gif | bin | 0 -> 1498 bytes | |||
| -rw-r--r-- | system/doc/installation_guide/xmlfiles.mk | 21 |
9 files changed, 464 insertions, 0 deletions
diff --git a/system/doc/installation_guide/Makefile b/system/doc/installation_guide/Makefile new file mode 100644 index 0000000000..c51f0ee5f3 --- /dev/null +++ b/system/doc/installation_guide/Makefile @@ -0,0 +1,100 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 1996-2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include $(ERL_TOP)/erts/vsn.mk +#VSN=$(SYSTEM_VSN) + +APPLICATION=otp-system-documentation +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/doc/installation_guide + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- +XML_PART_FILES = part.xml + +include xmlfiles.mk + +XML_CHAPTER_FILES=$(INST_GUIDE_CHAPTER_FILES) + +TOPDOCDIR=.. + +BOOK_FILES = book.xml + +GIF_FILES = + +PS_FILES = + +XML_FILES = \ + $(BOOK_FILES) $(XML_CHAPTER_FILES) \ + $(XML_PART_FILES) + +# ---------------------------------------------------- + +HTML_FILES = \ + $(XML_PART_FILES:%.xml=%.html) + +HTMLDIR = ../html/installation_guide + +HTML_UG_FILE = $(HTMLDIR)/users_guide.html + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- +XML_FLAGS += +DVIPS_FLAGS += + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +docs: html + +local_docs: PDFDIR=../../pdf + +html: $(GIF_FILES) $(HTML_UG_FILE) + +debug opt: + +clean clean_docs: + rm -rf $(HTMLDIR) + rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) + rm -f errs core *~ + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR) + $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html \ + $(RELSYSDIR) + +release_spec: + + diff --git a/system/doc/installation_guide/book.xml b/system/doc/installation_guide/book.xml new file mode 100644 index 0000000000..7d8001f2b3 --- /dev/null +++ b/system/doc/installation_guide/book.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE book SYSTEM "book.dtd"> + +<book xmlns:xi="http://www.w3.org/2001/XInclude"> + <header titlestyle="normal"> + <copyright> + <year>1997</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Installation Guide</title> + <prepared>Peter Högfeldt</prepared> + <docno></docno> + <date>1997-11-06</date> + <rev>D</rev> + <file>book.xml</file> + </header> + <insidecover> + </insidecover> + <pagetext>Installation Guide</pagetext> + <preamble> + <contents level="2"></contents> + </preamble> + <parts lift="no"> + <xi:include href="part.xml"/> + </parts> + <listofterms></listofterms> + <index></index> +</book> + diff --git a/system/doc/installation_guide/install.xml b/system/doc/installation_guide/install.xml new file mode 100644 index 0000000000..2e37ff35e9 --- /dev/null +++ b/system/doc/installation_guide/install.xml @@ -0,0 +1,148 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Installation</title> + <prepared>Peter Högfeldt</prepared> + <responsible>Peter Högfeldt</responsible> + <docno></docno> + <approved>(Peter Högfeldt</approved> + <checked></checked> + <date>1997-05-26</date> + <rev>C</rev> + <file>install.xml</file> + </header> + + <section> + <title>UNIX</title> + + <section> + <title>Introduction</title> + <p>The system is delivered as a single compressed tar file.</p> + <p>To browse the on-line HTML documentation, Netscape or an equivalent + browser supporting frames is needed.</p> + </section> + + <section> + <title>Installation Procedure</title> + <p>When installed, the entire system, except for a small start-up + script, resides in a single directory tree. The location of this + directory tree can be chosen arbitrarily by the installer, and it + does not need to be in the user's <c>$PATH</c>. The only requirements + are that the file system where it is placed has enough free space, + and that the users who run Erlang/OTP have read access to it. In the + example below, the directory tree is assumed to be located at + <c>/usr/local/erlang</c>, which is here called the <em>top-level directory</em>.</p> + <p>It is assumed that you have the compressed tar file, the name of + which is <c><![CDATA[<PREFIX>.tar.gz]]></c>, where <c><![CDATA[<PREFIX>]]></c> is a string + denoting the particular Erlang/OTP release, e.g. + <c>otp_LXA_11930_sunos5_R9B</c>.</p> + <p>Wherever the string <c><![CDATA[<PREFIX>]]></c> is used below, it should + be replaced by the actual name prefix of the compressed tar file.</p> + <p>The tape archive file does not have one single directory in which + all other files are rooted. Therefore the tape archive file must be + extracted into an empty (newly created) directory.</p> + <list type="ordered"> + <item> + <p>If the <em>top-level directory</em> does not already exist, + create it:</p> + <pre> +mkdir /usr/local/erlang</pre> + </item> + <item> + <p>Change the current directory to the <em>top level directory</em>:</p> + <pre> +cd /usr/local/erlang</pre> + </item> + <item> + <p>Create the <em>installation directory</em> with an appropriate + name. For example:</p> + <pre> +mkdir otp_r7b</pre> + </item> + <item> + <p>Change to the <em>installation directory</em>, e.g.</p> + <pre> +cd otp_r7b</pre> + </item> + <item> + <p>Assuming the compressed tar file resides in the directory + <c><![CDATA[<SOME-DIR>]]></c>,. extract the compressed tar file into the + current directory:</p> + <pre> +gunzip -c <SOME-DIR>/<PREFIX>.tar.gz | tar xfp -</pre> + </item> + <item> + <p>Read the <c>README</c> file in the installation directory for + last minute updates, before proceeding.</p> + </item> + <item> + <p>Run the <c>Install</c> script in the installation directory, + with the absolute path of the installation directory as argument,</p> + <pre> +./Install /usr/local/erlang/otp_r7b</pre> + <p>and supply answers to the prompts.</p> + <p>In most cases, there is a default answer in square brackets + (<c>[]</c>). If the default is satisfactory, just press + <c><![CDATA[<Return>]]></c>. In general you are only prompted for one thing:</p> + <list type="bulleted"> + <item> + <p>"Do you want to use a minimal system startup instead of the + SASL startup?" <br></br> + + In a minimal system, only the Kernel and STDLIB applications + are loaded and started. If the SASL startup is used, the SASL + application is included as well. Normally, the minimal system + is enough.</p> + </item> + </list> + </item> + <item> + <p>Make Erlang/OTP available for users, either by putting the path + <c>/usr/local/erlang/otp_r7b/bin</c> in users <c>$PATH</c> + variable, or link the executable + <c>/usr/local/erlang/otp_r7b/bin/erl</c> accordingly, e.g.:</p> + <pre> +ln -s /usr/local/erlang/otp_r7b/bin/erl /usr/local/bin/erl </pre> + </item> + </list> + </section> + </section> + + <section> + <title>Windows</title> + + <section> + <title>Introduction</title> + <p>The system is delivered as a single <c>.exe</c> file.</p> + <p>To browse the on-line HTML documentation, Netscape or an equivalent + browser supporting frames is needed.</p> + </section> + + <section> + <title>Installation Procedure</title> + <p>The installation procedure is is automated. Double-click the + <c>.exe</c> file icon and follow the instructions.</p> + </section> + </section> +</chapter> + diff --git a/system/doc/installation_guide/make.dep b/system/doc/installation_guide/make.dep new file mode 100644 index 0000000000..3d1477935d --- /dev/null +++ b/system/doc/installation_guide/make.dep @@ -0,0 +1,13 @@ +# ---------------------------------------------------- +# >>>> Do not edit this file <<<< +# This file was automaticly generated by +# /home/otp/bin/docdepend +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# TeX files that the DVI file depend on +# ---------------------------------------------------- + +book.dvi: book.tex install.tex part.tex verification.tex + diff --git a/system/doc/installation_guide/note.gif b/system/doc/installation_guide/note.gif Binary files differnew file mode 100644 index 0000000000..6fffe30419 --- /dev/null +++ b/system/doc/installation_guide/note.gif diff --git a/system/doc/installation_guide/part.xml b/system/doc/installation_guide/part.xml new file mode 100644 index 0000000000..3019d2e118 --- /dev/null +++ b/system/doc/installation_guide/part.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Installation Guide</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + <file>part.xml</file> + </header> + <description> + <p>How to install Erlang/OTP on UNIX or Windows.</p> + </description> + <xi:include href="install.xml"/> + <xi:include href="verification.xml"/> +</part> + diff --git a/system/doc/installation_guide/verification.xml b/system/doc/installation_guide/verification.xml new file mode 100644 index 0000000000..814c252dca --- /dev/null +++ b/system/doc/installation_guide/verification.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Installation Verification</title> + <prepared>Peter Högfeldt</prepared> + <responsible>Peter Högfeldt</responsible> + <docno></docno> + <approved>(Peter Högfeldt</approved> + <checked></checked> + <date>1997-05-26</date> + <rev>C</rev> + <file>verification.xml</file> + </header> + <p>This chapter is about verifying your installation by performing + a few simple tests to see that your system is properly installed.</p> + + <section> + <title>UNIX</title> + <list type="bulleted"> + <item> + <p>Start Erlang/OTP from the command line,</p> + <pre> + unix> erl</pre> + <p>Expect the following output:</p> + <pre> + Erlang (BEAM) emulator version 5.0.1 [threads] + + Eshell V5.0.1 (abort with ^G) + 1></pre> + </item> + <item> + <p>Start the GS-based toolbar from the Erlang shell, </p> + <pre> + 1> <input>toolbar:start().</input></pre> + <p>and check that the toolbar window pops up. + </p> + <p><em>Note:</em> The trailing full stop (<c>"."</c>) is an end marker + for all commands in the Erlang shell, and must be entered for a + command to begin execution.</p> + </item> + <item> + <p>Exit by entering the command <c>halt()</c>,</p> + <pre> + 2> <input>halt().</input></pre> + <p>which should end both the toolbar window and the command line window. </p> + </item> + </list> + </section> + + <section> + <title>Windows</title> + <list type="bulleted"> + <item> + <p>Start Erlang/OTP by double-clicking on the Erlang shortcut icon on the + desktop.</p> + <p>Expect a command line window to pop up with the following output,</p> + <pre> + Erlang (BEAM) emulator version 5.0.1 [threads] + + Eshell V5.0.1 (abort with ^G) + 1></pre> + </item> + <item> + <p>Start the GS-based toolbar from the Erlang shell, </p> + <pre> + 1> <input>toolbar:start().</input></pre> + <p>and check that the toolbar window pops up. + </p> + <p><em>Note:</em> The trailing full stop (<c>"."</c>) is an end marker + for all commands in the Erlang shell, and must be entered for a + command to begin execution.</p> + </item> + <item> + <p>Exit by entering the command <c>halt()</c>,</p> + <pre> + 2> <input>halt().</input></pre> + <p>which should end both the toolbar window and the command line window. </p> + </item> + </list> + </section> +</chapter> + diff --git a/system/doc/installation_guide/warning.gif b/system/doc/installation_guide/warning.gif Binary files differnew file mode 100644 index 0000000000..96af52360e --- /dev/null +++ b/system/doc/installation_guide/warning.gif diff --git a/system/doc/installation_guide/xmlfiles.mk b/system/doc/installation_guide/xmlfiles.mk new file mode 100644 index 0000000000..7e1235b64d --- /dev/null +++ b/system/doc/installation_guide/xmlfiles.mk @@ -0,0 +1,21 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +INST_GUIDE_CHAPTER_FILES = \ + install.xml \ + verification.xml |
