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. --- erts/doc/src/run_erl.xml | 155 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 erts/doc/src/run_erl.xml (limited to 'erts/doc/src/run_erl.xml') diff --git a/erts/doc/src/run_erl.xml b/erts/doc/src/run_erl.xml new file mode 100644 index 0000000000..7bf7f559c5 --- /dev/null +++ b/erts/doc/src/run_erl.xml @@ -0,0 +1,155 @@ + + + + +
+ + 19992009 + 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. + + + + run_erl + Kent Boortz + + + + + 99-12-15 + + run_erl.xml +
+ run_erl + Redirect Erlang input and output streams on Solaris® + +

This describes the program specific to + Solaris/Linux. This program redirect the standard input and standard + output streams so that all output can be logged. It also let the + program connect to the Erlang console making it + possible to monitor and debug an embedded system remotely.

+

You can read more about the use in the .

+ + + + run_erl [-daemon] pipe_dir/ log_dir "exec command [command_arguments]" + Start the Erlang emulator without attached terminal + +

The program arguments are:

+ + -daemon + This option is highly recommended. It makes run_erl run in + the background completely detached from any controlling + terminal and the command returns to the caller immediately. + Without this option, run_erl must be started using several + tricks in the shell to detach it completely from the + terminal in use when starting it. The option must be the + first argument to run_erl on the command line. + pipe_dir + This is where to put the named pipe, usually + . It shall be suffixed by a (slash), + i.e. not , but . + log_dir + This is where the log files are written. There will be one + log file, that log progress and + warnings from the program itself and there + will be up to five log files at maximum 100KB each (both + number of logs and sizes can be + changed by environment variables, see below) with + the content of the standard streams from and to the + command. When the logs are full will delete + and reuse the oldest log file. + "exec command [command_arguments]" + In the third argument is the to execute + where everything written to stdin and stdout is logged to + . + + + + + +
+ Notes concerning the log files +

While running, run_erl (as stated earlier) sends all output, + uninterpreted, to a log file. The file is called + , where N is a number. When the log is "full", + default after 100KB, run_erl starts to log in file + , until N reaches a certain number (default + 5), where after N starts at 1 again and the oldest files start + getting overwritten. If no output comes from the erlang shell, but + the erlang machine still seems to be alive, an "ALIVE" message is + written to the log, it is a timestamp and is written, by default, + after 15 minutes of inactivity. Also, if output from erlang is + logged but it's been more than 5 minutes (default) since last time + we got anything from erlang, a timestamp is written in the + log. The "ALIVE" messages look like this:

+ + ]]> +

while the other timestamps look like this:

+ + ]]> +

The is the date and time the message is + written, default in local time (can be changed to GMT if one wants + to) and is formatted with the ANSI-C function + using the format string , which produces + messages on the line of , this can be changed, see below.

+
+ +
+ Environment variables +

The following environment variables are recognized by run_erl + and change the logging behavior. Also see the notes above to get + more info on how the log behaves.

+ + RUN_ERL_LOG_ALIVE_MINUTES + How long to wait for output (in minutes) before writing an + "ALIVE" message to the log. Default is 15, can never be less + than 1. + RUN_ERL_LOG_ACTIVITY_MINUTES + How long erlang need to be inactive before output will be + preceded with a timestamp. Default is + RUN_ERL_LOG_ALIVE_MINUTES div 3, but never less than 1. + RUN_ERL_LOG_ALIVE_FORMAT + Specifies another format string to be used in the strftime + C library call. i.e specifying this to + will give log messages with timestamps looking like + etc. See the documentation + for the C library function strftime for more + information. Default is . + RUN_ERL_LOG_ALIVE_IN_UTC + If set to anything else than "0", it will make all + times displayed by run_erl to be in UTC (GMT,CET,MET, without + DST), rather than + in local time. This does not affect data coming from erlang, + only the logs output directly by run_erl. The application + can be modified accordingly by setting the erlang + application variable to . + RUN_ERL_LOG_GENERATIONS + Controls the number of log files written before older + files are being reused. Default is 5, minimum is 2, maximum is 1000. + RUN_ERL_LOG_MAXSIZE + The size (in bytes) of a log file before switching to a + new log file. Default is 100000, minimum is 1000 and maximum is + approximately 2^30. + +
+ +
+ SEE ALSO +

start(1), start_erl(1)

+
+ + -- cgit v1.2.3