Add a man page for smpicc and smpirun

diff --git a/buildtools/Cmake/Distrib.cmake b/buildtools/Cmake/Distrib.cmake
index 61b8edf..8c1c9c0 100644 (file)
--- a/buildtools/Cmake/Distrib.cmake
+++ b/buildtools/Cmake/Distrib.cmake
@@ -20,7 +20,7 @@ if(NOT WIN32)
     COMMAND pod2man ${CMAKE_HOME_DIRECTORY}/tools/simgrid_update_xml.pl > ${MANPAGE_DIR}/simgrid_update_xml.1
     COMMENT "Generating manpages"
     )
-  install(FILES ${MANPAGE_DIR}/simgrid_update_xml.1 ${CMAKE_HOME_DIRECTORY}/tools/tesh/tesh.1
+  install(FILES ${MANPAGE_DIR}/simgrid_update_xml.1 ${CMAKE_HOME_DIRECTORY}/tools/tesh/tesh.1 ${CMAKE_HOME_DIRECTORY}/doc/manpage/smpirun.1 ${CMAKE_HOME_DIRECTORY}/doc/manpage/smpicc.1
     DESTINATION $ENV{DESTDIR}${CMAKE_INSTALL_PREFIX}/share/man/man1)
 
 endif()

diff --git a/doc/manpage/smpicc.1 b/doc/manpage/smpicc.1
new file mode 100644 (file)
index 0000000..2a79ffe
--- /dev/null
+++ b/doc/manpage/smpicc.1
@@ -0,0 +1,17 @@
+.TH smpicc 1
+.SH NAME
+smpicc \- SMPI C wrapper compiler
+.SH SYNOPSIS
+smpicc …
+.SH DESCRIPTION
+smpicc is just a wrapper around the compiler used to build simgrid, adding the right flags in order to use the simgrid library and SMPI, the MPI implementation within it. Any arguments filled to smpicc will be passed to the underlying compiler directly, of which the \fB\-\-version\fR argument should give the name and the version. Please refer to its documentation in case of trouble.
+.SH ENVIRONMENT VARIABLES
+All environment variables taken into account by the compiler will be used, but note that setting CC has no effect.
+.SH AUTHORS
+The SimGrid team (simgrid-devel@lists.gforge.inria.fr)
+.SH COPYRIGHT AND LICENCE
+Copyright (c) 2014. The SimGrid Team. All rights reserved.
+
+This program is free software; you may redistribute it and/or modify it under the terms of GNU LGPL (v2.1) license.
+.SH SEE ALSO
+.B smpirun\fR(1)

diff --git a/doc/manpage/smpirun.1 b/doc/manpage/smpirun.1
new file mode 100644 (file)
index 0000000..1cbee03
--- /dev/null
+++ b/doc/manpage/smpirun.1
@@ -0,0 +1,64 @@
+.TH smpirun 1
+.SH NAME
+smpirun \- Allow the configuration and the execution of MPI programs with simgrid and SMPI
+.SH SYNOPSIS
+smpirun [\fIOPTIONS\fR]… \fB\-platform\fR <platform.xml> \fB\-hostfile\fR <hostfile> program [\fIPROGRAM-OPTIONS\fR]…
+.SH DESCRIPTION
+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.
+.TP
+\fB\-platform\fR <platform.xml>
+XML file describing the platform on which we want to deploy the program 
+.TP
+\fB\-hostfile\fR, \fB\-machinefile\fR <hostfile>
+Hostfile listing all the machines in use
+.SH OPTIONS
+.SS Configuration options
+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.
+.SS Other options
+.TP
+\fB\-help\fR
+Print the usage and a résumé of the available options
+.TP
+\fB\-keep-temps\fR
+Do not remove the generated files after execution.
+.TP
+\fB\-wrapper\fR <command>
+Use command to run the program (e.g. "valgrind").
+.TP
+\fB\-map\fR
+Display the machine on which each process rank is mapped.
+.TP
+\fB\-np\fR <numprocs>
+Use that amount of processes. By default, there is the same number of processes as there are of hosts in the hostfile.
+.TP
+\fB\-trace\fR
+Equivalent to \fB–cfg\fR=\fItracing\fR:\fIyes\fR \fB–cfg\fR=\fItracing/smpi\fR:\fIyes\fR, activate the trace mecanism if available.
+.TP
+\fB\-trace-ti\fR
+Activate time independant tracing.
+.TP
+\fB\-trace-comment\fR <comment>
+Put a comment on the top of the trace file.
+.TP
+\fB\-trace-comment-file\fR <file>
+Insert the content of the file at the head of the trace file as a comment.
+.TP
+\fB\-trace-grouped\fR
+Group MPI processes by location.
+.TP
+\fB\-trace-resource\fR
+Trace resource utilization.
+.TP
+\fB\-trace-viva\fR
+Generate configuration for Viva's GraphView.
+.TP
+\fB\-trace-file\fR <tracefile>
+Name of the tracefile
+.SH AUTHORS
+The SimGrid team (simgrid-devel@lists.gforge.inria.fr)
+.SH COPYRIGHT AND LICENCE
+Copyright (c) 2014. The SimGrid Team. All rights reserved.
+
+This program is free software; you may redistribute it and/or modify it under the terms of GNU LGPL (v2.1) license.
+.SH SEE ALSO
+.B smpicc\fR(1)