From d041cab91829ebacbd35ce2c5927f6ebe69b417a Mon Sep 17 00:00:00 2001 From: Rickard Green Date: Mon, 22 Mar 2010 10:24:35 +0000 Subject: OTP-8512 Add Erlangish MarkDown to Erlangish XML support The INSTALL.md, INSTALL-CROSS.md, and INSTALL-WIN32.md "readme files" are now included in both the HTML and the PDF documentation. --- system/doc/installation_guide/Makefile | 45 +++++-- system/doc/installation_guide/install-binary.xml | 147 ++++++++++++++++++++ system/doc/installation_guide/install.xml | 165 ----------------------- system/doc/installation_guide/make.dep | 2 +- system/doc/installation_guide/part.xml | 11 +- system/doc/installation_guide/xmlfiles.mk | 17 ++- 6 files changed, 198 insertions(+), 189 deletions(-) create mode 100644 system/doc/installation_guide/install-binary.xml delete mode 100644 system/doc/installation_guide/install.xml (limited to 'system/doc/installation_guide') diff --git a/system/doc/installation_guide/Makefile b/system/doc/installation_guide/Makefile index 854025765c..a47d77604d 100644 --- a/system/doc/installation_guide/Makefile +++ b/system/doc/installation_guide/Makefile @@ -31,6 +31,7 @@ APPLICATION=otp-system-documentation # Release directory specification # ---------------------------------------------------- RELSYSDIR = $(RELEASE_PATH)/doc/installation_guide +REDIRECT_HTML_RELSYSDIR = $(RELSYSDIR)/source # ---------------------------------------------------- # Target Specs @@ -54,14 +55,11 @@ XML_FILES = \ $(XML_PART_FILES) # ---------------------------------------------------- -# Install readme files -# ---------------------------------------------------- -SOURCE_INSTALL_READMES = \ - $(ERL_TOP)/INSTALL.html \ - $(ERL_TOP)/INSTALL-CROSS.html \ - $(ERL_TOP)/INSTALL-WIN32.html +GENERATED_XML_FILES = \ + INSTALL.xml \ + INSTALL-CROSS.xml \ + INSTALL-WIN32.xml -SOURCE_RELSYSDIR = $(RELSYSDIR)/source # ---------------------------------------------------- HTML_FILES = \ @@ -71,6 +69,12 @@ HTMLDIR = ../html/installation_guide HTML_UG_FILE = $(HTMLDIR)/users_guide.html +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 + # ---------------------------------------------------- # FLAGS # ---------------------------------------------------- @@ -80,15 +84,32 @@ DVIPS_FLAGS += # ---------------------------------------------------- # Targets # ---------------------------------------------------- -docs: html + +%.xml: $(ERL_TOP)/%.md $(ERL_TOP)/make/emd2exml + $(ERL_TOP)/make/emd2exml $< $@ + +$(REDIRECT_HTML_DIR)/%.html: Makefile + test -d $(REDIRECT_HTML_DIR) || $(INSTALL_DIR) $(REDIRECT_HTML_DIR) + echo " $@ + echo " content=\"5; url=../"$(notdir $@)"\">" >> $@ + echo "This page has moved" >> $@ + echo "

This page has moved

" >> $@ + echo "

You will be automatically redirected to its new" >> $@ + echo "location in 5 seconds." >> $@ + echo "This link will" >> $@ + echo "take you there immediately.

" >> $@ + +docs: $(GENERATED_XML_FILES) html local_docs: PDFDIR=../../pdf +local_docs: $(GENERATED_XML_FILES) -html: $(GIF_FILES) $(HTML_UG_FILE) +html: $(REDIRECT_HTML_FILES) $(GENERATED_XML_FILES) $(GIF_FILES) $(HTML_UG_FILE) -debug opt: +debug opt: clean clean_docs: + rm -f $(GENERATED_XML_FILES) rm -rf $(HTMLDIR) rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) rm -f errs core *~ @@ -102,8 +123,8 @@ include $(ERL_TOP)/make/otp_release_targets.mk release_docs_spec: docs $(INSTALL_DIR) $(RELSYSDIR) $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html $(RELSYSDIR) - $(INSTALL_DIR) $(SOURCE_RELSYSDIR) - $(INSTALL_DATA) $(SOURCE_INSTALL_READMES) $(SOURCE_RELSYSDIR) + $(INSTALL_DIR) $(REDIRECT_HTML_RELSYSDIR) + $(INSTALL_DATA) $(REDIRECT_HTML_FILES) $(REDIRECT_HTML_RELSYSDIR) release_spec: diff --git a/system/doc/installation_guide/install-binary.xml b/system/doc/installation_guide/install-binary.xml new file mode 100644 index 0000000000..ac4192586d --- /dev/null +++ b/system/doc/installation_guide/install-binary.xml @@ -0,0 +1,147 @@ + + + + +

+ + 20002010 + 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. + + + + Installing the Binary Release + Peter Högfeldt + Peter Högfeldt + + (Peter Högfeldt + + 1997-05-26 + 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.

+ +

+ 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/install.xml b/system/doc/installation_guide/install.xml deleted file mode 100644 index c1b930a4bd..0000000000 --- a/system/doc/installation_guide/install.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - -

- - 20002010 - 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 -

- -

- Source -

This document describes installation procedures for - binary releases. Documentation of build and installation - procedures for the source release can be found in the source - tree at the following locations:

- - Building and Installing Erlang/OTP - $ERL_TOP/INSTALL.md - Cross Compiling Erlang/OTP - $ERL_TOP/INSTALL-CROSS.md - How to Build Erlang/OTP on Windows - $ERL_TOP/INSTALL-WIN32.md - -

Where $ERL_TOP is the top directory in the source tree.

- -

- 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 index 3d1477935d..3878f4ac9d 100644 --- a/system/doc/installation_guide/make.dep +++ b/system/doc/installation_guide/make.dep @@ -9,5 +9,5 @@ # TeX files that the DVI file depend on # ---------------------------------------------------- -book.dvi: book.tex install.tex part.tex verification.tex +book.dvi: book.tex install-binary.tex part.tex verification.tex diff --git a/system/doc/installation_guide/part.xml b/system/doc/installation_guide/part.xml index 3019d2e118..fceacdd8f6 100644 --- a/system/doc/installation_guide/part.xml +++ b/system/doc/installation_guide/part.xml @@ -4,7 +4,7 @@

- 20002009 + 20002010 Ericsson AB. All Rights Reserved. @@ -13,12 +13,12 @@ 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 @@ -31,7 +31,10 @@

How to install Erlang/OTP on UNIX or Windows.

- + + + + diff --git a/system/doc/installation_guide/xmlfiles.mk b/system/doc/installation_guide/xmlfiles.mk index 7e1235b64d..dee67b3c70 100644 --- a/system/doc/installation_guide/xmlfiles.mk +++ b/system/doc/installation_guide/xmlfiles.mk @@ -1,21 +1,24 @@ # # %CopyrightBegin% -# -# Copyright Ericsson AB 2009. All Rights Reserved. -# +# +# Copyright Ericsson AB 2009-2010. 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 + install-binary.xml \ + verification.xml \ + INSTALL.xml \ + INSTALL-CROSS.xml \ + INSTALL-WIN32.xml -- cgit v1.2.3