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 Types:
30 Module = file:name()
32 ModuleName = module()
33 Works like c(Module, []).
35 c(Module, Options) -> {ok, ModuleName} | error
37 Types:
39 Module = file:name()
41 Options = [compile:option()] | compile:option()
42 ModuleName = module()
43 Compiles and then purges and loads the code for a module. Module
45 can be either a module name or a source file path, with or with‐
46 out .erl extension.
47 If Module is a string, it is assumed to be a source file path,
49 and the compiler will attempt to compile the source file with
50 the options Options. If compilation fails, the old object file
51 (if any) is deleted.
52 If Module is an atom, a source file with that exact name or with
54 .erl extension will be looked for. If found, the source file is
55 compiled with the options Options. If compilation fails, the old
56 object file (if any) is deleted.
57 If Module is an atom and is not the path of a source file, then
59 the code path is searched to locate the object file for the mod‐
60 ule and extract its original compiler options and source path.
61 If the source file is not found in the original location,
62 filelib:find_source/1 is used to search for it relative to the
63 directory of the object file.
64 The source file is compiled with the the original options ap‐
66 pended to the given Options, the output replacing the old object
67 file if and only if compilation succeeds.
68 Notice that purging the code means that any processes lingering
70 in old code for the module are killed without warning. For more
71 information, see the code module.
72 c(Module, Options, Filter) -> {ok, ModuleName} | error
74 Types:
76 Module = atom()
78 Options = [compile:option()]
79 Filter = fun((compile:option()) -> boolean())
80 ModuleName = module()
81 Compiles and then purges and loads the code for module Module,
83 which must be an atom.
84 The code path is searched to locate the object file for module
86 Module and extract its original compiler options and source
87 path. If the source file is not found in the original location,
88 filelib:find_source/1 is used to search for it relative to the
89 directory of the object file.
90 The source file is compiled with the the original options ap‐
92 pended to the given Options, the output replacing the old object
93 file if and only if compilation succeeds. The function Filter
94 specifies which elements to remove from the original compiler
95 options before the new options are added. The Filter fun should
96 return true for options to keep, and false for options to re‐
97 move.
98 Notice that purging the code means that any processes lingering
100 in old code for the module are killed without warning. For more
101 information, see the code module.
102 cd(Dir) -> ok
104 Types:
106 Dir = file:name()
108 Changes working directory to Dir, which can be a relative name,
110 and then prints the name of the new working directory.
111 Example:
113 2> cd("../erlang").
115 /home/ron/erlang
116 erlangrc(PathList) -> {ok, file:filename()} | {error, term()}
118 Types:
120 PathList = [Dir :: file:name()]
122 Search PathList and load .erlang resource file if found.
124 flush() -> ok
126 Flushes any messages sent to the shell.
128 help() -> ok
130 Displays help information: all valid shell internal commands,
132 and commands in this module.
133 h(Module :: module()) -> h_return()
135 Types:
137 h_return() =
139 ok | {error, missing | {unknown_format, unicode:chardata()}}
140 Print the documentation for Module
142 h(Module :: module(), Function :: function()) -> hf_return()
144 Types:
146 h_return() =
148 ok | {error, missing | {unknown_format, unicode:chardata()}}
149 hf_return() = h_return() | {error, function_missing}
150 Print the documentation for all Module:Functions (regardless of
152 arity).
153 h(Module :: module(), Function :: function(), Arity :: arity()) ->
155 hf_return()
156 Types:
158 h_return() =
160 ok | {error, missing | {unknown_format, unicode:chardata()}}
161 hf_return() = h_return() | {error, function_missing}
162 Print the documentation for Module:Function/Arity.
164 ht(Module :: module()) -> h_return()
166 Types:
168 h_return() =
170 ok | {error, missing | {unknown_format, unicode:chardata()}}
171 Print the type documentation for Module
173 ht(Module :: module(), Type :: atom()) -> ht_return()
175 Types:
177 h_return() =
179 ok | {error, missing | {unknown_format, unicode:chardata()}}
180 ht_return() = h_return() | {error, type_missing}
181 Print the type documentation for Type in Module regardless of
183 arity.
184 ht(Module :: module(), Type :: atom(), Arity :: arity()) ->
186 ht_return()
187 Types:
189 h_return() =
191 ok | {error, missing | {unknown_format, unicode:chardata()}}
192 ht_return() = h_return() | {error, type_missing}
193 Print the type documentation for Type/Arity in Module.
195 i() -> ok
197 ni() -> ok
199 i/0 displays system information, listing information about all
201 processes. ni/0 does the same, but for all nodes the network.
202 i(X, Y, Z) -> [{atom(), term()}]
204 Types:
206 X = Y = Z = integer() >= 0
208 Displays information about a process, Equivalent to
210 process_info(pid(X, Y, Z)), but location transparent.
211 l(Module) -> code:load_ret()
213 Types:
215 Module = module()
217 Purges and loads, or reloads, a module by calling
219 code:purge(Module) followed by code:load_file(Module).
220 Notice that purging the code means that any processes lingering
222 in old code for the module are killed without warning. For more
223 information, see code/3.
224 lc(Files) -> ok
226 Types:
228 Files = [File]
230 File
231 Compiles a list of files by calling compile:file(File, [re‐
233 port_errors, report_warnings]) for each File in Files.
234 For information about File, see file:filename().
236 lm() -> [code:load_ret()]
238 Reloads all currently loaded modules that have changed on disk
240 (see mm()). Returns the list of results from calling l(M) for
241 each such M.
242 ls() -> ok
244 Lists files in the current directory.
246 ls(Dir) -> ok
248 Types:
250 Dir = file:name()
252 Lists files in directory Dir or, if Dir is a file, only lists
254 it.
255 m() -> ok
257 Displays information about the loaded modules, including the
259 files from which they have been loaded.
260 m(Module) -> ok
262 Types:
264 Module = module()
266 Displays information about Module.
268 mm() -> [module()]
270 Lists all modified modules. Shorthand for code:modified_mod‐
272 ules/0.
273 memory() -> [{Type, Size}]
275 Types:
277 Type = atom()
279 Size = integer() >= 0
280 Memory allocation information. Equivalent to erlang:memory/0.
282 memory(Type) -> Size
284 memory(Types) -> [{Type, Size}]
286 Types:
288 Types = [Type]
290 Type = atom()
291 Size = integer() >= 0
292 Memory allocation information. Equivalent to erlang:memory/1.
294 nc(File) -> {ok, Module} | error
296 nc(File, Options) -> {ok, Module} | error
298 Types:
300 File = file:name()
302 Options = [Option] | Option
303 Option = compile:option()
304 Module = module()
305 Compiles and then loads the code for a file on all nodes. Op‐
307 tions defaults to []. Compilation is equivalent to:
308 compile:file(File, Options ++ [report_errors, report_warnings])
310 nl(Module) -> abcast | error
312 Types:
314 Module = module()
316 Loads Module on all nodes.
318 pid(X, Y, Z) -> pid()
320 Types:
322 X = Y = Z = integer() >= 0
324 Converts X, Y, Z to pid <X.Y.Z>. This function is only to be
326 used when debugging.
327 pwd() -> ok
329 Prints the name of the working directory.
331 q() -> no_return()
333 This function is shorthand for init:stop(), that is, it causes
335 the node to stop in a controlled fashion.
336 regs() -> ok
338 nregs() -> ok
340 regs/0 displays information about all registered processes.
342 nregs/0 does the same, but for all nodes in the network.
343 uptime() -> ok
345 Prints the node uptime (as specified by erlang:statis‐
347 tics(wall_clock)) in human-readable form.
348 xm(ModSpec) -> void()
350 Types:
352 ModSpec = Module | Filename
354 Module = atom()
355 Filename = string()
356 Finds undefined functions, unused functions, and calls to depre‐
358 cated functions in a module by calling xref:m/1.
359 y(File) -> YeccRet
361 Types:
363 File = name()
365 YeccRet
366 Generates an LALR-1 parser. Equivalent to:
368 yecc:file(File)
370 For information about File = name(), see filename(3). For infor‐
372 mation about YeccRet, see yecc:file/2.
373 y(File, Options) -> YeccRet
375 Types:
377 File = name()
379 Options, YeccRet
380 Generates an LALR-1 parser. Equivalent to:
382 yecc:file(File, Options)
384 For information about File = name(), see filename(3). For infor‐
386 mation about Options and YeccRet, see yecc:file/2.
387
389 filename(3), compile(3), erlang(3), yecc(3), xref(3)
390Ericsson AB stdlib 3.17.2 c(3)