From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- system/doc/installation_guide/Makefile | 100 +++++++++++++++++ system/doc/installation_guide/book.xml | 43 +++++++ system/doc/installation_guide/install.xml | 148 +++++++++++++++++++++++++ system/doc/installation_guide/make.dep | 13 +++ system/doc/installation_guide/note.gif | Bin 0 -> 1539 bytes system/doc/installation_guide/part.xml | 37 +++++++ system/doc/installation_guide/verification.xml | 102 +++++++++++++++++ system/doc/installation_guide/warning.gif | Bin 0 -> 1498 bytes system/doc/installation_guide/xmlfiles.mk | 21 ++++ 9 files changed, 464 insertions(+) create mode 100644 system/doc/installation_guide/Makefile create mode 100644 system/doc/installation_guide/book.xml create mode 100644 system/doc/installation_guide/install.xml create mode 100644 system/doc/installation_guide/make.dep create mode 100644 system/doc/installation_guide/note.gif create mode 100644 system/doc/installation_guide/part.xml create mode 100644 system/doc/installation_guide/verification.xml create mode 100644 system/doc/installation_guide/warning.gif create mode 100644 system/doc/installation_guide/xmlfiles.mk (limited to 'system/doc/installation_guide') 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 @@ + + + + +
+ + 19972009 + Ericsson AB. 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. + + + + Installation Guide + Peter Högfeldt + + 1997-11-06 + D + book.xml +
+ + + Installation Guide + + + + + + + + + + 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 @@ + + + + +
+ + 20002009 + Ericsson AB. 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. + + + + Installation + Peter Högfeldt + Peter Högfeldt + + (Peter Högfeldt + + 1997-05-26 + C + install.xml +
+ +
+ UNIX + +
+ Introduction +

The system is delivered as a single compressed tar file.

+

To browse the on-line HTML documentation, Netscape or an equivalent + browser supporting frames is needed.

+
+ +
+ Installation Procedure +

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 $PATH. 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 + /usr/local/erlang, which is here called the top-level directory.

+

It is assumed that you have the compressed tar file, the name of + which is .tar.gz]]>, where ]]> is a string + denoting the particular Erlang/OTP release, e.g. + otp_LXA_11930_sunos5_R9B.

+

Wherever the string ]]> is used below, it should + be replaced by the actual name prefix of the compressed tar file.

+

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.

+ + +

If the top-level directory does not already exist, + create it:

+ 
+mkdir /usr/local/erlang
+ + +

Change the current directory to the top level directory:

+ 
+cd /usr/local/erlang
+ + +

Create the installation directory with an appropriate + name. For example:

+ 
+mkdir otp_r7b
+ + +

Change to the installation directory, e.g.

+ 
+cd otp_r7b
+ + +

Assuming the compressed tar file resides in the directory + ]]>,. extract the compressed tar file into the + current directory:

+ 
+gunzip -c <SOME-DIR>/<PREFIX>.tar.gz | tar xfp -
+ + +

Read the README file in the installation directory for + last minute updates, before proceeding.

+ + +

Run the Install script in the installation directory, + with the absolute path of the installation directory as argument,

+ 
+./Install /usr/local/erlang/otp_r7b
+

and supply answers to the prompts.

+

In most cases, there is a default answer in square brackets + ([]). If the default is satisfactory, just press + ]]>. In general you are only prompted for one thing:

+ + +

"Do you want to use a minimal system startup instead of the + SASL startup?"

+ + 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.

+ + + + +

Make Erlang/OTP available for users, either by putting the path + /usr/local/erlang/otp_r7b/bin in users $PATH + variable, or link the executable + /usr/local/erlang/otp_r7b/bin/erl accordingly, e.g.:

+ 
+ln -s /usr/local/erlang/otp_r7b/bin/erl /usr/local/bin/erl
+ + +
+
+ +
+ Windows + +
+ Introduction +

The system is delivered as a single .exe file.

+

To browse the on-line HTML documentation, Netscape or an equivalent + browser supporting frames is needed.

+
+ +
+ Installation Procedure +

The installation procedure is is automated. Double-click the + .exe file icon and follow the instructions.

+
+
+ + 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 new file mode 100644 index 0000000000..6fffe30419 Binary files /dev/null and b/system/doc/installation_guide/note.gif differ 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 @@ + + + + +
+ + 20002009 + Ericsson AB. 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. + + + + Installation Guide + + + + + part.xml +
+ +

How to install Erlang/OTP on UNIX or Windows.

+ + + + + 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 @@ + + + + +
+ + 20002009 + Ericsson AB. 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. + + + + Installation Verification + Peter Högfeldt + Peter Högfeldt + + (Peter Högfeldt + + 1997-05-26 + C + verification.xml +
+

This chapter is about verifying your installation by performing + a few simple tests to see that your system is properly installed.

+ +
+ UNIX + + +

Start Erlang/OTP from the command line,

+ 
+  unix> erl
+

Expect the following output:

+ 
+  Erlang (BEAM) emulator version 5.0.1 [threads]
+
+  Eshell V5.0.1  (abort with ^G)
+  1>
+ + +

Start the GS-based toolbar from the Erlang shell,

+ 
+  1> toolbar:start().
+

and check that the toolbar window pops up. +

+

Note: The trailing full stop (".") is an end marker + for all commands in the Erlang shell, and must be entered for a + command to begin execution.

+ + +

Exit by entering the command halt(),

+ 
+  2> halt().
+

which should end both the toolbar window and the command line window.

+ + +
+ +
+ Windows + + +

Start Erlang/OTP by double-clicking on the Erlang shortcut icon on the + desktop.

+

Expect a command line window to pop up with the following output,

+ 
+  Erlang (BEAM) emulator version 5.0.1 [threads]
+
+  Eshell V5.0.1  (abort with ^G)
+  1>
+ + +

Start the GS-based toolbar from the Erlang shell,

+ 
+  1> toolbar:start().
+

and check that the toolbar window pops up. +

+

Note: The trailing full stop (".") is an end marker + for all commands in the Erlang shell, and must be entered for a + command to begin execution.

+ + +

Exit by entering the command halt(),

+ 
+  2> halt().
+

which should end both the toolbar window and the command line window.

+ + +
+ + diff --git a/system/doc/installation_guide/warning.gif b/system/doc/installation_guide/warning.gif new file mode 100644 index 0000000000..96af52360e Binary files /dev/null and b/system/doc/installation_guide/warning.gif differ 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 -- cgit v1.2.3