1c(3) Erlang Module Definition c(3)
2
6 c - Command interface module.
7
9 This module enables users to enter the short form of some commonly used
10 commands.
11 Note:
13 These functions are intended for interactive use in the Erlang shell
14 only. The module prefix can be omitted.
15
18 bt(Pid) -> ok | undefined
19 Types:
21 Pid = pid()
23 Stack backtrace for a process. Equivalent to erlang:process_dis‐
25 play(Pid, backtrace).
26 c(Module) -> {ok, ModuleName} | error
28 c(Module, Options) -> {ok, ModuleName} | error
30 c(Module, Options, Filter) -> {ok, ModuleName} | error
32 Types:
34 Module = atom()
36 Options = [compile:option()]
37 Filter = fun((compile:option()) -> boolean())
38 ModuleName = module()
39 Compiles and then purges and loads the code for a module. Module
41 can be either a module name or a source file path, with or with‐
42 out .erl extension. Options defaults to [].
43 If Module is an atom and is not the path of a source file, then
45 the code path is searched to locate the object file for the mod‐
46 ule and extract its original compiler options and source path.
47 If the source file is not found in the original location,
48 filelib:find_source/1 is used to search for it relative to the
49 directory of the object file.
50 The source file is compiled with the the original options
52 appended to the given Options, the output replacing the old
53 object file if and only if compilation succeeds. A function Fil‐
54 ter can be specified for removing elements from from the origi‐
55 nal compiler options before the new options are added.
56 Notice that purging the code means that any processes lingering
58 in old code for the module are killed without warning. For more
59 information, see code/3.
60 cd(Dir) -> ok
62 Types:
64 Dir = file:name()
66 Changes working directory to Dir, which can be a relative name,
68 and then prints the name of the new working directory.
69 Example:
71 2> cd("../erlang").
73 /home/ron/erlang
74 flush() -> ok
76 Flushes any messages sent to the shell.
78 help() -> ok
80 Displays help information: all valid shell internal commands,
82 and commands in this module.
83 i() -> ok
85 ni() -> ok
87 i/0 displays system information, listing information about all
89 processes. ni/0 does the same, but for all nodes the network.
90 i(X, Y, Z) -> [{atom(), term()}]
92 Types:
94 X = Y = Z = integer() >= 0
96 Displays information about a process, Equivalent to
98 process_info(pid(X, Y, Z)), but location transparent.
99 l(Module) -> code:load_ret()
101 Types:
103 Module = module()
105 Purges and loads, or reloads, a module by calling
107 code:purge(Module) followed by code:load_file(Module).
108 Notice that purging the code means that any processes lingering
110 in old code for the module are killed without warning. For more
111 information, see code/3.
112 lc(Files) -> ok
114 Types:
116 Files = [File]
118 File
119 Compiles a list of files by calling compile:file(File,
121 [report_errors, report_warnings]) for each File in Files.
122 For information about File, see file:filename().
124 lm() -> [code:load_ret()]
126 Reloads all currently loaded modules that have changed on disk
128 (see mm()). Returns the list of results from calling l(M) for
129 each such M.
130 ls() -> ok
132 Lists files in the current directory.
134 ls(Dir) -> ok
136 Types:
138 Dir = file:name()
140 Lists files in directory Dir or, if Dir is a file, only lists
142 it.
143 m() -> ok
145 Displays information about the loaded modules, including the
147 files from which they have been loaded.
148 m(Module) -> ok
150 Types:
152 Module = module()
154 Displays information about Module.
156 mm() -> [module()]
158 Lists all modified modules. Shorthand for code:modified_mod‐
160 ules/0.
161 memory() -> [{Type, Size}]
163 Types:
165 Type = atom()
167 Size = integer() >= 0
168 Memory allocation information. Equivalent to erlang:memory/0.
170 memory(Type) -> Size
172 memory(Types) -> [{Type, Size}]
174 Types:
176 Types = [Type]
178 Type = atom()
179 Size = integer() >= 0
180 Memory allocation information. Equivalent to erlang:memory/1.
182 nc(File) -> {ok, Module} | error
184 nc(File, Options) -> {ok, Module} | error
186 Types:
188 File = file:name()
190 Options = [Option] | Option
191 Option = compile:option()
192 Module = module()
193 Compiles and then loads the code for a file on all nodes.
195 Options defaults to []. Compilation is equivalent to:
196 compile:file(File, Options ++ [report_errors, report_warnings])
198 nl(Module) -> abcast | error
200 Types:
202 Module = module()
204 Loads Module on all nodes.
206 pid(X, Y, Z) -> pid()
208 Types:
210 X = Y = Z = integer() >= 0
212 Converts X, Y, Z to pid <X.Y.Z>. This function is only to be
214 used when debugging.
215 pwd() -> ok
217 Prints the name of the working directory.
219 q() -> no_return()
221 This function is shorthand for init:stop(), that is, it causes
223 the node to stop in a controlled fashion.
224 regs() -> ok
226 nregs() -> ok
228 regs/0 displays information about all registered processes.
230 nregs/0 does the same, but for all nodes in the network.
231 uptime() -> ok
233 Prints the node uptime (as specified by erlang:statis‐
235 tics(wall_clock)) in human-readable form.
236 xm(ModSpec) -> void()
238 Types:
240 ModSpec = Module | Filename
242 Module = atom()
243 Filename = string()
244 Finds undefined functions, unused functions, and calls to depre‐
246 cated functions in a module by calling xref:m/1.
247 y(File) -> YeccRet
249 Types:
251 File = name()
253 YeccRet
254 Generates an LALR-1 parser. Equivalent to:
256 yecc:file(File)
258 For information about File = name(), see filename(3). For infor‐
260 mation about YeccRet, see yecc:file/2.
261 y(File, Options) -> YeccRet
263 Types:
265 File = name()
267 Options, YeccRet
268 Generates an LALR-1 parser. Equivalent to:
270 yecc:file(File, Options)
272 For information about File = name(), see filename(3). For infor‐
274 mation about Options and YeccRet, see yecc:file/2.
275
277 filename(3), compile(3), erlang(3), yecc(3), xref(3)
278Ericsson AB stdlib 3.4.5.1 c(3)