summaryrefslogtreecommitdiff
path: root/lib/reltool/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'lib/reltool/doc/src')
-rw-r--r--lib/reltool/doc/src/Makefile21
-rw-r--r--lib/reltool/doc/src/files.mk4
-rw-r--r--lib/reltool/doc/src/reltool.xml4
-rw-r--r--lib/reltool/doc/src/reltool_escript.xml98
4 files changed, 115 insertions, 12 deletions
diff --git a/lib/reltool/doc/src/Makefile b/lib/reltool/doc/src/Makefile
index 2373b5e507..ab65303978 100644
--- a/lib/reltool/doc/src/Makefile
+++ b/lib/reltool/doc/src/Makefile
@@ -40,7 +40,8 @@ include files.mk
# ----------------------------------------------------
XML_FILES = \
- $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \
+ $(BOOK_FILES) $(XML_APPLICATION_FILES) \
+ $(XML_REF1_FILES) $(XML_REF3_FILES) \
$(XML_PART_FILES) $(XML_CHAPTER_FILES)
HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \
@@ -48,17 +49,17 @@ HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \
INFO_FILE = ../../info
+MAN1_FILES = $(XML_REF1_FILES:%.xml=$(MAN1DIR)/%.1)
MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3)
HTML_REF_MAN_FILE = $(HTMLDIR)/index.html
TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf
-
# ----------------------------------------------------
-# FLAGS
+# FLAGS
# ----------------------------------------------------
-XML_FLAGS +=
+XML_FLAGS +=
# ----------------------------------------------------
# Targets
@@ -74,11 +75,12 @@ pdf: $(TOP_PDF_FILE)
html:images $(HTML_REF_MAN_FILE)
-man: $(MAN3_FILES)
+man: $(MAN1_FILES) $(MAN3_FILES)
+ mv $(MAN1DIR)/reltool_escript.1 $(MAN1DIR)/reltool.1
images: $(IMAGE_FILES:%=$(HTMLDIR)/%)
-debug opt:
+debug opt:
clean clean_docs:
for file in $(XML_FILES); do \
@@ -87,13 +89,13 @@ clean clean_docs:
fi \
done
rm -rf $(HTMLDIR)/*
- rm -f $(MAN3DIR)/*
+ rm -f $(MAN3DIR)/* $(MAN1DIR)/*
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
@@ -103,7 +105,8 @@ release_docs_spec: docs
$(INSTALL_DATA) $(HTMLDIR)/* "$(RELSYSDIR)/doc/html"
$(INSTALL_DATA) $(INFO_FILE) "$(RELSYSDIR)"
$(INSTALL_DIR) "$(RELEASE_PATH)/man/man3"
+ $(INSTALL_DATA) $(MAN1DIR)/* "$(RELEASE_PATH)/man/man1"
+ $(INSTALL_DIR) "$(RELEASE_PATH)/man/man1"
$(INSTALL_DATA) $(MAN3DIR)/* "$(RELEASE_PATH)/man/man3"
release_spec:
-
diff --git a/lib/reltool/doc/src/files.mk b/lib/reltool/doc/src/files.mk
index 07b52f4934..265b905456 100644
--- a/lib/reltool/doc/src/files.mk
+++ b/lib/reltool/doc/src/files.mk
@@ -23,6 +23,9 @@ XML_APPLICATION_FILES = \
XML_REF3_FILES = \
reltool.xml
+XML_REF1_FILES = \
+ reltool_escript.xml
+
XML_PART_FILES = \
part.xml
@@ -35,4 +38,3 @@ XML_CHAPTER_FILES = \
BOOK_FILES = book.xml
IMAGE_FILES =
-
diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml
index 8437b7a623..a5b5c47d8b 100644
--- a/lib/reltool/doc/src/reltool.xml
+++ b/lib/reltool/doc/src/reltool.xml
@@ -39,7 +39,7 @@
<p><em>Reltool</em> is a release management tool. It analyses a
given Erlang/OTP installation and determines various dependencies
- between applications. The <c>graphical</c> frontend depicts the
+ between its applications. The <c>graphical</c> frontend depicts the
dependencies and enables interactive customization of a target
system. The backend provides a <c>batch</c> interface for
generation of customized target systems.</p>
@@ -697,7 +697,7 @@ target_spec() = [target_spec()]
</func>
<func>
- <name>get_script(Server, Relname) -> {ok, ScriptFile | {error, Reason}</name>
+ <name>get_script(Server, Relname) -> {ok, ScriptFile} | {error, Reason}</name>
<fsummary>Get contents of a boot script file</fsummary>
<type>
<v>Server = server()</v>
diff --git a/lib/reltool/doc/src/reltool_escript.xml b/lib/reltool/doc/src/reltool_escript.xml
new file mode 100644
index 0000000000..507f5ef125
--- /dev/null
+++ b/lib/reltool/doc/src/reltool_escript.xml
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE comref SYSTEM "comref.dtd">
+
+<comref>
+ <header>
+ <copyright>
+ <year>2013</year>
+ <year>2013</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>erl</title>
+ <prepared></prepared>
+ <docno></docno>
+ <date></date>
+ <rev></rev>
+ <file>reltool_escript.xml</file>
+ </header>
+ <com>reltool</com>
+ <comsummary>Erlang/OTP release management tool</comsummary>
+ <description>
+ <p><em>Reltool</em> is a release management tool. It analyses a
+ given Erlang/OTP installation and determines various dependencies
+ between its applications. The <c>graphical</c> frontend depicts the
+ dependencies and enables interactive customization of a target
+ system. The backend provides a <c>batch</c> interface for
+ generation of customized target systems.</p>
+ </description>
+ <funcs>
+ <func>
+ <name>reltool --gui></name>
+ <fsummary>Start GUI</fsummary>
+ <desc>
+ <p>Starts the graphical user interface. See <em>reltool:start/1</em>.</p>
+ </desc>
+ </func>
+ <func>
+ <name>reltool [Config] --get_config [-defaults] [-derived] [File]></name>
+ <fsummary>Retrieves actual config</fsummary>
+ <desc>
+ <p>See <em>reltool:get_config/3</em>.</p>
+ </desc>
+ </func>
+ <func>
+ <name>reltool [Config] --get_rel RelName [File]></name>
+ <fsummary>Retrieves actual release info</fsummary>
+ <desc>
+ <p>See <em>reltool:get_rel/2</em>.</p>
+ </desc>
+ </func>
+ <func>
+ <name>reltool [Config] --get_script RelName [File]></name>
+ <fsummary>Retrieves actual boot script</fsummary>
+ <desc>
+ <p>See <em>reltool:get_script/2</em>.</p>
+ </desc>
+ </func>
+ <func>
+ <name>reltool [Config] --create_target TargetDir></name>
+ <fsummary>Generate a target system</fsummary>
+ <desc>
+ <p>See <em>reltool:create_target/2</em>.</p>
+ </desc>
+ </func>
+ <func>
+ <name>reltool [Config] --get_target_spec [SpecFile]</name>
+ <fsummary>Retrieve spec of target system</fsummary>
+ <desc>
+ <p>See <em>reltool:get_target_spec/1</em>.</p>
+ </desc>
+ </func>
+ <func>
+ <name>reltool --eval_target_spec Spec RootDir TargetDir</name>
+ <fsummary>Generate target system from spec</fsummary>
+ <desc>
+ <p>See <em>reltool:eval_target_spec/3</em>.</p>
+ </desc>
+ </func>
+ </funcs>
+
+ <section>
+ <title>SEE ALSO</title>
+ <p><seealso marker="reltool">reltool(3)</seealso></p>
+ </section>
+</comref>
View Lorry Controller Status