edoc_run(3erl) [linux man page]

edoc_run(3erl)						     Erlang Module Definition						    edoc_run(3erl)

NAME

       edoc_run - Interface for calling EDoc from Erlang startup options.

DESCRIPTION

       Interface for calling EDoc from Erlang startup options.

       The following is an example of typical usage in a Makefile:

	    docs:
		    erl -noshell -run edoc_run application "'$(APP_NAME)'" 
		      '"."' '[{def,{vsn,"$(VSN)"}}]'

       (note the single-quotes to avoid shell expansion, and the double-quotes enclosing the strings).

       New feature in version 0.6.9 : It is no longer necessary to write -s init stop last on the command line in order to make the execution ter-
       minate. The termination (signalling success or failure to the operating system) is now built into these functions.

EXPORTS

       application(Args::[string()]) -> none()

	      Calls edoc:application/3 with the corresponding arguments. The strings in the list are parsed as Erlang constant terms. The list can
	      be  either  [App]  ,  [App,  Options] or [App, Dir, Options] . In the first case edoc:application/1 is called instead; in the second
	      case, edoc:application/2 is called.

	      The function call never returns; instead, the emulator is automatically terminated when the call has completed,  signalling  success
	      or failure to the operating system.

       file(Args::[string()]) -> none()

	      This function is deprecated: This is part of the old interface to EDoc and is mainly kept for backwards compatibility. The preferred
	      way of generating documentation is through one of the functions application/1 , packages/1 and files/1 .

	      Calls edoc:file/2 with the corresponding arguments. The strings in the list are parsed as Erlang constant terms.	The  list  can	be
	      either [File] or [File, Options] . In the first case, an empty list of options is passed to edoc:file/2 .

	      The following is an example of typical usage in a Makefile:

		   $(DOCDIR)/%.html:%.erl
			   erl -noshell -run edoc_run file '"$<"' '[{dir,"$(DOCDIR)"}]' 
			     -s init stop

	      The  function  call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success
	      or failure to the operating system.

       files(Args::[string()]) -> none()

	      Calls edoc:files/2 with the corresponding arguments. The strings in the list are parsed as Erlang constant terms. The  list  can	be
	      either [Files] or [Files, Options] . In the first case, edoc:files/1 is called instead.

	      The  function  call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success
	      or failure to the operating system.

       packages(Args::[string()]) -> none()

	      Calls edoc:application/2 with the corresponding arguments. The strings in the list are parsed as Erlang constant terms. The list can
	      be either [Packages] or [Packages, Options] . In the first case edoc:application/1 is called instead.

	      The  function  call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success
	      or failure to the operating system.

SEE ALSO

       edoc

AUTHORS

       Richard Carlsson <richardc@it.uu.se >

								    edoc 0.7.7							    edoc_run(3erl)

ct_rpc(3erl)						     Erlang Module Definition						      ct_rpc(3erl)

NAME

       ct_rpc - Common Test specific layer on Erlang/OTP rpc.

DESCRIPTION

       Common Test specific layer on Erlang/OTP rpc.

EXPORTS

       app_node(App, Candidates) -> NodeName

	      Types  App = atom()
		     Candidates = [NodeName]
		     NodeName = atom()

	      From a set of candidate nodes determines which of them is running the application App. If none of the candidate nodes is running the
	      application the function will make the test case calling this function fail. This function is the same as calling app_node(App, Can-
	      didates, true) .

       app_node(App, Candidates, FailOnBadRPC) -> NodeName

	      Types  App = atom()
		     Candidates = [NodeName]
		     NodeName = atom()
		     FailOnBadRPC = true | false

	      Same  as app_node/2 only the FailOnBadRPC argument will determine if the search for a candidate node should stop or not if badrpc is
	      received at some point.

       app_node(App, Candidates, FailOnBadRPC, Cookie) -> NodeName

	      Types  App = atom()
		     Candidates = [NodeName]
		     NodeName = atom()
		     FailOnBadRPC = true | false
		     Cookie = atom()

	      Same as app_node/2 only the FailOnBadRPC argument will determine if the search for a candidate node should stop or not if badrpc	is
	      received	at  some  point.  The cookie on the client node will be set to Cookie for this rpc operation (use to match the server node
	      cookie).

       call(Node, Module, Function, Args) -> term() | {badrpc, Reason}

	      Same as call(Node, Module, Function, Args, infinity)

       call(Node, Module, Function, Args, TimeOut) -> term() | {badrpc, Reason}

	      Types  Node = NodeName | {Fun, FunArgs}
		     Fun = function()
		     FunArgs = term()
		     NodeName = atom()
		     Module = atom()
		     Function = atom()
		     Args = [term()]
		     Reason = timeout | term()

	      Evaluates apply(Module, Function, Args) on the node Node. Returns whatever Function returns or {badrpc, Reason} if the remote proce-
	      dure call fails. If Node is {Fun, FunArgs} applying Fun to FunArgs should return a node name.

       call(Node, Module, Function, Args, TimeOut, Cookie) -> term() | {badrpc, Reason}

	      Types  Node = NodeName | {Fun, FunArgs}
		     Fun = function()
		     FunArgs = term()
		     NodeName = atom()
		     Module = atom()
		     Function = atom()
		     Args = [term()]
		     Reason = timeout | term()
		     Cookie = atom()

	      Evaluates apply(Module, Function, Args) on the node Node. Returns whatever Function returns or {badrpc, Reason} if the remote proce-
	      dure call fails. If Node is {Fun, FunArgs} applying Fun to FunArgs should return a node name. The cookie on the client node will	be
	      set to Cookie for this rpc operation (use to match the server node cookie).

       cast(Node, Module, Function, Args) -> ok

	      Types  Node = NodeName | {Fun, FunArgs}
		     Fun = function()
		     FunArgs = term()
		     NodeName = atom()
		     Module = atom()
		     Function = atom()
		     Args = [term()]
		     Reason = timeout | term()

	      Evaluates  apply(Module, Function, Args) on the node Node. No response is delivered and the process which makes the call is not sus-
	      pended until the evaluation is compleated as in the case of call/[3,4]. If Node is {Fun, FunArgs} applying  Fun  to  FunArgs  should
	      return a node name.

       cast(Node, Module, Function, Args, Cookie) -> ok

	      Types  Node = NodeName | {Fun, FunArgs}
		     Fun = function()
		     FunArgs = term()
		     NodeName = atom()
		     Module = atom()
		     Function = atom()
		     Args = [term()]
		     Reason = timeout | term()
		     Cookie = atom()

	      Evaluates  apply(Module, Function, Args) on the node Node. No response is delivered and the process which makes the call is not sus-
	      pended until the evaluation is compleated as in the case of call/[3,4]. If Node is {Fun, FunArgs} applying  Fun  to  FunArgs  should
	      return  a  node  name.  The  cookie  on  the  client node will be set to Cookie for this rpc operation (use to match the server node
	      cookie).

AUTHORS

       <>

								 common_test 1.5.3						      ct_rpc(3erl)