[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 (c) 2008 Sun Microsystems, Inc. All rights reserved. |
---|
| 6 | .\" |
---|
| 7 | .\" Man page for OMPI's ompi-checkpoint command |
---|
| 8 | .\" |
---|
| 9 | .\" .TH name section center-footer left-footer center-header |
---|
| 10 | .TH OMPI-CHECKPOINT 1 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 11 | .\" ************************** |
---|
| 12 | .\" Name Section |
---|
| 13 | .\" ************************** |
---|
| 14 | .SH NAME |
---|
| 15 | . |
---|
| 16 | ompi-checkpoint, orte-checkpoint \- Checkpoint a running parallel process using the Open MPI |
---|
| 17 | Checkpoint/Restart Service (CRS) |
---|
| 18 | . |
---|
| 19 | .PP |
---|
| 20 | . |
---|
| 21 | \fBNOTE:\fP \fIompi-checkpoint\fP, and \fIorte-checkpoint\fP are all exact |
---|
| 22 | synonyms for each other. Using any of the names will result in exactly |
---|
| 23 | identical behavior. |
---|
| 24 | . |
---|
| 25 | .\" ************************** |
---|
| 26 | .\" Synopsis Section |
---|
| 27 | .\" ************************** |
---|
| 28 | .SH SYNOPSIS |
---|
| 29 | . |
---|
| 30 | .B ompi-checkpoint |
---|
| 31 | .R [ options ] |
---|
| 32 | .B <PID_OF_MPIRUN> |
---|
| 33 | . |
---|
| 34 | .\" ************************** |
---|
| 35 | .\" Options Section |
---|
| 36 | .\" ************************** |
---|
| 37 | .SH Options |
---|
| 38 | . |
---|
| 39 | \fIorte-checkpoint\fR will attempt to notify a running parallel job (identified |
---|
| 40 | by \fImpirun\fP) that it has been requested that the job checkpoint itself. A |
---|
| 41 | global snapshot handle reference is presented to the user, which is used in |
---|
| 42 | \fIompi_restart\fP to restart the job. |
---|
| 43 | . |
---|
| 44 | .TP 10 |
---|
| 45 | .B <PID_OF_MPIRUN> |
---|
| 46 | Process ID of the \fImpirun\fP process. |
---|
| 47 | . |
---|
| 48 | . |
---|
| 49 | .TP |
---|
| 50 | .B -h | --help |
---|
| 51 | Display help for this command |
---|
| 52 | . |
---|
| 53 | . |
---|
| 54 | .TP |
---|
| 55 | .B -w | --nowait |
---|
| 56 | Do not wait for the application to finish checkpointing before returning. |
---|
| 57 | . |
---|
| 58 | . |
---|
| 59 | .TP |
---|
| 60 | .B -s | --status |
---|
| 61 | Display status messages regarding the progression of the checkpoint request. |
---|
| 62 | . |
---|
| 63 | . |
---|
| 64 | .TP |
---|
| 65 | .B --term |
---|
| 66 | After checkpointing the running job, terminate it. |
---|
| 67 | . |
---|
| 68 | . |
---|
| 69 | .TP |
---|
| 70 | .B -v | --verbose |
---|
| 71 | Enable verbose output for debugging. |
---|
| 72 | . |
---|
| 73 | . |
---|
| 74 | .TP |
---|
| 75 | .B -gmca | --gmca \fR<key> <value>\fP |
---|
| 76 | Pass global MCA parameters that are applicable to all contexts. \fI<key>\fP is |
---|
| 77 | the parameter name; \fI<value>\fP is the parameter value. |
---|
| 78 | . |
---|
| 79 | . |
---|
| 80 | .TP |
---|
| 81 | .B -mca | --mca <key> <value> |
---|
| 82 | Send arguments to various MCA modules. |
---|
| 83 | . |
---|
| 84 | . |
---|
| 85 | .\" ************************** |
---|
| 86 | .\" Description Section |
---|
| 87 | .\" ************************** |
---|
| 88 | .SH DESCRIPTION |
---|
| 89 | . |
---|
| 90 | .PP |
---|
| 91 | \fIorte-checkpoint\fR can be invoked multiple, non-overlapping times. |
---|
| 92 | It is convenient to note that the user does not need to spectify |
---|
| 93 | the checkpointer to be used here, as that is determined completely by each of |
---|
| 94 | the running process in the job being checkpointed. |
---|
| 95 | . |
---|
| 96 | . |
---|
| 97 | .\" ************************** |
---|
| 98 | .\" See Also Section |
---|
| 99 | .\" ************************** |
---|
| 100 | . |
---|
| 101 | .SH SEE ALSO |
---|
| 102 | orte-ps(1), orte-clean(1), ompi-restart(1), opal-checkpoint(1), opal-restart(1), opal_crs(7) |
---|
| 103 | . |
---|