[97] | 1 | .\" |
---|
| 2 | .\" Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana |
---|
| 3 | .\" University Research and Technology |
---|
| 4 | .\" Corporation. All rights reserved. |
---|
| 5 | .\" Copyright 2007-2008 Sun Microsystems, Inc. |
---|
| 6 | .\" |
---|
| 7 | .TH orte-clean 1 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 8 | .SH NAME |
---|
| 9 | \fBorte-clean\fP - Cleans up any stale processes and files leftover |
---|
| 10 | from Open MPI jobs. |
---|
| 11 | |
---|
| 12 | .sp |
---|
| 13 | |
---|
| 14 | .\" ************************** |
---|
| 15 | .\" Synopsis Section |
---|
| 16 | .\" ************************** |
---|
| 17 | .SH SYNOPSIS |
---|
| 18 | .ft R |
---|
| 19 | .nf |
---|
| 20 | orte-clean [--verbose] |
---|
| 21 | .br |
---|
| 22 | mpirun --pernode [--host | --hostfile \fIfile\fP] orte-clean [--verbose] |
---|
| 23 | .sp |
---|
| 24 | |
---|
| 25 | |
---|
| 26 | .\" ************************** |
---|
| 27 | .\" Options Section |
---|
| 28 | .\" ************************** |
---|
| 29 | .SH OPTIONS |
---|
| 30 | .ft R |
---|
| 31 | [-v | --verbose] This argument will run the command in verbose |
---|
| 32 | mode and print out the universes that are getting cleaned up |
---|
| 33 | as well as processes that are being killed. |
---|
| 34 | .sp |
---|
| 35 | |
---|
| 36 | .\" ************************** |
---|
| 37 | .\" Description Section |
---|
| 38 | .\" ************************** |
---|
| 39 | .SH DESCRIPTION |
---|
| 40 | .ft R |
---|
| 41 | \fIorte-clean\fR attempts to clean up any processes and files |
---|
| 42 | left over from Open MPI jobs that were run in the past as well as any |
---|
| 43 | currently running jobs. This includes OMPI infrastructure and helper |
---|
| 44 | commands, any processes that were spawned as part of the job, and any |
---|
| 45 | temporary files. orte-clean will only act upon processes and files |
---|
| 46 | that belong to the user running the orte-clean command. If run as |
---|
| 47 | root, it will kill off processes belonging to any users. |
---|
| 48 | .sp |
---|
| 49 | When run from the command line, orte-clean will attempt to clean up |
---|
| 50 | the local node it is run from. When launched via mpirun, it will |
---|
| 51 | clean up the nodes selected by mpirun. |
---|
| 52 | .sp |
---|
| 53 | |
---|
| 54 | .\" ************************** |
---|
| 55 | .\" Examples Section |
---|
| 56 | .\" ************************** |
---|
| 57 | .SH EXAMPLES |
---|
| 58 | .ft R |
---|
| 59 | Example 1: Clean up local node only. |
---|
| 60 | .sp |
---|
| 61 | .nf |
---|
| 62 | example% orte-clean |
---|
| 63 | .fi |
---|
| 64 | .sp |
---|
| 65 | |
---|
| 66 | Example 2: To clean up on a specific set of nodes specified on |
---|
| 67 | command line, it is recommended to use the pernode option. This |
---|
| 68 | will run one orte-clean for each node. |
---|
| 69 | .sp |
---|
| 70 | .nf |
---|
| 71 | example% mpirun --pernode --host node1,node2,node3 orte-clean |
---|
| 72 | .fi |
---|
| 73 | .sp |
---|
| 74 | To clean up on a specific set of nodes from a file. |
---|
| 75 | .sp |
---|
| 76 | .nf |
---|
| 77 | example% mpirun --pernode --hostfile nodes_file orte-clean |
---|
| 78 | .fi |
---|
| 79 | .sp |
---|
| 80 | Example 3: Within a resource managed environment like N1GE, |
---|
| 81 | SLURM, or Torque. The following example is from N1GE. |
---|
| 82 | .sp |
---|
| 83 | First, we see that we have two nodes with two CPUs each. |
---|
| 84 | .sp |
---|
| 85 | .nf |
---|
| 86 | example% qsh -pe orte 4 |
---|
| 87 | .br |
---|
| 88 | example% mpirun -np 4 hostname |
---|
| 89 | .br |
---|
| 90 | node1 |
---|
| 91 | .br |
---|
| 92 | node1 |
---|
| 93 | .br |
---|
| 94 | node2 |
---|
| 95 | .br |
---|
| 96 | node2 |
---|
| 97 | .fi |
---|
| 98 | .sp |
---|
| 99 | Clean up all the nodes in the cluster. |
---|
| 100 | .sp |
---|
| 101 | .nf |
---|
| 102 | example% mpirun --pernode orte-clean |
---|
| 103 | .fi |
---|
| 104 | .sp |
---|
| 105 | Clean up a subset of the nodes in the cluster. |
---|
| 106 | .sp |
---|
| 107 | .nf |
---|
| 108 | example% mpirun --pernode --host node1 orte-clean |
---|
| 109 | .fi |
---|
| 110 | .sp |
---|
| 111 | |
---|
| 112 | .\" ************************** |
---|
| 113 | .\" See Also Section |
---|
| 114 | .\" ************************** |
---|
| 115 | . |
---|
| 116 | .SH SEE ALSO |
---|
| 117 | .ft R |
---|
| 118 | orterun(1), orte-ps(1) |
---|
| 119 | .sp |
---|