/[escript]/trunk/doc/manpage/escript.1
ViewVC logotype

Diff of /trunk/doc/manpage/escript.1

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2344 by jfenwick, Mon Mar 2 03:44:27 2009 UTC revision 2345 by jfenwick, Mon Mar 30 04:44:06 2009 UTC
# Line 1  Line 1 
1    .TH escript 1 "" "" "esys Escript-Finley"
2    
3  Man page for the escript wrapper script.  .SH NAME
4    escript - a launcher for programs and scripts using the escript libraries.
5    .SH SYNOPSIS
6    escript [-n
7    .I nn
8    ] [-p
9    .I
10    np
11    ] [-t
12    .I
13    nt
14    ] [-f
15    .I
16    hostfile
17    ] [-x ] [-V ] [-e ] [-h ] [-v ] [-o ] [-c ] [-i ] [-b ] [
18    .I
19    file
20    ] [
21    .I
22    ARGS
23    ]
24    
25    .SH OPTIONS
26    
27    .P
28    .I
29    file
30    is the name of a script,
31    .I ARGS
32    are arguments for the script.  
33    .B escript
34    will import your current
35    environment variables. If no
36    .I
37    file
38    is given, then you will be given a python prompt (see -i for restrictions).
39    The options are used as follows:
40    .HP
41    .B
42    -n
43    .I
44    nn
45    Specify the number of compute nodes nn to be used.
46    This option overwrites the value of the
47    .B
48    ESCRIPT_NUM_NODES
49    environment variable. If
50    .I
51    nn
52    > 1 but escript was not compiled for MPI, then a warning is printed but execution is continued with
53    .I nn
54    = 1. The default value is 1.
55    
56    .HP
57    .B
58    -p
59    .I np
60    Specifiy the number of MPI processes per node.
61    The total number of processes to be used is
62    .I
63    nn
64    times
65    .I ns
66    .\" Please put a dot here
67    This option overwrites the value of the
68    .B
69    ESCRIPT_NUM_PROC
70    environment variable. If
71    .I
72    np
73    > 1 but escript is not compiled for MPI a warning
74    is printed but execution is continued with
75    .I
76    np
77    = 1. The default value is 1.
78    .HP
79    .B -t
80    .I nt
81    The number of threads used per processes. This option overwrites the value of the
82    .B
83    ESCRIPT_NUM_THREADS
84    environment variable. If
85    .I
86    nt
87     > 1 but escript is not compiled for OpenMP a warning is printed but execution is continued with
88    .I
89    nt
90    = 1. The default value is 1.
91    .HP
92    .B
93    -f
94    .I hostfile
95    Specify the name of a file with a list of host names. Some systems require to specify the addresses or names of
96    the compute nodes where MPI process should be spawned. The list of addresses or names of the compute
97    nodes is listed in the file with the name hostfile. In order to avoid oversubsription the number of differnt
98    hosts defined in hostfile must be greater or equal to the number of requsted compute nodes nn. The option
99    overwrites the value of the
100    .B ESCRIPT HOSTFILE
101    environment variable. By default value no host file is
102    used.
103    .HP
104    .B
105    -c
106    Prints the information about the settings used to compile escript and stops execution.
107    .HP
108    .B
109    -V
110    Prints the version of escript and stops execution.
111    .HP
112    .B
113    -h
114    Prints a help message and stops execution.
115    
116    .HP
117    .B
118    -i
119    Executes
120    .I
121    file
122    and switches to interactive mode after the execution is finished or an exception has
123    occured. This option is useful for debugging a script. The option cannot be used if more then one process
124    (
125    .I
126    nn
127    *
128    .I
129    np
130    > 1) is used or if
131    .B
132    -b
133    is used.
134    
135    .HP
136    .B
137    -b
138    Do not invoke python. This is used to run non-python programs.
139    
140    .HP
141    .B
142    -e
143    Outputs export statements for the additional environment variables and commands used during escript execution. This option is useful if users wish to excute scripts without using the escript command.
144    
145    .HP
146    .B
147    -o
148    Switches on the redirection of output of processors with MPI rank greater than zero to the files
149    ‘stdout_r.out’ and ‘stderr_r.out’ where
150    .I
151    r
152    is the rank of the processor. The option overwrites the value
153    of the
154    .B
155    ESCRIPT STDFILES
156    environment variable.
157    
158    .HP
159    .B
160    -v
161    Prints some diagonstic information.
162    
   
 If you type:  
   
 man "automatic doors"  
   
 you should see:  
   
 No manual entry for automatic doors  
   
   
 Real content needed for this document.  
Legend:
Removed from v.2344  
changed lines
  Added in v.2345
  ViewVC Help
Powered by ViewVC 1.1.26