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 ap‐
52 pended to the given Options, the output replacing the old object
53 file if and only if compilation succeeds. A function Filter can
54 be specified for removing elements from from the original com‐
55 piler 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 erlangrc(PathList) -> {ok, file:filename()} | {error, term()}
76 Types:
78 PathList = [Dir :: file:name()]
80 Search PathList and load .erlang resource file if found.
82 flush() -> ok
84 Flushes any messages sent to the shell.
86 help() -> ok
88 Displays help information: all valid shell internal commands,
90 and commands in this module.
91 h(Module :: module()) -> h_return()
93 Types:
95 h_return() =
97 ok | {error, missing | {unknown_format, unicode:chardata()}}
98 Print the documentation for Module
100 h(Module :: module(), Function :: function()) -> hf_return()
102 Types:
104 h_return() =
106 ok | {error, missing | {unknown_format, unicode:chardata()}}
107 hf_return() = h_return() | {error, function_missing}
108 Print the documentation for all Module:Functions (regardless of
110 arity).
111 h(Module :: module(), Function :: function(), Arity :: arity()) ->
113 hf_return()
114 Types:
116 h_return() =
118 ok | {error, missing | {unknown_format, unicode:chardata()}}
119 hf_return() = h_return() | {error, function_missing}
120 Print the documentation for Module:Function/Arity.
122 ht(Module :: module()) -> h_return()
124 Types:
126 h_return() =
128 ok | {error, missing | {unknown_format, unicode:chardata()}}
129 Print the type documentation for Module
131 ht(Module :: module(), Type :: atom()) -> ht_return()
133 Types:
135 h_return() =
137 ok | {error, missing | {unknown_format, unicode:chardata()}}
138 ht_return() = h_return() | {error, type_missing}
139 Print the type documentation for Type in Module regardless of
141 arity.
142 ht(Module :: module(), Type :: atom(), Arity :: arity()) ->
144 ht_return()
145 Types:
147 h_return() =
149 ok | {error, missing | {unknown_format, unicode:chardata()}}
150 ht_return() = h_return() | {error, type_missing}
151 Print the type documentation for Type/Arity in Module.
153 i() -> ok
155 ni() -> ok
157 i/0 displays system information, listing information about all
159 processes. ni/0 does the same, but for all nodes the network.
160 i(X, Y, Z) -> [{atom(), term()}]
162 Types:
164 X = Y = Z = integer() >= 0
166 Displays information about a process, Equivalent to
168 process_info(pid(X, Y, Z)), but location transparent.
169 l(Module) -> code:load_ret()
171 Types:
173 Module = module()
175 Purges and loads, or reloads, a module by calling
177 code:purge(Module) followed by code:load_file(Module).
178 Notice that purging the code means that any processes lingering
180 in old code for the module are killed without warning. For more
181 information, see code/3.
182 lc(Files) -> ok
184 Types:
186 Files = [File]
188 File
189 Compiles a list of files by calling compile:file(File, [re‐
191 port_errors, report_warnings]) for each File in Files.
192 For information about File, see file:filename().
194 lm() -> [code:load_ret()]
196 Reloads all currently loaded modules that have changed on disk
198 (see mm()). Returns the list of results from calling l(M) for
199 each such M.
200 ls() -> ok
202 Lists files in the current directory.
204 ls(Dir) -> ok
206 Types:
208 Dir = file:name()
210 Lists files in directory Dir or, if Dir is a file, only lists
212 it.
213 m() -> ok
215 Displays information about the loaded modules, including the
217 files from which they have been loaded.
218 m(Module) -> ok
220 Types:
222 Module = module()
224 Displays information about Module.
226 mm() -> [module()]
228 Lists all modified modules. Shorthand for code:modified_mod‐
230 ules/0.
231 memory() -> [{Type, Size}]
233 Types:
235 Type = atom()
237 Size = integer() >= 0
238 Memory allocation information. Equivalent to erlang:memory/0.
240 memory(Type) -> Size
242 memory(Types) -> [{Type, Size}]
244 Types:
246 Types = [Type]
248 Type = atom()
249 Size = integer() >= 0
250 Memory allocation information. Equivalent to erlang:memory/1.
252 nc(File) -> {ok, Module} | error
254 nc(File, Options) -> {ok, Module} | error
256 Types:
258 File = file:name()
260 Options = [Option] | Option
261 Option = compile:option()
262 Module = module()
263 Compiles and then loads the code for a file on all nodes. Op‐
265 tions defaults to []. Compilation is equivalent to:
266 compile:file(File, Options ++ [report_errors, report_warnings])
268 nl(Module) -> abcast | error
270 Types:
272 Module = module()
274 Loads Module on all nodes.
276 pid(X, Y, Z) -> pid()
278 Types:
280 X = Y = Z = integer() >= 0
282 Converts X, Y, Z to pid <X.Y.Z>. This function is only to be
284 used when debugging.
285 pwd() -> ok
287 Prints the name of the working directory.
289 q() -> no_return()
291 This function is shorthand for init:stop(), that is, it causes
293 the node to stop in a controlled fashion.
294 regs() -> ok
296 nregs() -> ok
298 regs/0 displays information about all registered processes.
300 nregs/0 does the same, but for all nodes in the network.
301 uptime() -> ok
303 Prints the node uptime (as specified by erlang:statis‐
305 tics(wall_clock)) in human-readable form.
306 xm(ModSpec) -> void()
308 Types:
310 ModSpec = Module | Filename
312 Module = atom()
313 Filename = string()
314 Finds undefined functions, unused functions, and calls to depre‐
316 cated functions in a module by calling xref:m/1.
317 y(File) -> YeccRet
319 Types:
321 File = name()
323 YeccRet
324 Generates an LALR-1 parser. Equivalent to:
326 yecc:file(File)
328 For information about File = name(), see filename(3). For infor‐
330 mation about YeccRet, see yecc:file/2.
331 y(File, Options) -> YeccRet
333 Types:
335 File = name()
337 Options, YeccRet
338 Generates an LALR-1 parser. Equivalent to:
340 yecc:file(File, Options)
342 For information about File = name(), see filename(3). For infor‐
344 mation about Options and YeccRet, see yecc:file/2.
345
347 filename(3), compile(3), erlang(3), yecc(3), xref(3)
348Ericsson AB stdlib 3.14.2.1 c(3)