<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html xmlns:fn="http://www.w3.org/2005/02/xpath-functions"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" href="../../../doc/otp_doc.css" type="text/css"> <title>Erlang -- erl</title> </head> <body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container"> <script id="js" type="text/javascript" language="JavaScript" src="../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript"> <!-- function getWinHeight() { var myHeight = 0; if( typeof( window.innerHeight ) == 'number' ) { //Non-IE myHeight = window.innerHeight; } else if( document.documentElement && ( document.documentElement.clientWidth || document.documentElement.clientHeight ) ) { //IE 6+ in 'standards compliant mode' myHeight = document.documentElement.clientHeight; } else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) { //IE 4 compatible myHeight = document.body.clientHeight; } return myHeight; } function setscrollpos() { var objf=document.getElementById('loadscrollpos'); document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2; } function addEvent(obj, evType, fn){ if (obj.addEventListener){ obj.addEventListener(evType, fn, true); return true; } else if (obj.attachEvent){ var r = obj.attachEvent("on"+evType, fn); return r; } else { return false; } } addEvent(window, 'load', setscrollpos); //--></script><div id="leftnav"><div class="innertube"> <img alt="Erlang logo" src="../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/erts-5.9.3.1.pdf">PDF</a><br><a href="../../../doc/index.html">Top</a></small><p><strong>Erlang Run-Time System Application (ERTS)</strong><br><strong>Reference Manual</strong><br><small>Version 5.9.3.1</small></p> <br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Table of Contents</strong></small></p> <ul class="flipMenu"> <li id="no" title="erl_prim_loader " expanded="false">erl_prim_loader<ul> <li><a href="erl_prim_loader.html"> Top of manual page </a></li> <li title="start-3"><a href="erl_prim_loader.html#start-3">start/3</a></li> <li title="get_file-1"><a href="erl_prim_loader.html#get_file-1">get_file/1</a></li> <li title="get_path-0"><a href="erl_prim_loader.html#get_path-0">get_path/0</a></li> <li title="list_dir-1"><a href="erl_prim_loader.html#list_dir-1">list_dir/1</a></li> <li title="read_file_info-1"><a href="erl_prim_loader.html#read_file_info-1">read_file_info/1</a></li> <li title="set_path-1"><a href="erl_prim_loader.html#set_path-1">set_path/1</a></li> </ul> </li> <li id="no" title="erlang " expanded="false">erlang<ul> <li><a href="erlang.html"> Top of manual page </a></li> <li title="abs-1"><a href="erlang.html#abs-1">abs/1</a></li> <li title="adler32-1"><a href="erlang.html#adler32-1">adler32/1</a></li> <li title="adler32-2"><a href="erlang.html#adler32-2">adler32/2</a></li> <li title="adler32_combine-3"><a href="erlang.html#adler32_combine-3">adler32_combine/3</a></li> <li title="append_element-2"><a href="erlang.html#append_element-2">append_element/2</a></li> <li title="apply-2"><a href="erlang.html#apply-2">apply/2</a></li> <li title="apply-3"><a href="erlang.html#apply-3">apply/3</a></li> <li title="atom_to_binary-2"><a href="erlang.html#atom_to_binary-2">atom_to_binary/2</a></li> <li title="atom_to_list-1"><a href="erlang.html#atom_to_list-1">atom_to_list/1</a></li> <li title="binary_part-2"><a href="erlang.html#binary_part-2">binary_part/2</a></li> <li title="binary_part-3"><a href="erlang.html#binary_part-3">binary_part/3</a></li> <li title="binary_to_atom-2"><a href="erlang.html#binary_to_atom-2">binary_to_atom/2</a></li> <li title="binary_to_existing_atom-2"><a href="erlang.html#binary_to_existing_atom-2">binary_to_existing_atom/2</a></li> <li title="binary_to_list-1"><a href="erlang.html#binary_to_list-1">binary_to_list/1</a></li> <li title="binary_to_list-3"><a href="erlang.html#binary_to_list-3">binary_to_list/3</a></li> <li title="bitstring_to_list-1"><a href="erlang.html#bitstring_to_list-1">bitstring_to_list/1</a></li> <li title="binary_to_term-1"><a href="erlang.html#binary_to_term-1">binary_to_term/1</a></li> <li title="binary_to_term-2"><a href="erlang.html#binary_to_term-2">binary_to_term/2</a></li> <li title="bit_size-1"><a href="erlang.html#bit_size-1">bit_size/1</a></li> <li title="bump_reductions-1"><a href="erlang.html#bump_reductions-1">bump_reductions/1</a></li> <li title="byte_size-1"><a href="erlang.html#byte_size-1">byte_size/1</a></li> <li title="cancel_timer-1"><a href="erlang.html#cancel_timer-1">cancel_timer/1</a></li> <li title="check_old_code-1"><a href="erlang.html#check_old_code-1">check_old_code/1</a></li> <li title="check_process_code-2"><a href="erlang.html#check_process_code-2">check_process_code/2</a></li> <li title="crc32-1"><a href="erlang.html#crc32-1">crc32/1</a></li> <li title="crc32-2"><a href="erlang.html#crc32-2">crc32/2</a></li> <li title="crc32_combine-3"><a href="erlang.html#crc32_combine-3">crc32_combine/3</a></li> <li title="date-0"><a href="erlang.html#date-0">date/0</a></li> <li title="decode_packet-3"><a href="erlang.html#decode_packet-3">decode_packet/3</a></li> <li title="delete_module-1"><a href="erlang.html#delete_module-1">delete_module/1</a></li> <li title="demonitor-1"><a href="erlang.html#demonitor-1">demonitor/1</a></li> <li title="demonitor-2"><a href="erlang.html#demonitor-2">demonitor/2</a></li> <li title="disconnect_node-1"><a href="erlang.html#disconnect_node-1">disconnect_node/1</a></li> <li title="display-1"><a href="erlang.html#display-1">display/1</a></li> <li title="element-2"><a href="erlang.html#element-2">element/2</a></li> <li title="erase-0"><a href="erlang.html#erase-0">erase/0</a></li> <li title="erase-1"><a href="erlang.html#erase-1">erase/1</a></li> <li title="error-1"><a href="erlang.html#error-1">error/1</a></li> <li title="error-2"><a href="erlang.html#error-2">error/2</a></li> <li title="exit-1"><a href="erlang.html#exit-1">exit/1</a></li> <li title="exit-2"><a href="erlang.html#exit-2">exit/2</a></li> <li title="external_size-1"><a href="erlang.html#external_size-1">external_size/1</a></li> <li title="external_size-2"><a href="erlang.html#external_size-2">external_size/2</a></li> <li title="float-1"><a href="erlang.html#float-1">float/1</a></li> <li title="float_to_list-1"><a href="erlang.html#float_to_list-1">float_to_list/1</a></li> <li title="fun_info-1"><a href="erlang.html#fun_info-1">fun_info/1</a></li> <li title="fun_info-2"><a href="erlang.html#fun_info-2">fun_info/2</a></li> <li title="fun_to_list-1"><a href="erlang.html#fun_to_list-1">fun_to_list/1</a></li> <li title="function_exported-3"><a href="erlang.html#function_exported-3">function_exported/3</a></li> <li title="garbage_collect-0"><a href="erlang.html#garbage_collect-0">garbage_collect/0</a></li> <li title="garbage_collect-1"><a href="erlang.html#garbage_collect-1">garbage_collect/1</a></li> <li title="get-0"><a href="erlang.html#get-0">get/0</a></li> <li title="get-1"><a href="erlang.html#get-1">get/1</a></li> <li title="get_cookie-0"><a href="erlang.html#get_cookie-0">get_cookie/0</a></li> <li title="get_keys-1"><a href="erlang.html#get_keys-1">get_keys/1</a></li> <li title="get_stacktrace-0"><a href="erlang.html#get_stacktrace-0">get_stacktrace/0</a></li> <li title="group_leader-0"><a href="erlang.html#group_leader-0">group_leader/0</a></li> <li title="group_leader-2"><a href="erlang.html#group_leader-2">group_leader/2</a></li> <li title="halt-0"><a href="erlang.html#halt-0">halt/0</a></li> <li title="halt-1"><a href="erlang.html#halt-1">halt/1</a></li> <li title="halt-2"><a href="erlang.html#halt-2">halt/2</a></li> <li title="hash-2"><a href="erlang.html#hash-2">hash/2</a></li> <li title="hd-1"><a href="erlang.html#hd-1">hd/1</a></li> <li title="hibernate-3"><a href="erlang.html#hibernate-3">hibernate/3</a></li> <li title="integer_to_list-1"><a href="erlang.html#integer_to_list-1">integer_to_list/1</a></li> <li title="integer_to_list-2"><a href="erlang.html#integer_to_list-2">integer_to_list/2</a></li> <li title="iolist_to_binary-1"><a href="erlang.html#iolist_to_binary-1">iolist_to_binary/1</a></li> <li title="iolist_size-1"><a href="erlang.html#iolist_size-1">iolist_size/1</a></li> <li title="is_alive-0"><a href="erlang.html#is_alive-0">is_alive/0</a></li> <li title="is_atom-1"><a href="erlang.html#is_atom-1">is_atom/1</a></li> <li title="is_binary-1"><a href="erlang.html#is_binary-1">is_binary/1</a></li> <li title="is_bitstring-1"><a href="erlang.html#is_bitstring-1">is_bitstring/1</a></li> <li title="is_boolean-1"><a href="erlang.html#is_boolean-1">is_boolean/1</a></li> <li title="is_builtin-3"><a href="erlang.html#is_builtin-3">is_builtin/3</a></li> <li title="is_float-1"><a href="erlang.html#is_float-1">is_float/1</a></li> <li title="is_function-1"><a href="erlang.html#is_function-1">is_function/1</a></li> <li title="is_function-2"><a href="erlang.html#is_function-2">is_function/2</a></li> <li title="is_integer-1"><a href="erlang.html#is_integer-1">is_integer/1</a></li> <li title="is_list-1"><a href="erlang.html#is_list-1">is_list/1</a></li> <li title="is_number-1"><a href="erlang.html#is_number-1">is_number/1</a></li> <li title="is_pid-1"><a href="erlang.html#is_pid-1">is_pid/1</a></li> <li title="is_port-1"><a href="erlang.html#is_port-1">is_port/1</a></li> <li title="is_process_alive-1"><a href="erlang.html#is_process_alive-1">is_process_alive/1</a></li> <li title="is_record-2"><a href="erlang.html#is_record-2">is_record/2</a></li> <li title="is_record-3"><a href="erlang.html#is_record-3">is_record/3</a></li> <li title="is_reference-1"><a href="erlang.html#is_reference-1">is_reference/1</a></li> <li title="is_tuple-1"><a href="erlang.html#is_tuple-1">is_tuple/1</a></li> <li title="length-1"><a href="erlang.html#length-1">length/1</a></li> <li title="link-1"><a href="erlang.html#link-1">link/1</a></li> <li title="list_to_atom-1"><a href="erlang.html#list_to_atom-1">list_to_atom/1</a></li> <li title="list_to_binary-1"><a href="erlang.html#list_to_binary-1">list_to_binary/1</a></li> <li title="list_to_bitstring-1"><a href="erlang.html#list_to_bitstring-1">list_to_bitstring/1</a></li> <li title="list_to_existing_atom-1"><a href="erlang.html#list_to_existing_atom-1">list_to_existing_atom/1</a></li> <li title="list_to_float-1"><a href="erlang.html#list_to_float-1">list_to_float/1</a></li> <li title="list_to_integer-1"><a href="erlang.html#list_to_integer-1">list_to_integer/1</a></li> <li title="list_to_integer-2"><a href="erlang.html#list_to_integer-2">list_to_integer/2</a></li> <li title="list_to_pid-1"><a href="erlang.html#list_to_pid-1">list_to_pid/1</a></li> <li title="list_to_tuple-1"><a href="erlang.html#list_to_tuple-1">list_to_tuple/1</a></li> <li title="load_module-2"><a href="erlang.html#load_module-2">load_module/2</a></li> <li title="load_nif-2"><a href="erlang.html#load_nif-2">load_nif/2</a></li> <li title="loaded-0"><a href="erlang.html#loaded-0">loaded/0</a></li> <li title="localtime-0"><a href="erlang.html#localtime-0">localtime/0</a></li> <li title="localtime_to_universaltime-1"><a href="erlang.html#localtime_to_universaltime-1">localtime_to_universaltime/1</a></li> <li title="localtime_to_universaltime-2"><a href="erlang.html#localtime_to_universaltime-2">localtime_to_universaltime/2</a></li> <li title="make_ref-0"><a href="erlang.html#make_ref-0">make_ref/0</a></li> <li title="make_tuple-2"><a href="erlang.html#make_tuple-2">make_tuple/2</a></li> <li title="make_tuple-3"><a href="erlang.html#make_tuple-3">make_tuple/3</a></li> <li title="max-2"><a href="erlang.html#max-2">max/2</a></li> <li title="md5-1"><a href="erlang.html#md5-1">md5/1</a></li> <li title="md5_final-1"><a href="erlang.html#md5_final-1">md5_final/1</a></li> <li title="md5_init-0"><a href="erlang.html#md5_init-0">md5_init/0</a></li> <li title="md5_update-2"><a href="erlang.html#md5_update-2">md5_update/2</a></li> <li title="memory-0"><a href="erlang.html#memory-0">memory/0</a></li> <li title="memory-1"><a href="erlang.html#memory-1">memory/1</a></li> <li title="min-2"><a href="erlang.html#min-2">min/2</a></li> <li title="module_loaded-1"><a href="erlang.html#module_loaded-1">module_loaded/1</a></li> <li title="monitor-2"><a href="erlang.html#monitor-2">monitor/2</a></li> <li title="monitor_node-2"><a href="erlang.html#monitor_node-2">monitor_node/2</a></li> <li title="monitor_node-3"><a href="erlang.html#monitor_node-3">monitor_node/3</a></li> <li title="nif_error-1"><a href="erlang.html#nif_error-1">nif_error/1</a></li> <li title="nif_error-2"><a href="erlang.html#nif_error-2">nif_error/2</a></li> <li title="node-0"><a href="erlang.html#node-0">node/0</a></li> <li title="node-1"><a href="erlang.html#node-1">node/1</a></li> <li title="nodes-0"><a href="erlang.html#nodes-0">nodes/0</a></li> <li title="nodes-1"><a href="erlang.html#nodes-1">nodes/1</a></li> <li title="now-0"><a href="erlang.html#now-0">now/0</a></li> <li title="open_port-2"><a href="erlang.html#open_port-2">open_port/2</a></li> <li title="phash-2"><a href="erlang.html#phash-2">phash/2</a></li> <li title="phash2-1"><a href="erlang.html#phash2-1">phash2/1</a></li> <li title="pid_to_list-1"><a href="erlang.html#pid_to_list-1">pid_to_list/1</a></li> <li title="port_close-1"><a href="erlang.html#port_close-1">port_close/1</a></li> <li title="port_command-2"><a href="erlang.html#port_command-2">port_command/2</a></li> <li title="port_command-3"><a href="erlang.html#port_command-3">port_command/3</a></li> <li title="port_connect-2"><a href="erlang.html#port_connect-2">port_connect/2</a></li> <li title="port_control-3"><a href="erlang.html#port_control-3">port_control/3</a></li> <li title="port_call-3"><a href="erlang.html#port_call-3">port_call/3</a></li> <li title="port_info-1"><a href="erlang.html#port_info-1">port_info/1</a></li> <li title="port_info-2"><a href="erlang.html#port_info-2">port_info/2</a></li> <li title="port_to_list-1"><a href="erlang.html#port_to_list-1">port_to_list/1</a></li> <li title="ports-0"><a href="erlang.html#ports-0">ports/0</a></li> <li title="pre_loaded-0"><a href="erlang.html#pre_loaded-0">pre_loaded/0</a></li> <li title="process_display-2"><a href="erlang.html#process_display-2">process_display/2</a></li> <li title="process_flag-2"><a href="erlang.html#process_flag-2">process_flag/2</a></li> <li title="process_flag-3"><a href="erlang.html#process_flag-3">process_flag/3</a></li> <li title="process_info-1"><a href="erlang.html#process_info-1">process_info/1</a></li> <li title="process_info-2"><a href="erlang.html#process_info-2">process_info/2</a></li> <li title="processes-0"><a href="erlang.html#processes-0">processes/0</a></li> <li title="purge_module-1"><a href="erlang.html#purge_module-1">purge_module/1</a></li> <li title="put-2"><a href="erlang.html#put-2">put/2</a></li> <li title="raise-3"><a href="erlang.html#raise-3">raise/3</a></li> <li title="read_timer-1"><a href="erlang.html#read_timer-1">read_timer/1</a></li> <li title="ref_to_list-1"><a href="erlang.html#ref_to_list-1">ref_to_list/1</a></li> <li title="register-2"><a href="erlang.html#register-2">register/2</a></li> <li title="registered-0"><a href="erlang.html#registered-0">registered/0</a></li> <li title="resume_process-1"><a href="erlang.html#resume_process-1">resume_process/1</a></li> <li title="round-1"><a href="erlang.html#round-1">round/1</a></li> <li title="self-0"><a href="erlang.html#self-0">self/0</a></li> <li title="send-2"><a href="erlang.html#send-2">send/2</a></li> <li title="send-3"><a href="erlang.html#send-3">send/3</a></li> <li title="send_after-3"><a href="erlang.html#send_after-3">send_after/3</a></li> <li title="send_nosuspend-2"><a href="erlang.html#send_nosuspend-2">send_nosuspend/2</a></li> <li title="send_nosuspend-3"><a href="erlang.html#send_nosuspend-3">send_nosuspend/3</a></li> <li title="set_cookie-2"><a href="erlang.html#set_cookie-2">set_cookie/2</a></li> <li title="setelement-3"><a href="erlang.html#setelement-3">setelement/3</a></li> <li title="size-1"><a href="erlang.html#size-1">size/1</a></li> <li title="spawn-1"><a href="erlang.html#spawn-1">spawn/1</a></li> <li title="spawn-2"><a href="erlang.html#spawn-2">spawn/2</a></li> <li title="spawn-3"><a href="erlang.html#spawn-3">spawn/3</a></li> <li title="spawn-4"><a href="erlang.html#spawn-4">spawn/4</a></li> <li title="spawn_link-1"><a href="erlang.html#spawn_link-1">spawn_link/1</a></li> <li title="spawn_link-2"><a href="erlang.html#spawn_link-2">spawn_link/2</a></li> <li title="spawn_link-3"><a href="erlang.html#spawn_link-3">spawn_link/3</a></li> <li title="spawn_link-4"><a href="erlang.html#spawn_link-4">spawn_link/4</a></li> <li title="spawn_monitor-1"><a href="erlang.html#spawn_monitor-1">spawn_monitor/1</a></li> <li title="spawn_monitor-3"><a href="erlang.html#spawn_monitor-3">spawn_monitor/3</a></li> <li title="spawn_opt-2"><a href="erlang.html#spawn_opt-2">spawn_opt/2</a></li> <li title="spawn_opt-3"><a href="erlang.html#spawn_opt-3">spawn_opt/3</a></li> <li title="spawn_opt-4"><a href="erlang.html#spawn_opt-4">spawn_opt/4</a></li> <li title="spawn_opt-5"><a href="erlang.html#spawn_opt-5">spawn_opt/5</a></li> <li title="split_binary-2"><a href="erlang.html#split_binary-2">split_binary/2</a></li> <li title="start_timer-3"><a href="erlang.html#start_timer-3">start_timer/3</a></li> <li title="statistics-1"><a href="erlang.html#statistics-1">statistics/1</a></li> <li title="suspend_process-2"><a href="erlang.html#suspend_process-2">suspend_process/2</a></li> <li title="suspend_process-1"><a href="erlang.html#suspend_process-1">suspend_process/1</a></li> <li title="system_flag-2"><a href="erlang.html#system_flag-2">system_flag/2</a></li> <li title="system_info-1"><a href="erlang.html#system_info-1">system_info/1</a></li> <li title="system_monitor-0"><a href="erlang.html#system_monitor-0">system_monitor/0</a></li> <li title="system_monitor-1"><a href="erlang.html#system_monitor-1">system_monitor/1</a></li> <li title="system_monitor-2"><a href="erlang.html#system_monitor-2">system_monitor/2</a></li> <li title="system_profile-0"><a href="erlang.html#system_profile-0">system_profile/0</a></li> <li title="system_profile-2"><a href="erlang.html#system_profile-2">system_profile/2</a></li> <li title="term_to_binary-1"><a href="erlang.html#term_to_binary-1">term_to_binary/1</a></li> <li title="term_to_binary-2"><a href="erlang.html#term_to_binary-2">term_to_binary/2</a></li> <li title="throw-1"><a href="erlang.html#throw-1">throw/1</a></li> <li title="time-0"><a href="erlang.html#time-0">time/0</a></li> <li title="tl-1"><a href="erlang.html#tl-1">tl/1</a></li> <li title="trace-3"><a href="erlang.html#trace-3">trace/3</a></li> <li title="trace_delivered-1"><a href="erlang.html#trace_delivered-1">trace_delivered/1</a></li> <li title="trace_info-2"><a href="erlang.html#trace_info-2">trace_info/2</a></li> <li title="trace_pattern-2"><a href="erlang.html#trace_pattern-2">trace_pattern/2</a></li> <li title="trace_pattern-3"><a href="erlang.html#trace_pattern-3">trace_pattern/3</a></li> <li title="trunc-1"><a href="erlang.html#trunc-1">trunc/1</a></li> <li title="tuple_size-1"><a href="erlang.html#tuple_size-1">tuple_size/1</a></li> <li title="tuple_to_list-1"><a href="erlang.html#tuple_to_list-1">tuple_to_list/1</a></li> <li title="universaltime-0"><a href="erlang.html#universaltime-0">universaltime/0</a></li> <li title="universaltime_to_localtime-1"><a href="erlang.html#universaltime_to_localtime-1">universaltime_to_localtime/1</a></li> <li title="unlink-1"><a href="erlang.html#unlink-1">unlink/1</a></li> <li title="unregister-1"><a href="erlang.html#unregister-1">unregister/1</a></li> <li title="whereis-1"><a href="erlang.html#whereis-1">whereis/1</a></li> <li title="yield-0"><a href="erlang.html#yield-0">yield/0</a></li> </ul> </li> <li id="no" title="init " expanded="false">init<ul> <li><a href="init.html"> Top of manual page </a></li> <li title="boot-1"><a href="init.html#boot-1">boot/1</a></li> <li title="get_argument-1"><a href="init.html#get_argument-1">get_argument/1</a></li> <li title="get_arguments-0"><a href="init.html#get_arguments-0">get_arguments/0</a></li> <li title="get_plain_arguments-0"><a href="init.html#get_plain_arguments-0">get_plain_arguments/0</a></li> <li title="get_status-0"><a href="init.html#get_status-0">get_status/0</a></li> <li title="reboot-0"><a href="init.html#reboot-0">reboot/0</a></li> <li title="restart-0"><a href="init.html#restart-0">restart/0</a></li> <li title="script_id-0"><a href="init.html#script_id-0">script_id/0</a></li> <li title="stop-0"><a href="init.html#stop-0">stop/0</a></li> <li title="stop-1"><a href="init.html#stop-1">stop/1</a></li> </ul> </li> <li id="no" title="zlib " expanded="false">zlib<ul> <li><a href="zlib.html"> Top of manual page </a></li> <li title="open-0"><a href="zlib.html#open-0">open/0</a></li> <li title="close-1"><a href="zlib.html#close-1">close/1</a></li> <li title="deflateInit-1"><a href="zlib.html#deflateInit-1">deflateInit/1</a></li> <li title="deflateInit-2"><a href="zlib.html#deflateInit-2">deflateInit/2</a></li> <li title="deflateInit-6"><a href="zlib.html#deflateInit-6">deflateInit/6</a></li> <li title="deflate-2"><a href="zlib.html#deflate-2">deflate/2</a></li> <li title="deflate-3"><a href="zlib.html#deflate-3">deflate/3</a></li> <li title="deflateSetDictionary-2"><a href="zlib.html#deflateSetDictionary-2">deflateSetDictionary/2</a></li> <li title="deflateReset-1"><a href="zlib.html#deflateReset-1">deflateReset/1</a></li> <li title="deflateParams-3"><a href="zlib.html#deflateParams-3">deflateParams/3</a></li> <li title="deflateEnd-1"><a href="zlib.html#deflateEnd-1">deflateEnd/1</a></li> <li title="inflateInit-1"><a href="zlib.html#inflateInit-1">inflateInit/1</a></li> <li title="inflateInit-2"><a href="zlib.html#inflateInit-2">inflateInit/2</a></li> <li title="inflate-2"><a href="zlib.html#inflate-2">inflate/2</a></li> <li title="inflateSetDictionary-2"><a href="zlib.html#inflateSetDictionary-2">inflateSetDictionary/2</a></li> <li title="inflateReset-1"><a href="zlib.html#inflateReset-1">inflateReset/1</a></li> <li title="inflateEnd-1"><a href="zlib.html#inflateEnd-1">inflateEnd/1</a></li> <li title="setBufSize-2"><a href="zlib.html#setBufSize-2">setBufSize/2</a></li> <li title="getBufSize-1"><a href="zlib.html#getBufSize-1">getBufSize/1</a></li> <li title="crc32-1"><a href="zlib.html#crc32-1">crc32/1</a></li> <li title="crc32-2"><a href="zlib.html#crc32-2">crc32/2</a></li> <li title="crc32-3"><a href="zlib.html#crc32-3">crc32/3</a></li> <li title="crc32_combine-4"><a href="zlib.html#crc32_combine-4">crc32_combine/4</a></li> <li title="adler32-2"><a href="zlib.html#adler32-2">adler32/2</a></li> <li title="adler32-3"><a href="zlib.html#adler32-3">adler32/3</a></li> <li title="adler32_combine-4"><a href="zlib.html#adler32_combine-4">adler32_combine/4</a></li> <li title="compress-1"><a href="zlib.html#compress-1">compress/1</a></li> <li title="uncompress-1"><a href="zlib.html#uncompress-1">uncompress/1</a></li> <li title="zip-1"><a href="zlib.html#zip-1">zip/1</a></li> <li title="unzip-1"><a href="zlib.html#unzip-1">unzip/1</a></li> <li title="gzip-1"><a href="zlib.html#gzip-1">gzip/1</a></li> <li title="gunzip-1"><a href="zlib.html#gunzip-1">gunzip/1</a></li> </ul> </li> <li title="epmd"><a href="epmd.html">epmd</a></li> <li title="erl"><a href="erl.html">erl</a></li> <li title="erlc"><a href="erlc.html">erlc</a></li> <li title="werl"><a href="werl.html">werl</a></li> <li title="escript"><a href="escript.html">escript</a></li> <li title="erlsrv"><a href="erlsrv.html">erlsrv</a></li> <li title="start_erl"><a href="start_erl.html">start_erl</a></li> <li id="no" title="erl_set_memory_block " expanded="false">erl_set_memory_block<ul> <li><a href="erl_set_memory_block.html"> Top of manual page </a></li> <li title="erl_set_memory_block"><a href="erl_set_memory_block.html#erl_set_memory_block">erl_set_memory_block() </a></li> <li title="erl_memory_show"><a href="erl_set_memory_block.html#erl_memory_show">erl_memory_show() </a></li> <li title="erl_mem_info_get"><a href="erl_set_memory_block.html#erl_mem_info_get">erl_mem_info_get() </a></li> </ul> </li> <li title="run_erl"><a href="run_erl.html">run_erl</a></li> <li title="start"><a href="start.html">start</a></li> <li id="no" title="erl_driver " expanded="false">erl_driver<ul> <li><a href="erl_driver.html"> Top of manual page </a></li> <li title="driver_system_info"><a href="erl_driver.html#driver_system_info">driver_system_info() </a></li> <li title="driver_output"><a href="erl_driver.html#driver_output">driver_output() </a></li> <li title="driver_output2"><a href="erl_driver.html#driver_output2">driver_output2() </a></li> <li title="driver_output_binary"><a href="erl_driver.html#driver_output_binary">driver_output_binary() </a></li> <li title="driver_outputv"><a href="erl_driver.html#driver_outputv">driver_outputv() </a></li> <li title="driver_vec_to_buf"><a href="erl_driver.html#driver_vec_to_buf">driver_vec_to_buf() </a></li> <li title="driver_set_timer"><a href="erl_driver.html#driver_set_timer">driver_set_timer() </a></li> <li title="driver_cancel_timer"><a href="erl_driver.html#driver_cancel_timer">driver_cancel_timer() </a></li> <li title="driver_read_timer"><a href="erl_driver.html#driver_read_timer">driver_read_timer() </a></li> <li title="driver_get_now"><a href="erl_driver.html#driver_get_now">driver_get_now() </a></li> <li title="driver_select"><a href="erl_driver.html#driver_select">driver_select() </a></li> <li title="driver_alloc"><a href="erl_driver.html#driver_alloc">driver_alloc() </a></li> <li title="driver_realloc"><a href="erl_driver.html#driver_realloc">driver_realloc() </a></li> <li title="driver_free"><a href="erl_driver.html#driver_free">driver_free() </a></li> <li title="driver_alloc_binary"><a href="erl_driver.html#driver_alloc_binary">driver_alloc_binary() </a></li> <li title="driver_realloc_binary"><a href="erl_driver.html#driver_realloc_binary">driver_realloc_binary() </a></li> <li title="driver_free_binary"><a href="erl_driver.html#driver_free_binary">driver_free_binary() </a></li> <li title="driver_binary_get_refc"><a href="erl_driver.html#driver_binary_get_refc">driver_binary_get_refc() </a></li> <li title="driver_binary_inc_refc"><a href="erl_driver.html#driver_binary_inc_refc">driver_binary_inc_refc() </a></li> <li title="driver_binary_dec_refc"><a href="erl_driver.html#driver_binary_dec_refc">driver_binary_dec_refc() </a></li> <li title="driver_enq"><a href="erl_driver.html#driver_enq">driver_enq() </a></li> <li title="driver_pushq"><a href="erl_driver.html#driver_pushq">driver_pushq() </a></li> <li title="driver_deq"><a href="erl_driver.html#driver_deq">driver_deq() </a></li> <li title="driver_sizeq"><a href="erl_driver.html#driver_sizeq">driver_sizeq() </a></li> <li title="driver_enq_bin"><a href="erl_driver.html#driver_enq_bin">driver_enq_bin() </a></li> <li title="driver_pushq_bin"><a href="erl_driver.html#driver_pushq_bin">driver_pushq_bin() </a></li> <li title="driver_peekqv"><a href="erl_driver.html#driver_peekqv">driver_peekqv() </a></li> <li title="driver_peekq"><a href="erl_driver.html#driver_peekq">driver_peekq() </a></li> <li title="driver_enqv"><a href="erl_driver.html#driver_enqv">driver_enqv() </a></li> <li title="driver_pushqv"><a href="erl_driver.html#driver_pushqv">driver_pushqv() </a></li> <li title="driver_pdl_create"><a href="erl_driver.html#driver_pdl_create">driver_pdl_create() </a></li> <li title="driver_pdl_lock"><a href="erl_driver.html#driver_pdl_lock">driver_pdl_lock() </a></li> <li title="driver_pdl_unlock"><a href="erl_driver.html#driver_pdl_unlock">driver_pdl_unlock() </a></li> <li title="driver_pdl_get_refc"><a href="erl_driver.html#driver_pdl_get_refc">driver_pdl_get_refc() </a></li> <li title="driver_pdl_inc_refc"><a href="erl_driver.html#driver_pdl_inc_refc">driver_pdl_inc_refc() </a></li> <li title="driver_pdl_dec_refc"><a href="erl_driver.html#driver_pdl_dec_refc">driver_pdl_dec_refc() </a></li> <li title="driver_monitor_process"><a href="erl_driver.html#driver_monitor_process">driver_monitor_process() </a></li> <li title="driver_demonitor_process"><a href="erl_driver.html#driver_demonitor_process">driver_demonitor_process() </a></li> <li title="driver_get_monitored_process"><a href="erl_driver.html#driver_get_monitored_process">driver_get_monitored_process() </a></li> <li title="driver_compare_monitors"><a href="erl_driver.html#driver_compare_monitors">driver_compare_monitors() </a></li> <li title="add_driver_entry"><a href="erl_driver.html#add_driver_entry">add_driver_entry() </a></li> <li title="remove_driver_entry"><a href="erl_driver.html#remove_driver_entry">remove_driver_entry() </a></li> <li title="erl_errno_id"><a href="erl_driver.html#erl_errno_id">erl_errno_id() </a></li> <li title="set_busy_port"><a href="erl_driver.html#set_busy_port">set_busy_port() </a></li> <li title="set_port_control_flags"><a href="erl_driver.html#set_port_control_flags">set_port_control_flags() </a></li> <li title="driver_failure_eof"><a href="erl_driver.html#driver_failure_eof">driver_failure_eof() </a></li> <li title="driver_failure_atom"><a href="erl_driver.html#driver_failure_atom">driver_failure_atom() </a></li> <li title="driver_failure_posix"><a href="erl_driver.html#driver_failure_posix">driver_failure_posix() </a></li> <li title="driver_failure"><a href="erl_driver.html#driver_failure">driver_failure() </a></li> <li title="driver_connected"><a href="erl_driver.html#driver_connected">driver_connected() </a></li> <li title="driver_caller"><a href="erl_driver.html#driver_caller">driver_caller() </a></li> <li title="driver_output_term"><a href="erl_driver.html#driver_output_term">driver_output_term() </a></li> <li title="driver_mk_atom"><a href="erl_driver.html#driver_mk_atom">driver_mk_atom() </a></li> <li title="driver_mk_port"><a href="erl_driver.html#driver_mk_port">driver_mk_port() </a></li> <li title="driver_send_term"><a href="erl_driver.html#driver_send_term">driver_send_term() </a></li> <li title="driver_async "><a href="erl_driver.html#driver_async%20">driver_async () </a></li> <li title="driver_async_cancel"><a href="erl_driver.html#driver_async_cancel">driver_async_cancel() </a></li> <li title="driver_lock_driver"><a href="erl_driver.html#driver_lock_driver">driver_lock_driver() </a></li> <li title="driver_create_port"><a href="erl_driver.html#driver_create_port">driver_create_port() </a></li> <li title="erl_drv_thread_create"><a href="erl_driver.html#erl_drv_thread_create">erl_drv_thread_create() </a></li> <li title="erl_drv_thread_opts_create"><a href="erl_driver.html#erl_drv_thread_opts_create">erl_drv_thread_opts_create() </a></li> <li title="erl_drv_thread_opts_destroy"><a href="erl_driver.html#erl_drv_thread_opts_destroy">erl_drv_thread_opts_destroy() </a></li> <li title="erl_drv_thread_exit"><a href="erl_driver.html#erl_drv_thread_exit">erl_drv_thread_exit() </a></li> <li title="erl_drv_thread_join"><a href="erl_driver.html#erl_drv_thread_join">erl_drv_thread_join() </a></li> <li title="erl_drv_thread_self"><a href="erl_driver.html#erl_drv_thread_self">erl_drv_thread_self() </a></li> <li title="erl_drv_equal_tids"><a href="erl_driver.html#erl_drv_equal_tids">erl_drv_equal_tids() </a></li> <li title="erl_drv_mutex_create"><a href="erl_driver.html#erl_drv_mutex_create">erl_drv_mutex_create() </a></li> <li title="erl_drv_mutex_destroy"><a href="erl_driver.html#erl_drv_mutex_destroy">erl_drv_mutex_destroy() </a></li> <li title="erl_drv_mutex_lock"><a href="erl_driver.html#erl_drv_mutex_lock">erl_drv_mutex_lock() </a></li> <li title="erl_drv_mutex_trylock"><a href="erl_driver.html#erl_drv_mutex_trylock">erl_drv_mutex_trylock() </a></li> <li title="erl_drv_mutex_unlock"><a href="erl_driver.html#erl_drv_mutex_unlock">erl_drv_mutex_unlock() </a></li> <li title="erl_drv_cond_create"><a href="erl_driver.html#erl_drv_cond_create">erl_drv_cond_create() </a></li> <li title="erl_drv_cond_destroy"><a href="erl_driver.html#erl_drv_cond_destroy">erl_drv_cond_destroy() </a></li> <li title="erl_drv_cond_signal"><a href="erl_driver.html#erl_drv_cond_signal">erl_drv_cond_signal() </a></li> <li title="erl_drv_cond_broadcast"><a href="erl_driver.html#erl_drv_cond_broadcast">erl_drv_cond_broadcast() </a></li> <li title="erl_drv_cond_wait"><a href="erl_driver.html#erl_drv_cond_wait">erl_drv_cond_wait() </a></li> <li title="erl_drv_rwlock_create"><a href="erl_driver.html#erl_drv_rwlock_create">erl_drv_rwlock_create() </a></li> <li title="erl_drv_rwlock_destroy"><a href="erl_driver.html#erl_drv_rwlock_destroy">erl_drv_rwlock_destroy() </a></li> <li title="erl_drv_rwlock_rlock"><a href="erl_driver.html#erl_drv_rwlock_rlock">erl_drv_rwlock_rlock() </a></li> <li title="erl_drv_rwlock_tryrlock"><a href="erl_driver.html#erl_drv_rwlock_tryrlock">erl_drv_rwlock_tryrlock() </a></li> <li title="erl_drv_rwlock_runlock"><a href="erl_driver.html#erl_drv_rwlock_runlock">erl_drv_rwlock_runlock() </a></li> <li title="erl_drv_rwlock_rwlock"><a href="erl_driver.html#erl_drv_rwlock_rwlock">erl_drv_rwlock_rwlock() </a></li> <li title="erl_drv_rwlock_tryrwlock"><a href="erl_driver.html#erl_drv_rwlock_tryrwlock">erl_drv_rwlock_tryrwlock() </a></li> <li title="erl_drv_rwlock_rwunlock"><a href="erl_driver.html#erl_drv_rwlock_rwunlock">erl_drv_rwlock_rwunlock() </a></li> <li title="erl_drv_tsd_key_create"><a href="erl_driver.html#erl_drv_tsd_key_create">erl_drv_tsd_key_create() </a></li> <li title="erl_drv_tsd_key_destroy"><a href="erl_driver.html#erl_drv_tsd_key_destroy">erl_drv_tsd_key_destroy() </a></li> <li title="erl_drv_tsd_set"><a href="erl_driver.html#erl_drv_tsd_set">erl_drv_tsd_set() </a></li> <li title="erl_drv_tsd_get"><a href="erl_driver.html#erl_drv_tsd_get">erl_drv_tsd_get() </a></li> <li title="erl_drv_putenv"><a href="erl_driver.html#erl_drv_putenv">erl_drv_putenv() </a></li> <li title="erl_drv_getenv"><a href="erl_driver.html#erl_drv_getenv">erl_drv_getenv() </a></li> </ul> </li> <li title="driver_entry"><a href="driver_entry.html">driver_entry</a></li> <li title="erts_alloc"><a href="erts_alloc.html">erts_alloc</a></li> <li id="no" title="erl_nif " expanded="false">erl_nif<ul> <li><a href="erl_nif.html"> Top of manual page </a></li> <li title="enif_alloc"><a href="erl_nif.html#enif_alloc">enif_alloc() </a></li> <li title="enif_alloc_binary"><a href="erl_nif.html#enif_alloc_binary">enif_alloc_binary() </a></li> <li title="enif_alloc_env"><a href="erl_nif.html#enif_alloc_env">enif_alloc_env() </a></li> <li title="enif_alloc_resource"><a href="erl_nif.html#enif_alloc_resource">enif_alloc_resource() </a></li> <li title="enif_clear_env"><a href="erl_nif.html#enif_clear_env">enif_clear_env() </a></li> <li title="enif_compare"><a href="erl_nif.html#enif_compare">enif_compare() </a></li> <li title="enif_cond_broadcast"><a href="erl_nif.html#enif_cond_broadcast">enif_cond_broadcast() </a></li> <li title="enif_cond_create"><a href="erl_nif.html#enif_cond_create">enif_cond_create() </a></li> <li title="enif_cond_destroy"><a href="erl_nif.html#enif_cond_destroy">enif_cond_destroy() </a></li> <li title="enif_cond_signal"><a href="erl_nif.html#enif_cond_signal">enif_cond_signal() </a></li> <li title="enif_cond_wait"><a href="erl_nif.html#enif_cond_wait">enif_cond_wait() </a></li> <li title="enif_equal_tids"><a href="erl_nif.html#enif_equal_tids">enif_equal_tids() </a></li> <li title="enif_free"><a href="erl_nif.html#enif_free">enif_free() </a></li> <li title="enif_free_env"><a href="erl_nif.html#enif_free_env">enif_free_env() </a></li> <li title="enif_get_atom"><a href="erl_nif.html#enif_get_atom">enif_get_atom() </a></li> <li title="enif_get_atom_length"><a href="erl_nif.html#enif_get_atom_length">enif_get_atom_length() </a></li> <li title="enif_get_double"><a href="erl_nif.html#enif_get_double">enif_get_double() </a></li> <li title="enif_get_int"><a href="erl_nif.html#enif_get_int">enif_get_int() </a></li> <li title="enif_get_int64"><a href="erl_nif.html#enif_get_int64">enif_get_int64() </a></li> <li title="enif_get_local_pid"><a href="erl_nif.html#enif_get_local_pid">enif_get_local_pid() </a></li> <li title="enif_get_list_cell"><a href="erl_nif.html#enif_get_list_cell">enif_get_list_cell() </a></li> <li title="enif_get_list_length"><a href="erl_nif.html#enif_get_list_length">enif_get_list_length() </a></li> <li title="enif_get_long"><a href="erl_nif.html#enif_get_long">enif_get_long() </a></li> <li title="enif_get_resource"><a href="erl_nif.html#enif_get_resource">enif_get_resource() </a></li> <li title="enif_get_string"><a href="erl_nif.html#enif_get_string">enif_get_string() </a></li> <li title="enif_get_tuple"><a href="erl_nif.html#enif_get_tuple">enif_get_tuple() </a></li> <li title="enif_get_uint"><a href="erl_nif.html#enif_get_uint">enif_get_uint() </a></li> <li title="enif_get_uint64"><a href="erl_nif.html#enif_get_uint64">enif_get_uint64() </a></li> <li title="enif_get_ulong"><a href="erl_nif.html#enif_get_ulong">enif_get_ulong() </a></li> <li title="enif_inspect_binary"><a href="erl_nif.html#enif_inspect_binary">enif_inspect_binary() </a></li> <li title="enif_inspect_iolist_as_binary"><a href="erl_nif.html#enif_inspect_iolist_as_binary">enif_inspect_iolist_as_binary() </a></li> <li title="enif_is_atom"><a href="erl_nif.html#enif_is_atom">enif_is_atom() </a></li> <li title="enif_is_binary"><a href="erl_nif.html#enif_is_binary">enif_is_binary() </a></li> <li title="enif_is_empty_list"><a href="erl_nif.html#enif_is_empty_list">enif_is_empty_list() </a></li> <li title="enif_is_exception"><a href="erl_nif.html#enif_is_exception">enif_is_exception() </a></li> <li title="enif_is_number"><a href="erl_nif.html#enif_is_number">enif_is_number() </a></li> <li title="enif_is_fun"><a href="erl_nif.html#enif_is_fun">enif_is_fun() </a></li> <li title="enif_is_identical"><a href="erl_nif.html#enif_is_identical">enif_is_identical() </a></li> <li title="enif_is_pid"><a href="erl_nif.html#enif_is_pid">enif_is_pid() </a></li> <li title="enif_is_port"><a href="erl_nif.html#enif_is_port">enif_is_port() </a></li> <li title="enif_is_ref"><a href="erl_nif.html#enif_is_ref">enif_is_ref() </a></li> <li title="enif_is_tuple"><a href="erl_nif.html#enif_is_tuple">enif_is_tuple() </a></li> <li title="enif_is_list"><a href="erl_nif.html#enif_is_list">enif_is_list() </a></li> <li title="enif_keep_resource"><a href="erl_nif.html#enif_keep_resource">enif_keep_resource() </a></li> <li title="enif_make_atom"><a href="erl_nif.html#enif_make_atom">enif_make_atom() </a></li> <li title="enif_make_atom_len"><a href="erl_nif.html#enif_make_atom_len">enif_make_atom_len() </a></li> <li title="enif_make_badarg"><a href="erl_nif.html#enif_make_badarg">enif_make_badarg() </a></li> <li title="enif_make_binary"><a href="erl_nif.html#enif_make_binary">enif_make_binary() </a></li> <li title="enif_make_copy"><a href="erl_nif.html#enif_make_copy">enif_make_copy() </a></li> <li title="enif_make_double"><a href="erl_nif.html#enif_make_double">enif_make_double() </a></li> <li title="enif_make_existing_atom"><a href="erl_nif.html#enif_make_existing_atom">enif_make_existing_atom() </a></li> <li title="enif_make_existing_atom_len"><a href="erl_nif.html#enif_make_existing_atom_len">enif_make_existing_atom_len() </a></li> <li title="enif_make_int"><a href="erl_nif.html#enif_make_int">enif_make_int() </a></li> <li title="enif_make_int64"><a href="erl_nif.html#enif_make_int64">enif_make_int64() </a></li> <li title="enif_make_list"><a href="erl_nif.html#enif_make_list">enif_make_list() </a></li> <li title="enif_make_list1"><a href="erl_nif.html#enif_make_list1">enif_make_list1() </a></li> <li title="enif_make_list2"><a href="erl_nif.html#enif_make_list2">enif_make_list2() </a></li> <li title="enif_make_list3"><a href="erl_nif.html#enif_make_list3">enif_make_list3() </a></li> <li title="enif_make_list4"><a href="erl_nif.html#enif_make_list4">enif_make_list4() </a></li> <li title="enif_make_list5"><a href="erl_nif.html#enif_make_list5">enif_make_list5() </a></li> <li title="enif_make_list6"><a href="erl_nif.html#enif_make_list6">enif_make_list6() </a></li> <li title="enif_make_list7"><a href="erl_nif.html#enif_make_list7">enif_make_list7() </a></li> <li title="enif_make_list8"><a href="erl_nif.html#enif_make_list8">enif_make_list8() </a></li> <li title="enif_make_list9"><a href="erl_nif.html#enif_make_list9">enif_make_list9() </a></li> <li title="enif_make_list_cell"><a href="erl_nif.html#enif_make_list_cell">enif_make_list_cell() </a></li> <li title="enif_make_list_from_array"><a href="erl_nif.html#enif_make_list_from_array">enif_make_list_from_array() </a></li> <li title="enif_make_reverse_list"><a href="erl_nif.html#enif_make_reverse_list">enif_make_reverse_list() </a></li> <li title="enif_make_long"><a href="erl_nif.html#enif_make_long">enif_make_long() </a></li> <li title="enif_make_new_binary"><a href="erl_nif.html#enif_make_new_binary">enif_make_new_binary() </a></li> <li title="enif_make_pid"><a href="erl_nif.html#enif_make_pid">enif_make_pid() </a></li> <li title="enif_make_ref"><a href="erl_nif.html#enif_make_ref">enif_make_ref() </a></li> <li title="enif_make_resource"><a href="erl_nif.html#enif_make_resource">enif_make_resource() </a></li> <li title="enif_make_resource_binary"><a href="erl_nif.html#enif_make_resource_binary">enif_make_resource_binary() </a></li> <li title="enif_make_string"><a href="erl_nif.html#enif_make_string">enif_make_string() </a></li> <li title="enif_make_string_len"><a href="erl_nif.html#enif_make_string_len">enif_make_string_len() </a></li> <li title="enif_make_sub_binary"><a href="erl_nif.html#enif_make_sub_binary">enif_make_sub_binary() </a></li> <li title="enif_make_tuple"><a href="erl_nif.html#enif_make_tuple">enif_make_tuple() </a></li> <li title="enif_make_tuple1"><a href="erl_nif.html#enif_make_tuple1">enif_make_tuple1() </a></li> <li title="enif_make_tuple2"><a href="erl_nif.html#enif_make_tuple2">enif_make_tuple2() </a></li> <li title="enif_make_tuple3"><a href="erl_nif.html#enif_make_tuple3">enif_make_tuple3() </a></li> <li title="enif_make_tuple4"><a href="erl_nif.html#enif_make_tuple4">enif_make_tuple4() </a></li> <li title="enif_make_tuple5"><a href="erl_nif.html#enif_make_tuple5">enif_make_tuple5() </a></li> <li title="enif_make_tuple6"><a href="erl_nif.html#enif_make_tuple6">enif_make_tuple6() </a></li> <li title="enif_make_tuple7"><a href="erl_nif.html#enif_make_tuple7">enif_make_tuple7() </a></li> <li title="enif_make_tuple8"><a href="erl_nif.html#enif_make_tuple8">enif_make_tuple8() </a></li> <li title="enif_make_tuple9"><a href="erl_nif.html#enif_make_tuple9">enif_make_tuple9() </a></li> <li title="enif_make_tuple_from_array"><a href="erl_nif.html#enif_make_tuple_from_array">enif_make_tuple_from_array() </a></li> <li title="enif_make_uint"><a href="erl_nif.html#enif_make_uint">enif_make_uint() </a></li> <li title="enif_make_uint64"><a href="erl_nif.html#enif_make_uint64">enif_make_uint64() </a></li> <li title="enif_make_ulong"><a href="erl_nif.html#enif_make_ulong">enif_make_ulong() </a></li> <li title="enif_mutex_create"><a href="erl_nif.html#enif_mutex_create">enif_mutex_create() </a></li> <li title="enif_mutex_destroy"><a href="erl_nif.html#enif_mutex_destroy">enif_mutex_destroy() </a></li> <li title="enif_mutex_lock"><a href="erl_nif.html#enif_mutex_lock">enif_mutex_lock() </a></li> <li title="enif_mutex_trylock"><a href="erl_nif.html#enif_mutex_trylock">enif_mutex_trylock() </a></li> <li title="enif_mutex_unlock"><a href="erl_nif.html#enif_mutex_unlock">enif_mutex_unlock() </a></li> <li title="enif_open_resource_type"><a href="erl_nif.html#enif_open_resource_type">enif_open_resource_type() </a></li> <li title="enif_priv_data"><a href="erl_nif.html#enif_priv_data">enif_priv_data() </a></li> <li title="enif_realloc_binary"><a href="erl_nif.html#enif_realloc_binary">enif_realloc_binary() </a></li> <li title="enif_release_binary"><a href="erl_nif.html#enif_release_binary">enif_release_binary() </a></li> <li title="enif_release_resource"><a href="erl_nif.html#enif_release_resource">enif_release_resource() </a></li> <li title="enif_rwlock_create"><a href="erl_nif.html#enif_rwlock_create">enif_rwlock_create() </a></li> <li title="enif_rwlock_destroy"><a href="erl_nif.html#enif_rwlock_destroy">enif_rwlock_destroy() </a></li> <li title="enif_rwlock_rlock"><a href="erl_nif.html#enif_rwlock_rlock">enif_rwlock_rlock() </a></li> <li title="enif_rwlock_runlock"><a href="erl_nif.html#enif_rwlock_runlock">enif_rwlock_runlock() </a></li> <li title="enif_rwlock_rwlock"><a href="erl_nif.html#enif_rwlock_rwlock">enif_rwlock_rwlock() </a></li> <li title="enif_rwlock_rwunlock"><a href="erl_nif.html#enif_rwlock_rwunlock">enif_rwlock_rwunlock() </a></li> <li title="enif_rwlock_tryrlock"><a href="erl_nif.html#enif_rwlock_tryrlock">enif_rwlock_tryrlock() </a></li> <li title="enif_rwlock_tryrwlock"><a href="erl_nif.html#enif_rwlock_tryrwlock">enif_rwlock_tryrwlock() </a></li> <li title="enif_self"><a href="erl_nif.html#enif_self">enif_self() </a></li> <li title="enif_send"><a href="erl_nif.html#enif_send">enif_send() </a></li> <li title="enif_sizeof_resource"><a href="erl_nif.html#enif_sizeof_resource">enif_sizeof_resource() </a></li> <li title="enif_system_info"><a href="erl_nif.html#enif_system_info">enif_system_info() </a></li> <li title="enif_thread_create"><a href="erl_nif.html#enif_thread_create">enif_thread_create() </a></li> <li title="enif_thread_exit"><a href="erl_nif.html#enif_thread_exit">enif_thread_exit() </a></li> <li title="enif_thread_join"><a href="erl_nif.html#enif_thread_join">enif_thread_join() </a></li> <li title="enif_thread_opts_create"><a href="erl_nif.html#enif_thread_opts_create">enif_thread_opts_create() </a></li> <li title="enif_thread_opts_destroy"><a href="erl_nif.html#enif_thread_opts_destroy">enif_thread_opts_destroy() </a></li> <li title="enif_thread_self"><a href="erl_nif.html#enif_thread_self">enif_thread_self() </a></li> <li title="enif_tsd_key_create"><a href="erl_nif.html#enif_tsd_key_create">enif_tsd_key_create() </a></li> <li title="enif_tsd_key_destroy"><a href="erl_nif.html#enif_tsd_key_destroy">enif_tsd_key_destroy() </a></li> <li title="enif_tsd_get"><a href="erl_nif.html#enif_tsd_get">enif_tsd_get() </a></li> <li title="enif_tsd_set"><a href="erl_nif.html#enif_tsd_set">enif_tsd_set() </a></li> </ul> </li> </ul> </div></div> <div id="content"> <div class="innertube"> <!-- refpage --><center><h1>erl</h1></center> <h3>COMMAND</h3> <div class="REFBODY">erl</div> <h3>COMMAND SUMMARY</h3> <div class="REFBODY">The Erlang Emulator</div> <h3>DESCRIPTION</h3> <div class="REFBODY"><p> <p>The <span class="code">erl</span> program starts an Erlang runtime system. The exact details (for example, whether <span class="code">erl</span> is a script or a program and which other programs it calls) are system-dependent.</p> <p>Windows users probably wants to use the <span class="code">werl</span> program instead, which runs in its own window with scrollbars and supports command-line editing. The <span class="code">erl</span> program on Windows provides no line editing in its shell, and on Windows 95 there is no way to scroll back to text which has scrolled off the screen. The <span class="code">erl</span> program must be used, however, in pipelines or if you want to redirect standard input or output.</p> <div class="note"> <div class="label">Note</div> <div class="content"><p><p>As of ERTS version 5.9 (OTP-R15B) the runtime system will by default <strong>not</strong> bind schedulers to logical processors. For more information see documentation of the <span class="bold_code"><a href="#+sbt">+sbt</a></span> system flag. </p> </p></div> </div> </p></div> <h3>EXPORTS</h3> <p><span class="bold_code">erl <arguments></span></p> <div class="REFBODY"><p> <p>Starts an Erlang runtime system.</p> <p>The arguments can be divided into <strong>emulator flags</strong>, <strong>flags</strong> and <strong>plain arguments</strong>:</p> <ul> <li> <p>Any argument starting with the character <span class="code">+</span> is interpreted as an <span class="bold_code"><a href="#emu_flags">emulator flag</a></span>.</p> <p>As indicated by the name, emulator flags controls the behavior of the emulator.</p> </li> <li> <p>Any argument starting with the character <span class="code">-</span> (hyphen) is interpreted as a <span class="bold_code"><a href="#init_flags">flag</a></span> which should be passed to the Erlang part of the runtime system, more specifically to the <span class="code">init</span> system process, see <span class="bold_code"><a href="init.html">init(3)</a></span>.</p> <p>The <span class="code">init</span> process itself interprets some of these flags, the <strong>init flags</strong>. It also stores any remaining flags, the <strong>user flags</strong>. The latter can be retrieved by calling <span class="code">init:get_argument/1</span>.</p> <p>It can be noted that there are a small number of "-" flags which now actually are emulator flags, see the description below.</p> </li> <li> <p>Plain arguments are not interpreted in any way. They are also stored by the <span class="code">init</span> process and can be retrieved by calling <span class="code">init:get_plain_arguments/0</span>. Plain arguments can occur before the first flag, or after a <span class="code">--</span> flag. Additionally, the flag <span class="code">-extra</span> causes everything that follows to become plain arguments.</p> </li> </ul> <p>Example:</p> <div class="example"><pre> % <span class="bold_code">erl +W w -sname arnie +R 9 -s my_init -extra +bertie</span> (arnie@host)1> <span class="bold_code">init:get_argument(sname).</span> {ok,[["arnie"]]} (arnie@host)2> <span class="bold_code">init:get_plain_arguments().</span> ["+bertie"]</pre></div> <p>Here <span class="code">+W w</span> and <span class="code">+R 9</span> are emulator flags. <span class="code">-s my_init</span> is an init flag, interpreted by <span class="code">init</span>. <span class="code">-sname arnie</span> is a user flag, stored by <span class="code">init</span>. It is read by Kernel and will cause the Erlang runtime system to become distributed. Finally, everything after <span class="code">-extra</span> (that is, <span class="code">+bertie</span>) is considered as plain arguments.</p> <div class="example"><pre> % <span class="bold_code">erl -myflag 1</span> 1> <span class="bold_code">init:get_argument(myflag).</span> {ok,[["1"]]} 2> <span class="bold_code">init:get_plain_arguments().</span> []</pre></div> <p>Here the user flag <span class="code">-myflag 1</span> is passed to and stored by the <span class="code">init</span> process. It is a user defined flag, presumably used by some user defined application.</p> </p></div> <h3><a name="id153409">Flags</a></h3> <div class="REFBODY"> <a name="init_flags"></a> <p>In the following list, init flags are marked (init flag). Unless otherwise specified, all other flags are user flags, for which the values can be retrieved by calling <span class="code">init:get_argument/1</span>. Note that the list of user flags is not exhaustive, there may be additional, application specific flags which instead are documented in the corresponding application documentation.</p> <dl> <dt><strong><span class="code">--</span>(init flag)</strong></dt> <dd> <p>Everything following <span class="code">--</span> up to the next flag (<span class="code">-flag</span> or <span class="code">+flag</span>) is considered plain arguments and can be retrieved using <span class="code">init:get_plain_arguments/0</span>.</p> </dd> <dt><strong><span class="code">-Application Par Val</span></strong></dt> <dd> <p>Sets the application configuration parameter <span class="code">Par</span> to the value <span class="code">Val</span> for the application <span class="code">Application</span>, see <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','app.html');">app(4)</a></span> and <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','application.html');">application(3)</a></span>.</p> </dd> <dt><strong><a name="args_file"><span class="code">-args_file FileName</span></a></strong></dt> <dd> <p>Command line arguments are read from the file <span class="code">FileName</span>. The arguments read from the file replace the '<span class="code">-args_file FileName</span>' flag on the resulting command line.</p> <p>The file <span class="code">FileName</span> should be a plain text file and may contain comments and command line arguments. A comment begins with a # character and continues until next end of line character. Backslash (\\) is used as quoting character. All command line arguments accepted by <span class="code">erl</span> are allowed, also the <span class="code">-args_file FileName</span> flag. Be careful not to cause circular dependencies between files containing the <span class="code">-args_file</span> flag, though.</p> <p>The <span class="code">-extra</span> flag is treated specially. Its scope ends at the end of the file. Arguments following an <span class="code">-extra</span> flag are moved on the command line into the <span class="code">-extra</span> section, i.e. the end of the command line following after an <span class="code">-extra</span> flag.</p> </dd> <dt><strong><span class="code">-async_shell_start</span></strong></dt> <dd> <p>The initial Erlang shell does not read user input until the system boot procedure has been completed (Erlang 5.4 and later). This flag disables the start synchronization feature and lets the shell start in parallel with the rest of the system.</p> </dd> <dt><strong><span class="code">-boot File</span></strong></dt> <dd> <p>Specifies the name of the boot file, <span class="code">File.boot</span>, which is used to start the system. See <span class="bold_code"><a href="init.html">init(3)</a></span>. Unless <span class="code">File</span> contains an absolute path, the system searches for <span class="code">File.boot</span> in the current and <span class="code">$ROOT/bin</span> directories.</p> <p>Defaults to <span class="code">$ROOT/bin/start.boot</span>.</p> </dd> <dt><strong><span class="code">-boot_var Var Dir</span></strong></dt> <dd> <p>If the boot script contains a path variable <span class="code">Var</span> other than <span class="code">$ROOT</span>, this variable is expanded to <span class="code">Dir</span>. Used when applications are installed in another directory than <span class="code">$ROOT/lib</span>, see <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','sasl','systools.html#make_script-1');">systools:make_script/1,2</a></span>.</p> </dd> <dt><strong><span class="code">-code_path_cache</span></strong></dt> <dd> <p>Enables the code path cache of the code server, see <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','code.html');">code(3)</a></span>.</p> </dd> <dt><strong><span class="code">-compile Mod1 Mod2 ...</span></strong></dt> <dd> <p>Compiles the specified modules and then terminates (with non-zero exit code if the compilation of some file did not succeed). Implies <span class="code">-noinput</span>. Not recommended - use <span class="bold_code"><a href="erlc.html">erlc</a></span> instead.</p> </dd> <dt><strong><span class="code">-config Config</span></strong></dt> <dd> <p>Specifies the name of a configuration file, <span class="code">Config.config</span>, which is used to configure applications. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','app.html');">app(4)</a></span> and <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','application.html');">application(3)</a></span>.</p> </dd> <dt><strong><a name="connect_all"><span class="code">-connect_all false</span></a></strong></dt> <dd> <p>If this flag is present, <span class="code">global</span> will not maintain a fully connected network of distributed Erlang nodes, and then global name registration cannot be used. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','global.html');">global(3)</a></span>.</p> </dd> <dt><strong><span class="code">-cookie Cookie</span></strong></dt> <dd> <p>Obsolete flag without any effect and common misspelling for <span class="code">-setcookie</span>. Use <span class="code">-setcookie</span> instead.</p> </dd> <dt><strong><span class="code">-detached</span></strong></dt> <dd> <p>Starts the Erlang runtime system detached from the system console. Useful for running daemons and backgrounds processes. Implies <span class="code">-noinput</span>.</p> </dd> <dt><strong><span class="code">-emu_args</span></strong></dt> <dd> <p>Useful for debugging. Prints out the actual arguments sent to the emulator.</p> </dd> <dt><strong><span class="code">-env Variable Value</span></strong></dt> <dd> <p>Sets the host OS environment variable <span class="code">Variable</span> to the value <span class="code">Value</span> for the Erlang runtime system. Example:</p> <div class="example"><pre> % <span class="bold_code">erl -env DISPLAY gin:0</span></pre></div> <p>In this example, an Erlang runtime system is started with the <span class="code">DISPLAY</span> environment variable set to <span class="code">gin:0</span>.</p> </dd> <dt><strong><span class="code">-eval Expr</span>(init flag)</strong></dt> <dd> <p>Makes <span class="code">init</span> evaluate the expression <span class="code">Expr</span>, see <span class="bold_code"><a href="init.html">init(3)</a></span>.</p> </dd> <dt><strong><span class="code">-extra</span>(init flag)</strong></dt> <dd> <p>Everything following <span class="code">-extra</span> is considered plain arguments and can be retrieved using <span class="code">init:get_plain_arguments/0</span>.</p> </dd> <dt><strong><span class="code">-heart</span></strong></dt> <dd> <p>Starts heart beat monitoring of the Erlang runtime system. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','heart.html');">heart(3)</a></span>.</p> </dd> <dt><strong><span class="code">-hidden</span></strong></dt> <dd> <p>Starts the Erlang runtime system as a hidden node, if it is run as a distributed node. Hidden nodes always establish hidden connections to all other nodes except for nodes in the same global group. Hidden connections are not published on either of the connected nodes, i.e. neither of the connected nodes are part of the result from <span class="code">nodes/0</span> on the other node. See also hidden global groups, <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','global_group.html');">global_group(3)</a></span>.</p> </dd> <dt><strong><span class="code">-hosts Hosts</span></strong></dt> <dd> <p>Specifies the IP addresses for the hosts on which Erlang boot servers are running, see <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','erl_boot_server.html');">erl_boot_server(3)</a></span>. This flag is mandatory if the <span class="code">-loader inet</span> flag is present.</p> <p>The IP addresses must be given in the standard form (four decimal numbers separated by periods, for example <span class="code">"150.236.20.74"</span>. Hosts names are not acceptable, but a broadcast address (preferably limited to the local network) is.</p> </dd> <dt><strong><span class="code">-id Id</span></strong></dt> <dd> <p>Specifies the identity of the Erlang runtime system. If it is run as a distributed node, <span class="code">Id</span> must be identical to the name supplied together with the <span class="code">-sname</span> or <span class="code">-name</span> flag.</p> </dd> <dt><strong><span class="code">-init_debug</span></strong></dt> <dd> <p>Makes <span class="code">init</span> write some debug information while interpreting the boot script.</p> </dd> <dt><strong><a name="instr"><span class="code">-instr</span>(emulator flag)</a></strong></dt> <dd> <p>Selects an instrumented Erlang runtime system (virtual machine) to run, instead of the ordinary one. When running an instrumented runtime system, some resource usage data can be obtained and analysed using the module <span class="code">instrument</span>. Functionally, it behaves exactly like an ordinary Erlang runtime system.</p> </dd> <dt><strong><span class="code">-loader Loader</span></strong></dt> <dd> <p>Specifies the method used by <span class="code">erl_prim_loader</span> to load Erlang modules into the system. See <span class="bold_code"><a href="erl_prim_loader.html">erl_prim_loader(3)</a></span>. Two <span class="code">Loader</span> methods are supported, <span class="code">efile</span> and <span class="code">inet</span>. <span class="code">efile</span> means use the local file system, this is the default. <span class="code">inet</span> means use a boot server on another machine, and the <span class="code">-id</span>, <span class="code">-hosts</span> and <span class="code">-setcookie</span> flags must be specified as well. If <span class="code">Loader</span> is something else, the user supplied <span class="code">Loader</span> port program is started.</p> </dd> <dt><strong><span class="code">-make</span></strong></dt> <dd> <p>Makes the Erlang runtime system invoke <span class="code">make:all()</span> in the current working directory and then terminate. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','tools','make.html');">make(3)</a></span>. Implies <span class="code">-noinput</span>.</p> </dd> <dt><strong><span class="code">-man Module</span></strong></dt> <dd> <p>Displays the manual page for the Erlang module <span class="code">Module</span>. Only supported on Unix.</p> </dd> <dt><strong><span class="code">-mode interactive | embedded</span></strong></dt> <dd> <p>Indicates if the system should load code dynamically (<span class="code">interactive</span>), or if all code should be loaded during system initialization (<span class="code">embedded</span>), see <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','code.html');">code(3)</a></span>. Defaults to <span class="code">interactive</span>.</p> </dd> <dt><strong><span class="code">-name Name</span></strong></dt> <dd> <p>Makes the Erlang runtime system into a distributed node. This flag invokes all network servers necessary for a node to become distributed. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','net_kernel.html');">net_kernel(3)</a></span>. It is also ensured that <span class="code">epmd</span> runs on the current host before Erlang is started. See <span class="bold_code"><a href="epmd.html">epmd(1)</a></span>.</p> <p>The name of the node will be <span class="code">Name@Host</span>, where <span class="code">Host</span> is the fully qualified host name of the current host. For short names, use the <span class="code">-sname</span> flag instead.</p> </dd> <dt><strong><span class="code">-noinput</span></strong></dt> <dd> <p>Ensures that the Erlang runtime system never tries to read any input. Implies <span class="code">-noshell</span>.</p> </dd> <dt><strong><span class="code">-noshell</span></strong></dt> <dd> <p>Starts an Erlang runtime system with no shell. This flag makes it possible to have the Erlang runtime system as a component in a series of UNIX pipes.</p> </dd> <dt><strong><span class="code">-nostick</span></strong></dt> <dd> <p>Disables the sticky directory facility of the Erlang code server, see <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','code.html');">code(3)</a></span>.</p> </dd> <dt><strong><span class="code">-oldshell</span></strong></dt> <dd> <p>Invokes the old Erlang shell from Erlang 3.3. The old shell can still be used.</p> </dd> <dt><strong><span class="code">-pa Dir1 Dir2 ...</span></strong></dt> <dd> <p>Adds the specified directories to the beginning of the code path, similar to <span class="code">code:add_pathsa/1</span>. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','code.html');">code(3)</a></span>. As an alternative to <span class="code">-pa</span>, if several directories are to be prepended to the code and the directories have a common parent directory, that parent directory could be specified in the <span class="code">ERL_LIBS</span> environment variable. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','code.html');">code(3)</a></span>.</p> </dd> <dt><strong><span class="code">-pz Dir1 Dir2 ...</span></strong></dt> <dd> <p>Adds the specified directories to the end of the code path, similar to <span class="code">code:add_pathsz/1</span>. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','code.html');">code(3)</a></span>.</p> </dd> <dt><strong><span class="code">-remsh Node</span></strong></dt> <dd> <p>Starts Erlang with a remote shell connected to <span class="code">Node</span>.</p> </dd> <dt><strong><span class="code">-rsh Program</span></strong></dt> <dd> <p>Specifies an alternative to <span class="code">rsh</span> for starting a slave node on a remote host. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','stdlib','slave.html');">slave(3)</a></span>.</p> </dd> <dt><strong><span class="code">-run Mod [Func [Arg1, Arg2, ...]]</span>(init flag)</strong></dt> <dd> <p>Makes <span class="code">init</span> call the specified function. <span class="code">Func</span> defaults to <span class="code">start</span>. If no arguments are provided, the function is assumed to be of arity 0. Otherwise it is assumed to be of arity 1, taking the list <span class="code">[Arg1,Arg2,...]</span> as argument. All arguments are passed as strings. See <span class="bold_code"><a href="init.html">init(3)</a></span>.</p> </dd> <dt><strong><span class="code">-s Mod [Func [Arg1, Arg2, ...]]</span>(init flag)</strong></dt> <dd> <p>Makes <span class="code">init</span> call the specified function. <span class="code">Func</span> defaults to <span class="code">start</span>. If no arguments are provided, the function is assumed to be of arity 0. Otherwise it is assumed to be of arity 1, taking the list <span class="code">[Arg1,Arg2,...]</span> as argument. All arguments are passed as atoms. See <span class="bold_code"><a href="init.html">init(3)</a></span>.</p> </dd> <dt><strong><span class="code">-setcookie Cookie</span></strong></dt> <dd> <p>Sets the magic cookie of the node to <span class="code">Cookie</span>, see <span class="bold_code"><a href="erlang.html#set_cookie-2">erlang:set_cookie/2</a></span>.</p> </dd> <dt><strong><span class="code">-shutdown_time Time</span></strong></dt> <dd> <p>Specifies how long time (in milliseconds) the <span class="code">init</span> process is allowed to spend shutting down the system. If <span class="code">Time</span> ms have elapsed, all processes still existing are killed. Defaults to <span class="code">infinity</span>.</p> </dd> <dt><strong><span class="code">-sname Name</span></strong></dt> <dd> <p>Makes the Erlang runtime system into a distributed node, similar to <span class="code">-name</span>, but the host name portion of the node name <span class="code">Name@Host</span> will be the short name, not fully qualified.</p> <p>This is sometimes the only way to run distributed Erlang if the DNS (Domain Name System) is not running. There can be no communication between nodes running with the <span class="code">-sname</span> flag and those running with the <span class="code">-name</span> flag, as node names must be unique in distributed Erlang systems.</p> </dd> <dt><strong><a name="smp"><span class="code">-smp [enable|auto|disable]</span></a></strong></dt> <dd> <p><span class="code">-smp enable</span> and <span class="code">-smp</span> starts the Erlang runtime system with SMP support enabled. This may fail if no runtime system with SMP support is available. <span class="code">-smp auto</span> starts the Erlang runtime system with SMP support enabled if it is available and more than one logical processor are detected. <span class="code">-smp disable</span> starts a runtime system without SMP support.</p> <p><strong>NOTE</strong>: The runtime system with SMP support will not be available on all supported platforms. See also the <span class="bold_code"><a href="#+S">+S</a></span> flag.</p> </dd> <dt><strong><span class="code">-version</span>(emulator flag)</strong></dt> <dd> <p>Makes the emulator print out its version number. The same as <span class="code">erl +V</span>.</p> </dd> </dl> </div> <h3><a name="id154590">Emulator Flags</a></h3> <div class="REFBODY"> <a name="emu_flags"></a> <p><span class="code">erl</span> invokes the code for the Erlang emulator (virtual machine), which supports the following flags:</p> <dl> <dt><strong><a name="async_thread_stack_size"><span class="code">+a size</span></a></strong></dt> <dd> <p>Suggested stack size, in kilowords, for threads in the async-thread pool. Valid range is 16-8192 kilowords. The default suggested stack size is 16 kilowords, i.e, 64 kilobyte on 32-bit architectures. This small default size has been chosen since the amount of async-threads might be quite large. The default size is enough for drivers delivered with Erlang/OTP, but might not be sufficiently large for other dynamically linked in drivers that use the <span class="bold_code"><a href="erl_driver.html#driver_async">driver_async()</a></span> functionality. Note that the value passed is only a suggestion, and it might even be ignored on some platforms.</p> </dd> <dt><strong><a name="async_thread_pool_size"><span class="code">+A size</span></a></strong></dt> <dd> <p>Sets the number of threads in async thread pool, valid range is 0-1024. Default is 0.</p> </dd> <dt><strong><span class="code">+B [c | d | i]</span></strong></dt> <dd> <p>The <span class="code">c</span> option makes <span class="code">Ctrl-C</span> interrupt the current shell instead of invoking the emulator break handler. The <span class="code">d</span> option (same as specifying <span class="code">+B</span> without an extra option) disables the break handler. The <span class="code">i</span> option makes the emulator ignore any break signal.</p> <p>If the <span class="code">c</span> option is used with <span class="code">oldshell</span> on Unix, <span class="code">Ctrl-C</span> will restart the shell process rather than interrupt it.</p> <p>Note that on Windows, this flag is only applicable for <span class="code">werl</span>, not <span class="code">erl</span> (<span class="code">oldshell</span>). Note also that <span class="code">Ctrl-Break</span> is used instead of <span class="code">Ctrl-C</span> on Windows.</p> </dd> <dt><strong><span class="code">+c</span></strong></dt> <dd> <p>Disable compensation for sudden changes of system time.</p> <p>Normally, <span class="code">erlang:now/0</span> will not immediately reflect sudden changes in the system time, in order to keep timers (including <span class="code">receive-after</span>) working. Instead, the time maintained by <span class="code">erlang:now/0</span> is slowly adjusted towards the new system time. (Slowly means in one percent adjustments; if the time is off by one minute, the time will be adjusted in 100 minutes.)</p> <p>When the <span class="code">+c</span> option is given, this slow adjustment will not take place. Instead <span class="code">erlang:now/0</span> will always reflect the current system time. Note that timers are based on <span class="code">erlang:now/0</span>. If the system time jumps, timers then time out at the wrong time.</p> </dd> <dt><strong><span class="code">+d</span></strong></dt> <dd> <p>If the emulator detects an internal error (or runs out of memory), it will by default generate both a crash dump and a core dump. The core dump will, however, not be very useful since the content of process heaps is destroyed by the crash dump generation.</p> <p>The <span class="code">+d</span> option instructs the emulator to only produce a core dump and no crash dump if an internal error is detected.</p> <p>Calling <span class="code">erlang:halt/1</span> with a string argument will still produce a crash dump.</p> </dd> <dt><strong><span class="code">+e Number</span></strong></dt> <dd> <p>Set max number of ETS tables.</p> </dd> <dt><strong><span class="code">+ec</span></strong></dt> <dd> <p>Force the <span class="code">compressed</span> option on all ETS tables. Only intended for test and evaluation.</p> </dd> <dt><strong><a name="file_name_encoding"></a><span class="code">+fnl</span></strong></dt> <dd> <p>The VM works with file names as if they are encoded using the ISO-latin-1 encoding, disallowing Unicode characters with codepoints beyond 255. This is default on operating systems that have transparent file naming, i.e. all Unixes except MacOSX.</p> </dd> <dt><strong><span class="code">+fnu</span></strong></dt> <dd> <p>The VM works with file names as if they are encoded using UTF-8 (or some other system specific Unicode encoding). This is the default on operating systems that enforce Unicode encoding, i.e. Windows and MacOSX.</p> <p>By enabling Unicode file name translation on systems where this is not default, you open up to the possibility that some file names can not be interpreted by the VM and therefore will be returned to the program as raw binaries. The option is therefore considered experimental.</p> </dd> <dt><strong><span class="code">+fna</span></strong></dt> <dd> <p>Selection between <span class="code">+fnl</span> and <span class="code">+fnu</span> is done based on the current locale settings in the OS, meaning that if you have set your terminal for UTF-8 encoding, the filesystem is expected to use the same encoding for filenames (use with care).</p> </dd> <dt><strong><span class="code">+hms Size</span></strong></dt> <dd> <p>Sets the default heap size of processes to the size <span class="code">Size</span>.</p> </dd> <dt><strong><span class="code">+hmbs Size</span></strong></dt> <dd> <p>Sets the default binary virtual heap size of processes to the size <span class="code">Size</span>.</p> </dd> <dt><strong><span class="code">+K true | false</span></strong></dt> <dd> <p>Enables or disables the kernel poll functionality if the emulator supports it. Default is <span class="code">false</span> (disabled). If the emulator does not support kernel poll, and the <span class="code">+K</span> flag is passed to the emulator, a warning is issued at startup.</p> </dd> <dt><strong><span class="code">+l</span></strong></dt> <dd> <p>Enables auto load tracing, displaying info while loading code.</p> </dd> <dt><strong><span class="code">+L</span></strong></dt> <dd> <p>Don't load information about source filenames and line numbers. This will save some memory, but exceptions will not contain information about the filenames and line numbers. </p> </dd> <dt><strong><a name="erts_alloc"><span class="code">+MFlag Value</span></a></strong></dt> <dd> <p>Memory allocator specific flags, see <span class="bold_code"><a href="erts_alloc.html">erts_alloc(3)</a></span> for further information.</p> </dd> <dt><strong><a name="max_processes"><span class="code">+P Number</span></a></strong></dt> <dd> <p>Sets the maximum number of concurrent processes for this system. <span class="code">Number</span> must be in the range 16..134217727. Default is 32768.</p> </dd> <dt><strong><a name="compat_rel"><span class="code">+R ReleaseNumber</span></a></strong></dt> <dd> <p>Sets the compatibility mode.</p> <p>The distribution mechanism is not backwards compatible by default. This flags sets the emulator in compatibility mode with an earlier Erlang/OTP release <span class="code">ReleaseNumber</span>. The release number must be in the range <span class="code">7..<current release></span>. This limits the emulator, making it possible for it to communicate with Erlang nodes (as well as C- and Java nodes) running that earlier release.</p> <p>For example, an R10 node is not automatically compatible with an R9 node, but R10 nodes started with the <span class="code">+R 9</span> flag can co-exist with R9 nodes in the same distributed Erlang system, they are R9-compatible.</p> <p>Note: Make sure all nodes (Erlang-, C-, and Java nodes) of a distributed Erlang system is of the same Erlang/OTP release, or from two different Erlang/OTP releases X and Y, where <strong>all</strong> Y nodes have compatibility mode X.</p> <p>For example: A distributed Erlang system can consist of R10 nodes, or of R9 nodes and R9-compatible R10 nodes, but not of R9 nodes, R9-compatible R10 nodes and "regular" R10 nodes, as R9 and "regular" R10 nodes are not compatible.</p> </dd> <dt><strong><span class="code">+r</span></strong></dt> <dd> <p>Force ets memory block to be moved on realloc.</p> </dd> <dt><strong><a name="+rg"><span class="code">+rg ReaderGroupsLimit</span></a></strong></dt> <dd> <p>Limits the amount of reader groups used by read/write locks optimized for read operations in the Erlang runtime system. By default the reader groups limit equals 8.</p> <p>When the amount of schedulers is less than or equal to the reader groups limit, each scheduler has its own reader group. When the amount of schedulers is larger than the reader groups limit, schedulers share reader groups. Shared reader groups degrades read lock and read unlock performance while a large amount of reader groups degrades write lock performance, so the limit is a tradeoff between performance for read operations and performance for write operations. Each reader group currently consumes 64 byte in each read/write lock. Also note that a runtime system using shared reader groups benefits from <span class="bold_code"><a href="#+sbt">binding schedulers to logical processors</a></span>, since the reader groups are distributed better between schedulers.</p> </dd> <dt><strong><a name="+S"><span class="code">+S Schedulers:SchedulerOnline</span></a></strong></dt> <dd> <p>Sets the amount of scheduler threads to create and scheduler threads to set online when SMP support has been enabled. Valid range for both values are 1-1024. If the Erlang runtime system is able to determine the amount of logical processors configured and logical processors available, <span class="code">Schedulers</span> will default to logical processors configured, and <span class="code">SchedulersOnline</span> will default to logical processors available; otherwise, the default values will be 1. <span class="code">Schedulers</span> may be omitted if <span class="code">:SchedulerOnline</span> is not and vice versa. The amount of schedulers online can be changed at run time via <span class="bold_code"><a href="erlang.html#system_flag_schedulers_online">erlang:system_flag(schedulers_online, SchedulersOnline)</a></span>. </p> <p>This flag will be ignored if the emulator doesn't have SMP support enabled (see the <span class="bold_code"><a href="#smp">-smp</a></span> flag).</p> </dd> <dt><strong><span class="code">+sFlag Value</span></strong></dt> <dd> <p>Scheduling specific flags.</p> <dl> <dt><strong><a name="+sbt"><span class="code">+sbt BindType</span></a></strong></dt> <dd> <p>Set scheduler bind type. Currently valid <span class="code">BindType</span>s: </p> <dl> <dt><strong><span class="code">u</span></strong></dt> <dd> <p><span class="code">unbound</span> - Schedulers will not be bound to logical processors, i.e., the operating system decides where the scheduler threads execute, and when to migrate them. This is the default.</p> </dd> <dt><strong><span class="code">ns</span></strong></dt> <dd> <p><span class="code">no_spread</span> - Schedulers with close scheduler identifiers will be bound as close as possible in hardware.</p> </dd> <dt><strong><span class="code">ts</span></strong></dt> <dd> <p><span class="code">thread_spread</span> - Thread refers to hardware threads (e.g. Intel's hyper-threads). Schedulers with low scheduler identifiers, will be bound to the first hardware thread of each core, then schedulers with higher scheduler identifiers will be bound to the second hardware thread of each core, etc.</p> </dd> <dt><strong><span class="code">ps</span></strong></dt> <dd> <p><span class="code">processor_spread</span> - Schedulers will be spread like <span class="code">thread_spread</span>, but also over physical processor chips.</p> </dd> <dt><strong><span class="code">s</span></strong></dt> <dd> <p><span class="code">spread</span> - Schedulers will be spread as much as possible.</p> </dd> <dt><strong><span class="code">nnts</span></strong></dt> <dd> <p><span class="code">no_node_thread_spread</span> - Like <span class="code">thread_spread</span>, but if multiple NUMA (Non-Uniform Memory Access) nodes exists, schedulers will be spread over one NUMA node at a time, i.e., all logical processors of one NUMA node will be bound to schedulers in sequence.</p> </dd> <dt><strong><span class="code">nnps</span></strong></dt> <dd> <p><span class="code">no_node_processor_spread</span> - Like <span class="code">processor_spread</span>, but if multiple NUMA nodes exists, schedulers will be spread over one NUMA node at a time, i.e., all logical processors of one NUMA node will be bound to schedulers in sequence.</p> </dd> <dt><strong><span class="code">tnnps</span></strong></dt> <dd> <p><span class="code">thread_no_node_processor_spread</span> - A combination of <span class="code">thread_spread</span>, and <span class="code">no_node_processor_spread</span>. Schedulers will be spread over hardware threads across NUMA nodes, but schedulers will only be spread over processors internally in one NUMA node at a time.</p> </dd> <dt><strong><span class="code">db</span></strong></dt> <dd> <p><span class="code">default_bind</span> - Binds schedulers the default way. Currently the default is <span class="code">thread_no_node_processor_spread</span> (which might change in the future).</p> </dd> </dl> <p>Binding of schedulers is currently only supported on newer Linux, Solaris, FreeBSD, and Windows systems.</p> <p>If no CPU topology is available when the <span class="code">+sbt</span> flag is processed and <span class="code">BindType</span> is any other type than <span class="code">u</span>, the runtime system will fail to start. CPU topology can be defined using the <span class="bold_code"><a href="#+sct">+sct</a></span> flag. Note that the <span class="code">+sct</span> flag may have to be passed before the <span class="code">+sbt</span> flag on the command line (in case no CPU topology has been automatically detected).</p> <p>The runtime system will by default <strong>not</strong> bind schedulers to logical processors. </p> <p><strong>NOTE:</strong> If the Erlang runtime system is the only operating system process that binds threads to logical processors, this improves the performance of the runtime system. However, if other operating system processes (as for example another Erlang runtime system) also bind threads to logical processors, there might be a performance penalty instead. In some cases this performance penalty might be severe. If this is the case, you are advised to not bind the schedulers.</p> <p>How schedulers are bound matters. For example, in situations when there are fewer running processes than schedulers online, the runtime system tries to migrate processes to schedulers with low scheduler identifiers. The more the schedulers are spread over the hardware, the more resources will be available to the runtime system in such situations. </p> <p> <strong>NOTE:</strong> If a scheduler fails to bind, this will often be silently ignored. This since it isn't always possible to verify valid logical processor identifiers. If an error is reported, it will be reported to the <span class="code">error_logger</span>. If you want to verify that the schedulers actually have bound as requested, call <span class="bold_code"><a href="erlang.html#system_info_scheduler_bindings">erlang:system_info(scheduler_bindings)</a></span>. </p> </dd> <dt><strong><a name="+sbwt"><span class="code">+sbwt none|very_short|short|medium|long|very_long</span></a></strong></dt> <dd> <p>Set scheduler busy wait threshold. Default is <span class="code">medium</span>. The threshold determines how long schedulers should busy wait when running out of work before going to sleep. </p> <p><strong>NOTE:</strong> This flag may be removed or changed at any time without prior notice. </p> </dd> <dt><strong><a name="+scl"><span class="code">+scl true|false</span></a></strong></dt> <dd> <p>Enable or disable scheduler compaction of load. By default scheduler compaction of load is enabled. When enabled, load balancing will strive for a load distribution which causes as many scheduler threads as possible to be fully loaded (i.e., not run out of work). This is accomplished by migrating load (e.g. runnable processes) into a smaller set of schedulers when schedulers frequently run out of work. When disabled, the frequency with which schedulers run out of work will not be taken into account by the load balancing logic. </p> </dd> <dt><strong><a name="+sct"><span class="code">+sct CpuTopology</span></a></strong></dt> <dd> <ul> <li><span class="code"><Id> = integer(); when 0 =< <Id> =< 65535</span></li> <li><span class="code"><IdRange> = <Id>-<Id></span></li> <li><span class="code"><IdOrIdRange> = <Id> | <IdRange></span></li> <li><span class="code"><IdList> = <IdOrIdRange>,<IdOrIdRange> | <IdOrIdRange></span></li> <li><span class="code"><LogicalIds> = L<IdList></span></li> <li><span class="code"><ThreadIds> = T<IdList> | t<IdList></span></li> <li><span class="code"><CoreIds> = C<IdList> | c<IdList></span></li> <li><span class="code"><ProcessorIds> = P<IdList> | p<IdList></span></li> <li><span class="code"><NodeIds> = N<IdList> | n<IdList></span></li> <li><span class="code"><IdDefs> = <LogicalIds><ThreadIds><CoreIds><ProcessorIds><NodeIds> | <LogicalIds><ThreadIds><CoreIds><NodeIds><ProcessorIds></span></li> <li><span class="code">CpuTopology = <IdDefs>:<IdDefs> | <IdDefs></span></li> </ul> <p>Set a user defined CPU topology. The user defined CPU topology will override any automatically detected CPU topology. The CPU topology is used when <span class="bold_code"><a href="#+sbt">binding schedulers to logical processors</a></span>. </p> <p>Upper-case letters signify real identifiers and lower-case letters signify fake identifiers only used for description of the topology. Identifiers passed as real identifiers may be used by the runtime system when trying to access specific hardware and if they are not correct the behavior is undefined. Faked logical CPU identifiers are not accepted since there is no point in defining the CPU topology without real logical CPU identifiers. Thread, core, processor, and node identifiers may be left out. If left out, thread id defaults to <span class="code">t0</span>, core id defaults to <span class="code">c0</span>, processor id defaults to <span class="code">p0</span>, and node id will be left undefined. Either each logical processor must belong to one and only one NUMA node, or no logical processors must belong to any NUMA nodes. </p> <p>Both increasing and decreasing <span class="code"><IdRange></span>s are allowed.</p> <p>NUMA node identifiers are system wide. That is, each NUMA node on the system have to have a unique identifier. Processor identifiers are also system wide. Core identifiers are processor wide. Thread identifiers are core wide.</p> <p>The order of the identifier types imply the hierarchy of the CPU topology. Valid orders are either <span class="code"><LogicalIds><ThreadIds><CoreIds><ProcessorIds><NodeIds></span>, or <span class="code"><LogicalIds><ThreadIds><CoreIds><NodeIds><ProcessorIds></span>. That is, thread is part of a core which is part of a processor which is part of a NUMA node, or thread is part of a core which is part of a NUMA node which is part of a processor. A cpu topology can consist of both processor external, and processor internal NUMA nodes as long as each logical processor belongs to one and only one NUMA node. If <span class="code"><ProcessorIds></span> is left out, its default position will be before <span class="code"><NodeIds></span>. That is, the default is processor external NUMA nodes. </p> <p>If a list of identifiers is used in an <span class="code"><IdDefs></span>:</p> <ul> <li> <span class="code"><LogicalIds></span> have to be a list of identifiers.</li> <li>At least one other identifier type apart from <span class="code"><LogicalIds></span> also have to have a list of identifiers.</li> <li>All lists of identifiers have to produce the same amount of identifiers.</li> </ul> <p>A simple example. A single quad core processor may be described this way:</p> <div class="example"><pre> % <span class="bold_code">erl +sct L0-3c0-3</span> 1> <span class="bold_code">erlang:system_info(cpu_topology).</span> [{processor,[{core,{logical,0}}, {core,{logical,1}}, {core,{logical,2}}, {core,{logical,3}}]}] </pre></div> <p>A little more complicated example. Two quad core processors. Each processor in its own NUMA node. The ordering of logical processors is a little weird. This in order to give a better example of identifier lists:</p> <div class="example"><pre> % <span class="bold_code">erl +sct L0-1,3-2c0-3p0N0:L7,4,6-5c0-3p1N1</span> 1> <span class="bold_code">erlang:system_info(cpu_topology).</span> [{node,[{processor,[{core,{logical,0}}, {core,{logical,1}}, {core,{logical,3}}, {core,{logical,2}}]}]}, {node,[{processor,[{core,{logical,7}}, {core,{logical,4}}, {core,{logical,6}}, {core,{logical,5}}]}]}] </pre></div> <p>As long as real identifiers are correct it is okay to pass a CPU topology that is not a correct description of the CPU topology. When used with care this can actually be very useful. This in order to trick the emulator to bind its schedulers as you want. For example, if you want to run multiple Erlang runtime systems on the same machine, you want to reduce the amount of schedulers used and manipulate the CPU topology so that they bind to different logical CPUs. An example, with two Erlang runtime systems on a quad core machine:</p> <div class="example"><pre> % <span class="bold_code">erl +sct L0-3c0-3 +sbt db +S3:2 -detached -noinput -noshell -sname one</span> % <span class="bold_code">erl +sct L3-0c0-3 +sbt db +S3:2 -detached -noinput -noshell -sname two</span> </pre></div> <p>In this example each runtime system have two schedulers each online, and all schedulers online will run on different cores. If we change to one scheduler online on one runtime system, and three schedulers online on the other, all schedulers online will still run on different cores.</p> <p>Note that a faked CPU topology that does not reflect how the real CPU topology looks like is likely to decrease the performance of the runtime system.</p> <p>For more information, see <span class="bold_code"><a href="erlang.html#system_info_cpu_topology">erlang:system_info(cpu_topology)</a></span>.</p> </dd> <dt><strong><a name="+sws"><span class="code">+sws default|legacy|proposal</span></a></strong></dt> <dd> <p>Set scheduler wakeup strategy. Default is <span class="code">legacy</span> (has been used since OTP-R13B). The <span class="code">proposal</span> strategy is the currently proposed strategy for OTP-R16. Note that the <span class="code">proposal</span> strategy might change during OTP-R15. </p> <p><strong>NOTE:</strong> This flag may be removed or changed at any time without prior notice. </p> </dd> <dt><strong><a name="+swt"><span class="code">+swt very_low|low|medium|high|very_high</span></a></strong></dt> <dd> <p>Set scheduler wakeup threshold. Default is <span class="code">medium</span>. The threshold determines when to wake up sleeping schedulers when more work than can be handled by currently awake schedulers exist. A low threshold will cause earlier wakeups, and a high threshold will cause later wakeups. Early wakeups will distribute work over multiple schedulers faster, but work will more easily bounce between schedulers. </p> <p><strong>NOTE:</strong> This flag may be removed or changed at any time without prior notice. </p> </dd> <dt><strong><a name="sched_thread_stack_size"><span class="code">+sss size</span></a></strong></dt> <dd> <p>Suggested stack size, in kilowords, for scheduler threads. Valid range is 4-8192 kilowords. The default stack size is OS dependent.</p> </dd> </dl> </dd> <dt><strong><a name="+t"><span class="code">+t size</span></a></strong></dt> <dd> <p>Set the maximum number of atoms the VM can handle. Default is 1048576.</p> </dd> <dt><strong><a name="+T"><span class="code">+T Level</span></a></strong></dt> <dd> <p>Enables modified timing and sets the modified timing level. Currently valid range is 0-9. The timing of the runtime system will change. A high level usually means a greater change than a low level. Changing the timing can be very useful for finding timing related bugs.</p> <p>Currently, modified timing affects the following:</p> <dl> <dt><strong>Process spawning</strong></dt> <dd> <p>A process calling <span class="code">spawn</span>, <span class="code">spawn_link</span>, <span class="code">spawn_monitor</span>, or <span class="code">spawn_opt</span> will be scheduled out immediately after completing the call. When higher modified timing levels are used, the caller will also sleep for a while after being scheduled out.</p> </dd> <dt><strong>Context reductions</strong></dt> <dd>The amount of reductions a process is a allowed to use before being scheduled out is increased or reduced.</dd> <dt><strong>Input reductions</strong></dt> <dd>The amount of reductions performed before checking I/O is increased or reduced.</dd> </dl> <p><strong>NOTE:</strong> Performance will suffer when modified timing is enabled. This flag is <strong>only</strong> intended for testing and debugging. Also note that <span class="code">return_to</span> and <span class="code">return_from</span> trace messages will be lost when tracing on the spawn BIFs. This flag may be removed or changed at any time without prior notice.</p> </dd> <dt><strong><span class="code">+V</span></strong></dt> <dd> <p>Makes the emulator print out its version number.</p> </dd> <dt><strong><span class="code">+v</span></strong></dt> <dd> <p>Verbose.</p> </dd> <dt><strong><span class="code">+W w | i</span></strong></dt> <dd> <p>Sets the mapping of warning messages for <span class="code">error_logger</span>. Messages sent to the error logger using one of the warning routines can be mapped either to errors (default), warnings (<span class="code">+W w</span>), or info reports (<span class="code">+W i</span>). The current mapping can be retrieved using <span class="code">error_logger:warning_map/0</span>. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','error_logger.html#warning_map-0');">error_logger(3)</a></span> for further information.</p> </dd> <dt><strong><span class="code">+zFlag Value</span></strong></dt> <dd> <p>Miscellaneous flags.</p> <dl> <dt><strong><a name="+zdbbl"><span class="code">+zdbbl size</span></a></strong></dt> <dd> <p>Set the distribution buffer busy limit (<span class="bold_code"><a href="erlang.html#system_info_dist_buf_busy_limit">dist_buf_busy_limit</a></span>) in kilobytes. Valid range is 1-2097151. Default is 1024.</p> <p>A larger buffer limit will allow processes to buffer more outgoing messages over the distribution. When the buffer limit has been reached, sending processes will be suspended until the buffer size has shrunk. The buffer limit is per distribution channel. A higher limit will give lower latency and higher throughput at the expense of higher memory usage.</p> </dd> </dl> </dd> </dl> </div> <h3><a name="id156043">Environment variables</a></h3> <div class="REFBODY"> <a name="environment_variables"></a> <dl> <dt><strong><span class="code">ERL_CRASH_DUMP</span></strong></dt> <dd> <p>If the emulator needs to write a crash dump, the value of this variable will be the file name of the crash dump file. If the variable is not set, the name of the crash dump file will be <span class="code">erl_crash.dump</span> in the current directory.</p> </dd> <dt><strong><span class="code">ERL_CRASH_DUMP_NICE</span></strong></dt> <dd> <p><strong>Unix systems</strong>: If the emulator needs to write a crash dump, it will use the value of this variable to set the nice value for the process, thus lowering its priority. The allowable range is 1 through 39 (higher values will be replaced with 39). The highest value, 39, will give the process the lowest priority.</p> </dd> <dt><strong><span class="code">ERL_CRASH_DUMP_SECONDS</span></strong></dt> <dd> <p><strong>Unix systems</strong>: This variable gives the number of seconds that the emulator will be allowed to spend writing a crash dump. When the given number of seconds have elapsed, the emulator will be terminated by a SIGALRM signal.</p> <p> If the environment variable is <strong>not</strong> set or it is set to zero seconds, <span class="code">ERL_CRASH_DUMP_SECONDS=0</span>, the runtime system will not even attempt to write the crash dump file. It will just terminate. </p> <p> If the environment variable is set to negative valie, e.g. <span class="code">ERL_CRASH_DUMP_SECONDS=-1</span>, the runtime system will wait indefinitely for the crash dump file to be written. </p> <p> This environment variable is used in conjuction with <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','heart.html');"><span class="code">heart</span></a></span> if <span class="code">heart</span> is running: </p> <dl> <dt><strong><span class="code">ERL_CRASH_DUMP_SECONDS=0</span></strong></dt> <dd> <p> Suppresses the writing a crash dump file entirely, thus rebooting the runtime system immediately. This is the same as not setting the environment variable. </p> </dd> <dt><strong><span class="code">ERL_CRASH_DUMP_SECONDS=-1</span></strong></dt> <dd> <p>Setting the environment variable to a negative value will cause the termination of the runtime system to wait until the crash dump file has been completly written. </p> </dd> <dt><strong><span class="code">ERL_CRASH_DUMP_SECONDS=S</span></strong></dt> <dd> <p> Will wait for <span class="code">S</span> seconds to complete the crash dump file and then terminate the runtime system. </p> </dd> </dl> </dd> <dt><strong><span class="code">ERL_AFLAGS</span></strong></dt> <dd> <p>The content of this environment variable will be added to the beginning of the command line for <span class="code">erl</span>.</p> <p>The <span class="code">-extra</span> flag is treated specially. Its scope ends at the end of the environment variable content. Arguments following an <span class="code">-extra</span> flag are moved on the command line into the <span class="code">-extra</span> section, i.e. the end of the command line following after an <span class="code">-extra</span> flag.</p> </dd> <dt><strong><span class="code">ERL_ZFLAGS</span> and <span class="code">ERL_FLAGS</span></strong></dt> <dd> <p>The content of these environment variables will be added to the end of the command line for <span class="code">erl</span>.</p> <p>The <span class="code">-extra</span> flag is treated specially. Its scope ends at the end of the environment variable content. Arguments following an <span class="code">-extra</span> flag are moved on the command line into the <span class="code">-extra</span> section, i.e. the end of the command line following after an <span class="code">-extra</span> flag.</p> </dd> <dt><strong><span class="code">ERL_LIBS</span></strong></dt> <dd> <p>This environment variable contains a list of additional library directories that the code server will search for applications and add to the code path. See <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','code.html');">code(3)</a></span>.</p> </dd> <dt><strong><span class="code">ERL_EPMD_ADDRESS</span></strong></dt> <dd> <p>This environment variable may be set to a comma-separated list of IP addresses, in which case the <span class="bold_code"><a href="epmd.html">epmd</a></span> daemon will listen only on the specified address(es) and on the loopback address (which is implicitly added to the list if it has not been specified).</p> </dd> <dt><strong><span class="code">ERL_EPMD_PORT</span></strong></dt> <dd> <p>This environment variable can contain the port number to use when communicating with <span class="bold_code"><a href="epmd.html">epmd</a></span>. The default port will work fine in most cases. A different port can be specified to allow nodes of independent clusters to co-exist on the same host. All nodes in a cluster must use the same epmd port number.</p> </dd> </dl> </div> <h3><a name="id156329">Configuration</a></h3> <div class="REFBODY"> <a name="configuration"></a> <p>The standard Erlang/OTP system can be re-configured to change the default behavior on start-up.</p> <dl> <dt><strong>The .erlang Start-up File</strong></dt> <dd> <p>When Erlang/OTP is started, the system searches for a file named .erlang in the directory where Erlang/OTP is started. If not found, the user's home directory is searched for an .erlang file.</p> <p>If an .erlang file is found, it is assumed to contain valid Erlang expressions. These expressions are evaluated as if they were input to the shell.</p> <p>A typical .erlang file contains a set of search paths, for example:</p> <div class="example"><pre> io:format("executing user profile in HOME/.erlang\n",[]). code:add_path("/home/calvin/test/ebin"). code:add_path("/home/hobbes/bigappl-1.2/ebin"). io:format(".erlang rc finished\n",[]). </pre></div> </dd> <dt><strong>user_default and shell_default</strong></dt> <dd> <p>Functions in the shell which are not prefixed by a module name are assumed to be functional objects (Funs), built-in functions (BIFs), or belong to the module user_default or shell_default.</p> <p>To include private shell commands, define them in a module user_default and add the following argument as the first line in the .erlang file.</p> <div class="example"><pre> code:load_abs("..../user_default"). </pre></div> </dd> <dt><strong>erl</strong></dt> <dd> <p>If the contents of .erlang are changed and a private version of user_default is defined, it is possible to customize the Erlang/OTP environment. More powerful changes can be made by supplying command line arguments in the start-up script erl. Refer to erl(1) and <span class="bold_code"><a href="init.html">init(3)</a></span> for further information.</p> </dd> </dl> </div> <h3><a name="id156418">SEE ALSO</a></h3> <div class="REFBODY"> <p><span class="bold_code"><a href="init.html">init(3)</a></span>, <span class="bold_code"><a href="erl_prim_loader.html">erl_prim_loader(3)</a></span>, <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','erl_boot_server.html');">erl_boot_server(3)</a></span>, <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','code.html');">code(3)</a></span>, <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','application.html');">application(3)</a></span>, <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','heart.html');">heart(3)</a></span>, <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','net_kernel.html');">net_kernel(3)</a></span>, <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','kernel','auth.html');">auth(3)</a></span>, <span class="bold_code"><a href="javascript:erlhref('../../../doc/../','tools','make.html');">make(3)</a></span>, <span class="bold_code"><a href="epmd.html">epmd(1)</a></span>, <span class="bold_code"><a href="erts_alloc.html">erts_alloc(3)</a></span></p> </div> </div> <div class="footer"> <hr> <p>Copyright © 1997-2012 Ericsson AB. All Rights Reserved.</p> </div> </div> </div></body> </html>