Permalink
Browse files

Documentation fixes

  • Loading branch information...
saleyn committed Oct 1, 2012
1 parent 3f3f259 commit 88af0b874305ca00ffa1db352624f2dc12405623
Showing with 15 additions and 13 deletions.
  1. +1 −1 src/exec.erl
  2. +3 −1 src/exec_app.erl
  3. +11 −11 src/overview.edoc
View
@@ -28,7 +28,7 @@
%%% versa.
%%%
%%% @author Serge Aleynikov <saleyn@gmail.com>
-%%% @version $Revision$
+%%% @version {@vsn}
%%%
%%% @type exec_options() = [Option]
%%% Option = debug | verbose | {args, Args} | {alarm, Secs} |
View
@@ -1,7 +1,8 @@
%%%------------------------------------------------------------------------
%%% File: $Id$
%%%------------------------------------------------------------------------
-%%% @doc Application for managing OS processes.
+%%% @doc This module implements application and supervisor behaviors
+%%% of the `exec' application.
%%% @author Serge Aleynikov <saleyn@gmail.com>
%%% @version $Revision: 1.1 $
%%% @end
@@ -14,6 +15,7 @@
-id ("$Id$").
-behaviour(application).
+-behaviour(supervisor).
%% application and supervisor callbacks
-export([start/2, stop/1, init/1]).
View
@@ -51,7 +51,7 @@ Currently the project supports Linux and Solaris operating systems.
* - - - - - - + - - - - - *
|
+-----------+
- | exec-port | Port program (separate OS process
+ | exec-port | Port program (separate OS process)
+-----------+
/ | \
/ | \
@@ -66,19 +66,19 @@ See description of types in {@link exec:exec_options()}.
<h3><a name="ex">Examples</a></h3>
```
-1> exec:start([]). % Start the port program.
+1> exec:start([]). % Start the port program.
{ok,<0.32.0>}
-2> exec:run_link("exec sleep 1000", []). % Run a shell command to sleep for 1000s.
+2> {ok, _, I} = exec:run_link("exec sleep 1000", []). % Run a shell command to sleep for 1000s.
{ok,<0.34.0>,23584}
-3> exec:stop(23584). % Kill the shell command.
-ok % Note that this could also be accomplished
- % by doing exec:stop(pid(0,34,0)).
+3> exec:stop(I). % Kill the shell command.
+ok % Note that this could also be accomplished
+ % by doing exec:stop(pid(0,34,0)).
-** exception error: {exit_status,15} % Our shell died because we linked to the
- % shell process via exec:run_link/2.
+** exception error: {exit_status,15} % Our shell died because we linked to the
+ % shell process via exec:run_link/2.
-4> exec:status(15). % Examine the exit status.
-{signal,15,false} % The program got SIGTERM signal and produced
- % no core file.
+4> exec:status(15). % Examine the exit status.
+{signal,15,false} % The program got SIGTERM signal and produced
+ % no core file.
'''
@end

0 comments on commit 88af0b8

Please sign in to comment.