From 3f8745835622c295a187fa2837aec72888e9837d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Magnus=20Lid=C3=A9n?= Date: Thu, 6 Mar 2014 19:23:38 +0100 Subject: Remove installation instruction for unix binary and reorder chapters Non-Windows binaries are not released any longer. Instructions are hence removed. --- system/doc/installation_guide/Makefile | 8 +- system/doc/installation_guide/install-binary.xml | 127 +++++------------------ system/doc/installation_guide/part.xml | 4 +- system/doc/installation_guide/verification.xml | 55 ++-------- system/doc/installation_guide/xmlfiles.mk | 6 +- 5 files changed, 37 insertions(+), 163 deletions(-) (limited to 'system') diff --git a/system/doc/installation_guide/Makefile b/system/doc/installation_guide/Makefile index 6923f52d8a..83210bd21f 100644 --- a/system/doc/installation_guide/Makefile +++ b/system/doc/installation_guide/Makefile @@ -1,7 +1,7 @@ # # %CopyrightBegin% # -# Copyright Ericsson AB 1996-2012. All Rights Reserved. +# Copyright Ericsson AB 1996-2014. 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 @@ -58,8 +58,7 @@ XML_FILES = \ GENERATED_XML_FILES = \ INSTALL.xml \ INSTALL-CROSS.xml \ - INSTALL-WIN32.xml \ - MARKDOWN.xml + INSTALL-WIN32.xml # ---------------------------------------------------- @@ -74,8 +73,7 @@ REDIRECT_HTML_DIR = $(HTMLDIR)/source REDIRECT_HTML_FILES = \ $(REDIRECT_HTML_DIR)/INSTALL.html \ $(REDIRECT_HTML_DIR)/INSTALL-CROSS.html \ - $(REDIRECT_HTML_DIR)/INSTALL-WIN32.html \ - $(REDIRECT_HTML_DIR)/MARKDOWN.html + $(REDIRECT_HTML_DIR)/INSTALL-WIN32.html # ---------------------------------------------------- # FLAGS diff --git a/system/doc/installation_guide/install-binary.xml b/system/doc/installation_guide/install-binary.xml index 07027a39f6..af7dab6e44 100644 --- a/system/doc/installation_guide/install-binary.xml +++ b/system/doc/installation_guide/install-binary.xml @@ -4,7 +4,7 @@
- 20002013 + 20002014 Ericsson AB. All Rights Reserved. @@ -31,117 +31,40 @@ C install-binary.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.

+

The system is delivered as a Windows Installer executable. + Get it from our download page.

- Installation Procedure + Installation

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

+
+ Verification + + +

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

+

Expect a command line window to pop up with an output looking something like this:

+ 
+  Erlang/OTP 17 [erts-6.0] [64-bit] [smp:2:2]
+
+  Eshell V6.0  (abort with ^G)
+  1>
+ + +

Exit by entering the command halt(),

+ 
+  2> halt().
+

which will close the Erlang/OTP shell.

+ + +
diff --git a/system/doc/installation_guide/part.xml b/system/doc/installation_guide/part.xml index 19808fd165..02bf98db7c 100644 --- a/system/doc/installation_guide/part.xml +++ b/system/doc/installation_guide/part.xml @@ -4,7 +4,7 @@
- 20002013 + 20002014 Ericsson AB. All Rights Reserved. @@ -32,9 +32,7 @@

How to install Erlang/OTP on UNIX or Windows.

- - \ No newline at end of file diff --git a/system/doc/installation_guide/verification.xml b/system/doc/installation_guide/verification.xml index 391ddfb7b8..201ede6473 100644 --- a/system/doc/installation_guide/verification.xml +++ b/system/doc/installation_guide/verification.xml @@ -4,7 +4,7 @@
- 20002013 + 20002014 Ericsson AB. All Rights Reserved. @@ -32,40 +32,7 @@ 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.

- - -
+ a simple test to see that your system is properly installed.

Windows @@ -73,28 +40,18 @@

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,

+

Expect a command line window to pop up with an output looking something like this:

-  Erlang (BEAM) emulator version 5.0.1 [threads]
+  Erlang/OTP 17 [erts-6.0] [64-bit] [smp:2:2]
 
-  Eshell V5.0.1  (abort with ^G)
+  Eshell V6.0  (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.

+

which should close the command line window and stop Erlang/OTP.

diff --git a/system/doc/installation_guide/xmlfiles.mk b/system/doc/installation_guide/xmlfiles.mk index 3995c607af..c443334cd7 100644 --- a/system/doc/installation_guide/xmlfiles.mk +++ b/system/doc/installation_guide/xmlfiles.mk @@ -1,7 +1,7 @@ # # %CopyrightBegin% # -# Copyright Ericsson AB 2009-2013. All Rights Reserved. +# Copyright Ericsson AB 2009-2014. 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 @@ -18,8 +18,6 @@ # INST_GUIDE_CHAPTER_FILES = \ install-binary.xml \ - verification.xml \ INSTALL.xml \ INSTALL-CROSS.xml \ - INSTALL-WIN32.xml \ - MARKDOWN.xml + INSTALL-WIN32.xml -- cgit v1.2.3 From dc99e212fd346c1f2bb19a63b5f447e7169ff30b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Magnus=20Lid=C3=A9n?= Date: Fri, 14 Mar 2014 10:02:13 +0100 Subject: Delete obsolete verification doc --- system/doc/installation_guide/verification.xml | 59 -------------------------- 1 file changed, 59 deletions(-) delete mode 100644 system/doc/installation_guide/verification.xml (limited to 'system') diff --git a/system/doc/installation_guide/verification.xml b/system/doc/installation_guide/verification.xml deleted file mode 100644 index 201ede6473..0000000000 --- a/system/doc/installation_guide/verification.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - -
- - 20002014 - 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 simple test to see that your system is properly installed.

- -
- Windows - - -

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

-

Expect a command line window to pop up with an output looking something like this:

- 
-  Erlang/OTP 17 [erts-6.0] [64-bit] [smp:2:2]
-
-  Eshell V6.0  (abort with ^G)
-  1>
- - -

Exit by entering the command halt(),

- 
-  2> halt().
-

which should close the command line window and stop Erlang/OTP.

- - -
- - -- cgit v1.2.3 From 107b27ef809e4356ea258cbd820967ffb8fa0875 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Magnus=20Lid=C3=A9n?= Date: Mon, 24 Feb 2014 09:23:29 +0100 Subject: Correct and clean up documentation The build and install documentation was not complete and needed some restructuring. --- system/doc/system_principles/system_principles.xml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'system') diff --git a/system/doc/system_principles/system_principles.xml b/system/doc/system_principles/system_principles.xml index 4f2202fdd1..70c69b1dab 100644 --- a/system/doc/system_principles/system_principles.xml +++ b/system/doc/system_principles/system_principles.xml @@ -4,7 +4,7 @@
- 19962013 + 19962014 Ericsson AB. All Rights Reserved. @@ -34,13 +34,12 @@

An Erlang runtime system is started with the command erl:

 % erl
-Erlang (BEAM) emulator version 5.2.3.5 [hipe] [threads:0]
+Erlang/OTP 17 [erts-6.0] [hipe] [smp:8:8]
 
-Eshell V5.2.3.5  (abort with ^G)
+Eshell V6.0  (abort with ^G)
 1>

erl understands a number of command line arguments, see - erl(1). A number of them are also described in this - chapter.

+ erl(1). A number of them are also described in this chapter.

Application programs can access the values of the command line arguments by calling one of the functions init:get_argument(Key), or init:get_arguments(). -- cgit v1.2.3 From 1e8884134d7fbfee1e5aa546727bd5f3beed4921 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Magnus=20Lid=C3=A9n?= Date: Tue, 25 Mar 2014 15:56:46 +0100 Subject: Add link to app resource file reference --- system/doc/design_principles/applications.xml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'system') diff --git a/system/doc/design_principles/applications.xml b/system/doc/design_principles/applications.xml index 228ca1f2bf..7b030115df 100644 --- a/system/doc/design_principles/applications.xml +++ b/system/doc/design_principles/applications.xml @@ -4,7 +4,7 @@

- 19972013 + 19972014 Ericsson AB. All Rights Reserved. @@ -157,8 +157,9 @@ ch_app:stop([]) all applications have dependencies to at least kernel and stdlib. -

The syntax and contents of of the application resource file - are described in detail in app(4).

+

The syntax and contents of of the application resource file + are described in detail in the + Application resource file reference.
-- cgit v1.2.3