From 68d53c01b0b8e9a007a6a30158c19e34b2d2a34e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Wed, 18 May 2016 15:53:35 +0200 Subject: Update STDLIB documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Language cleaned up by the technical writers xsipewe and tmanevik from Combitech. Proofreading and corrections by Björn Gustavsson and Hans Bolinder. --- lib/stdlib/doc/src/c.xml | 168 +++++++++++++++++++++++++++++------------------ 1 file changed, 104 insertions(+), 64 deletions(-) (limited to 'lib/stdlib/doc/src/c.xml') diff --git a/lib/stdlib/doc/src/c.xml b/lib/stdlib/doc/src/c.xml index 9b4a9489c0..92ab59c6b0 100644 --- a/lib/stdlib/doc/src/c.xml +++ b/lib/stdlib/doc/src/c.xml @@ -25,270 +25,310 @@ c Joe Armstrong 1 - 96-10-30 + 1996-10-30 B c - Command Interface Module + Command interface module. -

The c module enables users to enter the short form of +

This module enables users to enter the short form of some commonly used commands.

-

These functions are are intended for interactive use in - the Erlang shell only. The module prefix may be omitted.

+

These functions are intended for interactive use in + the Erlang shell only. The module prefix can be omitted.

 + - Stack backtrace for a process + Stack backtrace for a process.

Stack backtrace for a process. Equivalent to erlang:process_display(Pid, backtrace).

 + - Compile and load code in a file + Compile and load code in a file. -

c/1,2 compiles and then purges and loads the code for - a file. Options defaults to []. Compilation is +

Compiles and then purges and loads the code for a file. + Options defaults to []. Compilation is equivalent to:

compile:file(File, Options ++ [report_errors, report_warnings]) -

Note that purging the code means that any processes +

Notice that purging the code means that any processes lingering in old code for the module are killed without - warning. See code/3 for more information.

+ warning. For more information, see code/3.

 + - Change working directory + Change working directory. -

Changes working directory to Dir, which may be a +

Changes working directory to Dir, which can be a relative name, and then prints the name of the new working directory.

+

Example:

 2> cd("../erlang").
 /home/ron/erlang
 + - Flush any messages sent to the shell + Flush any messages sent to the shell.

Flushes any messages sent to the shell.

 + - Help information + Help information.

Displays help information: all valid shell internal commands, and commands in this module.

 + - Information about the system + System information. -

i/0 displays information about the system, listing +

i/0 displays system information, listing information about all processes. ni/0 does the same, but for all nodes the network.

 + - Information about pid <X.Y.Z> + Information about pid <X.Y.Z>.

Displays information about a process, Equivalent to - process_info(pid(X, Y, Z)), but location transparent.

+ process_info(pid(X, Y, + Z)), but location transparent.

 + - Load or reload module + Load or reload a module.

Purges and loads, or reloads, a module by calling code:purge(Module) followed by code:load_file(Module).

-

Note that purging the code means that any processes +

Notice that purging the code means that any processes lingering in old code for the module are killed without - warning. See code/3 for more information.

+ warning. For more information, see code/3.

 + lc(Files) -> ok - Compile a list of files + Compile a list of files. Files = [File] - File = file:filename() - + File -

Compiles a list of files by calling compile:file(File, [report_errors, report_warnings]) for each File - in Files.

+

Compiles a list of files by calling + compile:file(File, [report_errors, report_warnings]) for each + File in Files.

+

For information about File, see + file:filename(). +

+ - List files in the current directory + List files in the current directory.

Lists files in the current directory.

 + - List files in a directory or a single file + List files in a directory or a single file. -

Lists files in directory Dir or, if Dir is a file, only list it.

+

Lists files in directory Dir or, if Dir + is a file, only lists it.

 + - Which modules are loaded + Which modules are loaded.

Displays information about the loaded modules, including the files from which they have been loaded.

 + - Information about a module + Information about a module.

Displays information about Module.

 + - Memory allocation information + Memory allocation information.

Memory allocation information. Equivalent to - erlang:memory/0 - .

+ erlang:memory/0.

 + - Memory allocation information + Memory allocation information.

Memory allocation information. Equivalent to - erlang:memory/1 - .

+ erlang:memory/1.

 + - Compile and load code in a file on all nodes + Compile and load code in a file on all nodes.

Compiles and then loads the code for a file on all nodes. - Options defaults to []. Compilation is equivalent to:

+ Options defaults to []. + Compilation is equivalent to:

compile:file(File, Options ++ [report_errors, report_warnings]) + - Load module on all nodes + Load module on all nodes.

Loads Module on all nodes.

 + - Convert X,Y,Z to a pid + Convert X,Y,Z to a pid. -

Converts X, Y, Z to the pid - ]]>. This function should only be used when - debugging.

+

Converts X, Y, + Z to pid ]]>. + This function is only to be used when debugging.

 + - Print working directory + Print working directory.

Prints the name of the working directory.

 + - Quit - shorthand for init:stop() + Quit - shorthand for init:stop().

This function is shorthand for init:stop(), that is, it causes the node to stop in a controlled fashion.

 + - Information about registered processes + Information about registered processes.

regs/0 displays information about all registered processes. nregs/0 does the same, but for all nodes in the network.

 + - Print node uptime + Print node uptime. -

Prints the node uptime (as given by - erlang:statistics(wall_clock)), in human-readable form.

+

Prints the node uptime (as specified by + erlang:statistics(wall_clock)) in human-readable form.

 + xm(ModSpec) -> void() - Cross reference check a module + Cross-reference check a module. ModSpec = Module | Filename  Module = atom()  Filename = string() -

This function finds undefined functions, unused functions, +

Finds undefined functions, unused functions, and calls to deprecated functions in a module by calling xref:m/1.

 + y(File) -> YeccRet - Generate an LALR-1 parser + Generate an LALR-1 parser. - File = name() -- see filename(3) - YeccRet = -- see yecc:file/2 + File = name() + YeccRet

Generates an LALR-1 parser. Equivalent to:

yecc:file(File) +

For information about File = name(), see + filename(3). + For information about YeccRet, see + yecc:file/2. +

+ y(File, Options) -> YeccRet - Generate an LALR-1 parser + Generate an LALR-1 parser. - File = name() -- see filename(3) - Options, YeccRet = -- see yecc:file/2 + File = name() + Options, YeccRet

Generates an LALR-1 parser. Equivalent to:

yecc:file(File, Options) +

For information about File = name(), see + filename(3). + For information about Options and YeccRet, see + yecc:file/2. +

See Also -

compile(3), - filename(3), - erlang(3), - yecc(3), - xref(3)

+

filename(3), + compile(3), + erlang(3), + yecc(3), + xref(3)

-- cgit v1.2.3