# bgl.mcs.anl.gov

Usage: 
       mpirun [options]
    or
       mpirun [options] binary [arg1 arg2 ...]

Options:
  -h                            Provides this extended help information.
                                Can also use '-help'.
  -version                      Display version information.
                                Can also use '-v'.
  -partition <partition_id>     ID of the partition to run the job on.
  -np <compute_nodes>           The number of compute nodes to use for the job.
                                Can also use '-n' or '-nodes'.
  -mode <CO or VN>              Execution mode: COprocessor or VirtualNode mode.  Default is CO.
  -exe <binary>                 Full path of the binary to execute.
  -cwd <directory>              Current working directory of the job,
                                as seen by the compute nodes.
                                Can also use '-wdir'.
  -host <service_node>          Hostname of the service node.
                                Overrides MMCS_SERVER_IP environment variable.
  -shell <remote_shell>         Remote shell mechanism to use.
                                Defaults to RSH, SSH is available.
  -env <"<env vars>">           Environment variables that should be set.
                                (Must be enclosed in double quotes).
  -exp_env <env vars>           Environment variables in the current environment to export.
  -mapfile <mapfile>            File containing a user specified MPI topology
  -args <"<arguments>">         Arguments to pass to the job.
                                (Must be enclosed in double quotes).
  -timeout <seconds>            The limit of the job execution time in seconds.
  -start_gdbserver <gdbserver>  Start gdbserver for job.  Must specify full path to gdbserver.
  -label                        Add labels (STDOUT, STDERR, and MPI Rank) to the job output.
  -nw                           Return MPIRUN job cycle status instead of the job exit status.
  -nofree                       Do not deallocate the partition if MPIRUN had allocated it.
  -noallocate                   Do not allocate the partition.  The job will only start
                                if the partition was already in the Initialized state.
  -backend <binary>             Use a specific mpirun back-end on the service node.
  -kernel_options <options>     Specify kernel verbose options.
  -verbose <0 - 4>              Verbosity level of mpirun.  Default is 0.
  -trace <tracelevel>           Create a detailed trace as mpirun executes.
                                Output is to a a file in the current directory.
  -only_test_protocol           Used to test the mpirun front-end/back-end communications.
                                No actual job will be run.
  -strace <all|none|n>          Enable syscall trace for all nodes, no nodes, or node n
                                where n is an MPI rank number
  -shape <NxNxN>                Shape of the job in XxYxZ format.
                                If not specified you must use -partition and/or -np.
  -psets_per_bp <n>             Number of PSets per BP required in the partition.
  -connect <TORUS or MESH>      Compute node connections.  Default is MESH.
  -enable_tty_reporting         Correctly report tty status to the control system