Reference Manual
Release Notes
PDF
Top

Kernel
Reference Manual
Version 4.1.1

Expand All
Contract All

Table of Contents

- kernel (App)
- application
  - Top of manual page
  - get_all_env/0
  - get_all_env/1
  - get_all_key/0
  - get_all_key/1
  - get_application/0
  - get_application/1
  - get_env/1
  - get_env/2
  - get_env/3
  - get_key/1
  - get_key/2
  - load/1
  - load/2
  - loaded_applications/0
  - permit/2
  - set_env/3
  - set_env/4
  - ensure_started/1
  - ensure_started/2
  - ensure_all_started/1
  - ensure_all_started/2
  - start/1
  - start/2
  - start_type/0
  - stop/1
  - takeover/2
  - unload/1
  - unset_env/2
  - unset_env/3
  - which_applications/0
  - which_applications/1
  - Module:start/2
  - Module:start_phase/3
  - Module:prep_stop/1
  - Module:stop/1
  - Module:config_change/3
- auth
  - Top of manual page
  - is_auth/1
  - cookie/0
  - cookie/1
  - node_cookie/1
  - node_cookie/2
- code
  - Top of manual page
  - set_path/1
  - get_path/0
  - add_path/1
  - add_pathz/1
  - add_patha/1
  - add_paths/1
  - add_pathsz/1
  - add_pathsa/1
  - del_path/1
  - replace_path/2
  - load_file/1
  - load_abs/1
  - ensure_loaded/1
  - load_binary/3
  - delete/1
  - purge/1
  - soft_purge/1
  - is_loaded/1
  - all_loaded/0
  - which/1
  - get_object_code/1
  - root_dir/0
  - lib_dir/0
  - lib_dir/1
  - lib_dir/2
  - compiler_dir/0
  - priv_dir/1
  - objfile_extension/0
  - stick_dir/1
  - unstick_dir/1
  - is_sticky/1
  - rehash/0
  - where_is_file/1
  - clash/0
  - is_module_native/1
  - get_mode/0
- disk_log
  - Top of manual page
  - accessible_logs/0
  - alog/2
  - balog/2
  - alog_terms/2
  - balog_terms/2
  - block/1
  - block/2
  - change_header/2
  - change_notify/3
  - change_size/2
  - chunk/2
  - chunk/3
  - bchunk/2
  - bchunk/3
  - chunk_info/1
  - chunk_step/3
  - close/1
  - format_error/1
  - inc_wrap_file/1
  - info/1
  - lclose/1
  - lclose/2
  - log/2
  - blog/2
  - log_terms/2
  - blog_terms/2
  - open/1
  - pid2name/1
  - reopen/2
  - reopen/3
  - breopen/3
  - sync/1
  - truncate/1
  - truncate/2
  - btruncate/2
  - unblock/1
- erl_boot_server
  - Top of manual page
  - start/1
  - start_link/1
  - add_slave/1
  - delete_slave/1
  - which_slaves/0
- erl_ddll
  - Top of manual page
  - demonitor/1
  - info/0
  - info/1
  - info/2
  - load/2
  - load_driver/2
  - monitor/2
  - reload/2
  - reload_driver/2
  - try_load/3
  - try_unload/2
  - unload/1
  - unload_driver/1
  - loaded_drivers/0
  - format_error/1
- erl_prim_loader
- erlang
- error_handler
  - Top of manual page
  - undefined_function/3
  - raise_undef_exception/3
  - undefined_lambda/3
- error_logger
  - Top of manual page
  - error_msg/1
  - error_msg/2
  - format/2
  - error_report/1
  - error_report/2
  - warning_map/0
  - warning_msg/1
  - warning_msg/2
  - warning_report/1
  - warning_report/2
  - info_msg/1
  - info_msg/2
  - info_report/1
  - info_report/2
  - add_report_handler/1
  - add_report_handler/2
  - delete_report_handler/1
  - tty/1
  - logfile/1
- file
  - Top of manual page
  - advise/4
  - allocate/3
  - change_group/2
  - change_mode/2
  - change_owner/2
  - change_owner/3
  - change_time/2
  - change_time/3
  - close/1
  - consult/1
  - copy/2
  - copy/3
  - del_dir/1
  - delete/1
  - eval/1
  - eval/2
  - format_error/1
  - get_cwd/0
  - get_cwd/1
  - list_dir/1
  - list_dir_all/1
  - make_dir/1
  - make_link/2
  - make_symlink/2
  - native_name_encoding/0
  - open/2
  - path_consult/2
  - path_eval/2
  - path_open/3
  - path_script/2
  - path_script/3
  - pid2name/1
  - position/2
  - pread/2
  - pread/3
  - pwrite/2
  - pwrite/3
  - read/2
  - read_file/1
  - read_file_info/1
  - read_file_info/2
  - read_line/1
  - read_link/1
  - read_link_all/1
  - read_link_info/1
  - read_link_info/2
  - rename/2
  - script/1
  - script/2
  - set_cwd/1
  - sync/1
  - datasync/1
  - truncate/1
  - sendfile/2
  - sendfile/5
  - write/2
  - write_file/2
  - write_file/3
  - write_file_info/2
  - write_file_info/3
- gen_tcp
  - Top of manual page
  - connect/3
  - connect/4
  - listen/2
  - accept/1
  - accept/2
  - send/2
  - recv/2
  - recv/3
  - controlling_process/2
  - close/1
  - shutdown/2
- gen_udp
  - Top of manual page
  - open/1
  - open/2
  - send/4
  - recv/2
  - recv/3
  - controlling_process/2
  - close/1
- gen_sctp
  - Top of manual page
  - abort/2
  - close/1
  - connect/4
  - connect/5
  - connect_init/4
  - connect_init/5
  - controlling_process/2
  - eof/2
  - listen/2
  - open/0
  - open/1
  - open/2
  - peeloff/2
  - recv/1
  - recv/2
  - send/3
  - send/4
  - error_string/1
- global
  - Top of manual page
  - del_lock/1
  - del_lock/2
  - notify_all_name/3
  - random_exit_name/3
  - random_notify_name/3
  - register_name/2
  - register_name/3
  - registered_names/0
  - re_register_name/2
  - re_register_name/3
  - send/2
  - set_lock/1
  - set_lock/2
  - set_lock/3
  - sync/0
  - trans/2
  - trans/3
  - trans/4
  - unregister_name/1
  - whereis_name/1
- global_group
  - Top of manual page
  - global_groups/0
  - info/0
  - monitor_nodes/1
  - own_nodes/0
  - registered_names/1
  - send/2
  - send/3
  - sync/0
  - whereis_name/1
  - whereis_name/2
- heart
  - Top of manual page
  - set_cmd/1
  - clear_cmd/0
  - get_cmd/0
- inet
  - Top of manual page
  - close/1
  - get_rc/0
  - format_error/1
  - getaddr/2
  - getaddrs/2
  - gethostbyaddr/1
  - gethostbyname/1
  - gethostbyname/2
  - gethostname/0
  - getifaddrs/0
  - getopts/2
  - getstat/1
  - getstat/2
  - ntoa/1
  - parse_ipv4_address/1
  - parse_ipv4strict_address/1
  - parse_ipv6_address/1
  - parse_ipv6strict_address/1
  - parse_address/1
  - parse_strict_address/1
  - peername/1
  - peernames/1
  - peernames/2
  - port/1
  - sockname/1
  - socknames/1
  - socknames/2
  - setopts/2
- inet_res
  - Top of manual page
  - getbyname/2
  - getbyname/3
  - gethostbyaddr/1
  - gethostbyaddr/2
  - gethostbyname/1
  - gethostbyname/2
  - gethostbyname/3
  - lookup/3
  - lookup/4
  - lookup/5
  - resolve/3
  - resolve/4
  - resolve/5
  - nslookup/3
  - nslookup/4
  - nnslookup/4
  - nnslookup/5
- init
- net_adm
  - Top of manual page
  - dns_hostname/1
  - host_file/0
  - localhost/0
  - names/0
  - names/1
  - ping/1
  - world/0
  - world/1
  - world_list/1
  - world_list/2
- net_kernel
  - Top of manual page
  - allow/1
  - connect_node/1
  - monitor_nodes/1
  - monitor_nodes/2
  - get_net_ticktime/0
  - set_net_ticktime/1
  - set_net_ticktime/2
  - start/1
  - start/1
  - start/1
  - stop/0
- os
  - Top of manual page
  - cmd/1
  - find_executable/1
  - find_executable/2
  - getenv/0
  - getenv/1
  - getenv/2
  - getpid/0
  - putenv/2
  - system_time/0
  - system_time/1
  - timestamp/0
  - type/0
  - unsetenv/1
  - version/0
- pg2
  - Top of manual page
  - create/1
  - delete/1
  - get_closest_pid/1
  - get_members/1
  - get_local_members/1
  - join/2
  - leave/2
  - which_groups/0
  - start/0
  - start_link/0
- rpc
  - Top of manual page
  - call/4
  - call/5
  - block_call/4
  - block_call/5
  - async_call/4
  - yield/1
  - nb_yield/1
  - nb_yield/2
  - multicall/3
  - multicall/4
  - multicall/5
  - cast/4
  - eval_everywhere/3
  - eval_everywhere/4
  - abcast/2
  - abcast/3
  - sbcast/2
  - sbcast/3
  - server_call/4
  - multi_server_call/2
  - multi_server_call/3
  - safe_multi_server_call/2
  - safe_multi_server_call/3
  - parallel_eval/1
  - pmap/3
  - pinfo/1
  - pinfo/2
- seq_trace
  - Top of manual page
  - set_token/1
  - set_token/2
  - get_token/0
  - get_token/1
  - print/1
  - print/2
  - reset_trace/0
  - set_system_tracer/1
  - get_system_tracer/0
- user
- wrap_log_reader
  - Top of manual page
  - chunk/1
  - chunk/2
  - close/1
  - open/1
  - open/2
- zlib
- app
- config

# kernel

### APPLICATION

kernel

### APPLICATION SUMMARY

The Kernel Application

### DESCRIPTION

The Kernel application is the first application started. It is mandatory in the sense that the minimal system based on Erlang/OTP consists of Kernel and STDLIB. The Kernel application contains the following services:

- application controller, see application(3)
- code
- disk_log
- dist_ac, distributed application controller
- erl_boot_server
- erl_ddll
- error_logger
- error_logger_format_depth
- file
- global
- global_group
- heart
- inet
- net_kernel
- os
- pg2
- rpc
- seq_trace
- user

### Error Logger Event Handlers

Two standard error logger event handlers are defined in the Kernel application. These are described in error_logger(3).

### Configuration

The following configuration parameters are defined for the Kernel application. See app(4) for more information about configuration parameters.

browser_cmd = string() | {M,F,A}

  When pressing the Help button in a tool such as Debugger or TV, the help text (an HTML file File) is by default displayed in a Netscape browser which is required to be up and running. This parameter can be used to change the command for how to display the help text if another browser than Netscape is preferred, or another platform than Unix or Windows is used.

  If set to a string Command, the command "Command File" will be evaluated using os:cmd/1.

  If set to a module-function-args tuple {M,F,A}, the call apply(M,F,[File|A]) will be evaluated.

distributed = [Distrib]

  Specifies which applications are distributed and on which nodes they may execute. In this parameter:

  - Distrib = {App,Nodes} | {App,Time,Nodes}
  - App = atom()
  - Time = integer()>0
  - Nodes = [node() | {node(),...,node()}]

  The parameter is described in application(3), function load/2.

dist_auto_connect = Value

  Specifies when nodes will be automatically connected. If this parameter is not specified, a node is always automatically connected, e.g when a message is to be sent to that node. Value is one of:

  never
    Connections are never automatically established, they must be explicitly connected. See net_kernel(3).
  once
    Connections will be established automatically, but only once per node. If a node goes down, it must thereafter be explicitly connected. See net_kernel(3).
permissions = [Perm]

  Specifies the default permission for applications when they are started. In this parameter:

  - Perm = {ApplName,Bool}
  - ApplName = atom()
  - Bool = boolean()

  Permissions are described in application(3), function permit/2.

error_logger = Value

  Value is one of:

  tty
    Installs the standard event handler which prints error reports to stdio. This is the default option.
  {file, FileName}
    Installs the standard event handler which prints error reports to the file FileName, where FileName is a string.
  false

    No standard event handler is installed, but the initial, primitive event handler is kept, printing raw event messages to tty.

  silent

    Error logging is turned off.

error_logger_format_depth = Depth

  This parameter can be used to limit the size of the formatted output from the error logger event handlers.

  Note

  This configuration parameter was introduced in OTP 18.1. It is currently experimental. Based on user feedback it may be changed or improved in future releases, for example to gain better control over how to limit the size of the formatted output. We have no plans to entirely remove this new feature, unless it turns out to be completely useless. In OTP 19, the default may be changed to limit the formatted output.

  Depth is a positive integer that is the maximum depth to which terms are printed by the error logger event handlers included in OTP. Specifically, the two event handlers defined by the Kernel application and the two event handlers in the SASL application will use this configuration parameter. (If you have implemented you own error handlers, this configuration parameter will have no effect on them.)

  The way Depth is used, is that format strings string passed to the event handlers will be rewritten. The "~p" and "~w" format controls will be replaced with "~P" and "~W", respectively, and Depth will be used as the depth parameter. See io:format/2.

  Note

  A reasonable starting value for Depth is 30. You should test crashing various processes in your application and examine the logs from the crashes, and then either increase or decrease the value.

global_groups = [GroupTuple]

  Defines global groups, see global_group(3).

  - GroupTuple = {GroupName, [Node]} | {GroupName, PublishType, [Node]}
  - GroupName = atom()
  - PublishType = normal | hidden
  - Node = node()
inet_default_connect_options = [{Opt, Val}]

  Specifies default options for connect sockets, see inet(3).

inet_default_listen_options = [{Opt, Val}]

  Specifies default options for listen (and accept) sockets, see inet(3).

{inet_dist_use_interface, ip_address()}

  If the host of an Erlang node has several network interfaces, this parameter specifies which one to listen on. See inet(3) for the type definition of ip_address().

{inet_dist_listen_min, First}

  See below.

{inet_dist_listen_max, Last}

  Define the First..Last port range for the listener socket of a distributed Erlang node.

{inet_dist_listen_options, Opts}

  Define a list of extra socket options to be used when opening the listening socket for a distributed Erlang node. See gen_tcp:listen/2

{inet_dist_connect_options, Opts}

  Define a list of extra socket options to be used when connecting to other distributed Erlang nodes. See gen_tcp:connect/4

inet_parse_error_log = silent

  If this configuration parameter is set, no error_logger messages are generated when erroneous lines are found and skipped in the various Inet configuration files.

inetrc = Filename

  The name (string) of an Inet user configuration file. See ERTS User's Guide, Inet configuration.

net_setuptime = SetupTime

  SetupTime must be a positive integer or floating point number, and will be interpreted as the maximally allowed time for each network operation during connection setup to another Erlang node. The maximum allowed value is 120; if higher values are given, 120 will be used. The default value if the variable is not given, or if the value is incorrect (e.g. not a number), is 7 seconds.

  Note that this value does not limit the total connection setup time, but rather each individual network operation during the connection setup and handshake.

net_ticktime = TickTime

  Specifies the net_kernel tick time. TickTime is given in seconds. Once every TickTime/4 second, all connected nodes are ticked (if anything else has been written to a node) and if nothing has been received from another node within the last four (4) tick times that node is considered to be down. This ensures that nodes which are not responding, for reasons such as hardware errors, are considered to be down.

  The time T, in which a node that is not responding is detected, is calculated as: MinT < T < MaxT where:

      MinT = TickTime - TickTime / 4
      MaxT = TickTime + TickTime / 4

  TickTime is by default 60 (seconds). Thus, 45 < T < 75 seconds.

  Note: All communicating nodes should have the same TickTime value specified.

  Note: Normally, a terminating node is detected immediately.

shutdown_timeout = integer() | infinity

  Specifies the time application_controller will wait for an application to terminate during node shutdown. If the timer expires, application_controller will brutally kill application_master of the hanging application. If this parameter is undefined, it defaults to infinity.

sync_nodes_mandatory = [NodeName]

  Specifies which other nodes must be alive in order for this node to start properly. If some node in the list does not start within the specified time, this node will not start either. If this parameter is undefined, it defaults to [].

sync_nodes_optional = [NodeName]

  Specifies which other nodes can be alive in order for this node to start properly. If some node in this list does not start within the specified time, this node starts anyway. If this parameter is undefined, it defaults to the empty list.

sync_nodes_timeout = integer() | infinity

  Specifies the amount of time (in milliseconds) this node will wait for the mandatory and optional nodes to start. If this parameter is undefined, no node synchronization is performed. This option also makes sure that global is synchronized.

start_dist_ac = true | false

  Starts the dist_ac server if the parameter is true. This parameter should be set to true for systems that use distributed applications.

  The default value is false. If this parameter is undefined, the server is started if the parameter distributed is set.

start_boot_server = true | false

  Starts the boot_server if the parameter is true (see erl_boot_server(3)). This parameter should be set to true in an embedded system which uses this service.

  The default value is false.

boot_server_slaves = [SlaveIP]

  If the start_boot_server configuration parameter is true, this parameter can be used to initialize boot_server with a list of slave IP addresses. SlaveIP = string() | atom | {integer(),integer(),integer(),integer()}

  where 0 <= integer() <=255.

  Examples of SlaveIP in atom, string and tuple form are:
  '150.236.16.70', "150,236,16,70", {150,236,16,70}.

  The default value is [].

start_disk_log = true | false

  Starts the disk_log_server if the parameter is true (see disk_log(3)). This parameter should be set to true in an embedded system which uses this service.

  The default value is false.

start_pg2 = true | false

  Starts the pg2 server (see pg2(3)) if the parameter is true. This parameter should be set to true in an embedded system which uses this service.

  The default value is false.

start_timer = true | false

  Starts the timer_server if the parameter is true (see timer(3)). This parameter should be set to true in an embedded system which uses this service.

  The default value is false.

shutdown_func = {Mod, Func}

  Where:

  - Mod = atom()
  - Func = atom()

  Sets a function that application_controller calls when it starts to terminate. The function is called as: Mod:Func(Reason), where Reason is the terminate reason for application_controller, and it must return as soon as possible for application_controller to terminate properly.

### See Also

app(4), application(3), code(3), disk_log(3), erl_boot_server(3), erl_ddll(3), error_logger(3), file(3), global(3), global_group(3), heart(3), inet(3), net_kernel(3), os(3), pg2(3), rpc(3), seq_trace(3), timer(3), user(3)