Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add a man page for smpicc and smpirun
[simgrid.git] / doc / manpage / smpirun.1
1 .TH smpirun 1
2 .SH NAME
3 smpirun \- Allow the configuration and the execution of MPI programs with simgrid and SMPI
4 .SH SYNOPSIS
5 smpirun [\fIOPTIONS\fR]… \fB\-platform\fR <platform.xml> \fB\-hostfile\fR <hostfile> program [\fIPROGRAM-OPTIONS\fR]…
6 .SH DESCRIPTION
7 smpirun provides an easy way to run programs linked to simgrid and using SMPI. It sets some default values, and generate a deployment file using the mandatory arguments \fB-platform\fR and \fB-hostfile\fR.
8 .TP
9 \fB\-platform\fR <platform.xml>
10 XML file describing the platform on which we want to deploy the program 
11 .TP
12 \fB\-hostfile\fR, \fB\-machinefile\fR <hostfile>
13 Hostfile listing all the machines in use
14 .SH OPTIONS
15 .SS Configuration options
16 The configuration of the simulation can be tweaked using \fB--cfg\fR=\fIparameter\fR:\fIvalue\fR. Refer to http://simgrid.gforge.inria.fr/simgrid/latest/doc/options.html to know what are the different possibilities.
17 .SS Other options
18 .TP
19 \fB\-help\fR
20 Print the usage and a résumé of the available options
21 .TP
22 \fB\-keep-temps\fR
23 Do not remove the generated files after execution.
24 .TP
25 \fB\-wrapper\fR <command>
26 Use command to run the program (e.g. "valgrind").
27 .TP
28 \fB\-map\fR
29 Display the machine on which each process rank is mapped.
30 .TP
31 \fB\-np\fR <numprocs>
32 Use that amount of processes. By default, there is the same number of processes as there are of hosts in the hostfile.
33 .TP
34 \fB\-trace\fR
35 Equivalent to \fB–cfg\fR=\fItracing\fR:\fIyes\fR \fB–cfg\fR=\fItracing/smpi\fR:\fIyes\fR, activate the trace mecanism if available.
36 .TP
37 \fB\-trace-ti\fR
38 Activate time independant tracing.
39 .TP
40 \fB\-trace-comment\fR <comment>
41 Put a comment on the top of the trace file.
42 .TP
43 \fB\-trace-comment-file\fR <file>
44 Insert the content of the file at the head of the trace file as a comment.
45 .TP
46 \fB\-trace-grouped\fR
47 Group MPI processes by location.
48 .TP
49 \fB\-trace-resource\fR
50 Trace resource utilization.
51 .TP
52 \fB\-trace-viva\fR
53 Generate configuration for Viva's GraphView.
54 .TP
55 \fB\-trace-file\fR <tracefile>
56 Name of the tracefile
57 .SH AUTHORS
58 The SimGrid team (simgrid-devel@lists.gforge.inria.fr)
59 .SH COPYRIGHT AND LICENCE
60 Copyright (c) 2014. The SimGrid Team. All rights reserved.
61
62 This program is free software; you may redistribute it and/or modify it under the terms of GNU LGPL (v2.1) license.
63 .SH SEE ALSO
64 .B smpicc\fR(1)