File: dmtcp_launch.latex2man

package info (click to toggle)
dmtcp 2.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,496 kB
  • sloc: cpp: 33,592; ansic: 28,099; sh: 6,735; makefile: 1,950; perl: 1,690; python: 1,241; asm: 138; java: 13
file content (129 lines) | stat: -rw-r--r-- 5,066 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
\begin{Name}{1}{dmtcp\_launch}{Kapil Arya, Gene Cooperman, Rohan Garg, et al.}{Distributed MultiThreaded CheckPointing}{dmtcp\_launch -- launch a process under DMTCP control}
  \myProg{dmtcp\_launch} -- launch a process under DMTCP control.
\end{Name}

\section{Synopsis}
%%%%%%%%%%%%%%%%%%

\myProg{dmtcp\_launch} \oArg{OPTIONS} \Arg{<command>} \oArg{args...}

\section{Description}
%%%%%%%%%%%%%%%%%%

\myProg{dmtcp\_launch} launches a process under DMTCP control.

%%% latex2man-1.24 requires that the call to \texttt{} be on a single line.
A typical usage is:\\
\texttt{~~rm ckpt\_a.out\_*.dmtcp \# Remove any stale copies of ckpt image}\\
\texttt{~~dmtcp\_launch --interval 5 a.out}\\
\texttt{~~dmtcp\_command --checkpoint \# Execute this in another window}\\
\texttt{~~\# Kill the currently running a.out process}\\
\texttt{~~dmtcp\_restart ckpt\_a.out\_*.dmtcp}

\section{Options}
%%%%%%%%%%%%%%%%%%

\subsubsection{Connecting to the DMTCP Coordinator}
\begin{Description}
  \item[\Opt{-h}, \Opt{--coord-host} \Arg{hostname} (environment variable DMTCP\_COORD\_HOST)]
    Hostname where dmtcp\_coordinator is run (default: localhost)

  \item[\Opt{-p}, \Opt{--coord-port} \Arg{port} (environment variable DMTCP\_COORD\_PORT)]
    Port where dmtcp\_coordinator is run (default: 7779)

  \item[\OptSArg{--port-file}{filename}]
    File to write listener port number.
    (Useful with \Opt{--coord-port 0}, which is used to assign a random port)

  \item[\Opt{-j}, \Opt{--join}]
    Join an existing coordinator, raise error if one doesn't
    already exist

  \item[\Opt{--new-coordinator}]
    Create a new coordinator at the given port. Fail if one
    already exists on the given port. The port can be specified
    with \Opt{--coord-port}, or with environment variable DMTCP\_COORD\_PORT.
    If no port is specified, start coordinator at a random port (same
    as specifying port '0').

  \item[\Opt{--no-coordinator}]
    Execute the process in stand-alone coordinator-less mode.\\
    Use \myProg{dmtcp\_command} or \Opt{--interval} to request checkpoints.

  \item[\Opt{-i}, \Opt{--interval} \Arg{seconds} (environment variable DMTCP\_CHECKPOINT\_INTERVAL)]
    Time in seconds between automatic checkpoints.
    0 implies never (manual ckpt only); if not set and no env var,
    use default value set in dmtcp\_coordinator or dmtcp\_command.
    Not allowed if \Opt{--join} is specified
\end{Description}

\subsubsection{Checkpoint image generation}
\begin{Description}
  \item[\Opt{--gzip}, \Opt{--no-gzip} (environment variable DMTCP\_GZIP=\Lbr01\Rbr)]
    Enable/disable compression of checkpoint images (default: 1 (enabled))\\
    WARNING:  gzip adds seconds.  Without gzip, ckpt is often $<$ 1s

  \item[\OptSArg{--ckptdir}{path} (environment variable DMTCP\_CHECKPOINT\_DIR)]
    Directory to store checkpoint images (default: curr dir at launch)

  \item[\Opt{--ckpt-open-files}]
    Checkpoint open files and restore old working dir. (default: do neither)

  \item[\Opt{--checkpoint-open-files}]
    Deprecated. Use \Opt{--ckpt-open-files} instead.

  \item[\OptSArg{--ckpt-signal}{signum}]
      Signal number used internally by DMTCP for checkpointing (default: 12)

  \item[\OptSArg{--ckpt-signal}{signum}]
    Deprecated. Use \Opt{--ckpt-signal} instead.

\end{Description}

\subsubsection{Enable/disable plugins}
\begin{Description}
  \item[\OptSArg{--with-plugin}{plugins} (environment variable DMTCP\_PLUGIN)]
    Colon-separated list of DMTCP plugins to be preloaded with DMTCP.
    (Absolute pathnames are required.)

  \item[\Opt{--batch-queue}, \Opt{--rm}]
    Enable support for resource managers (Torque PBS and SLURM).
    (default: disabled)

  \item[\Opt{--ptrace}]
    Enable support for PTRACE system call for gdb/strace etc. (default: disabled)

  \item[\Opt{--modify-env}]
    Update environment variables based on the environment on the restart host
    (e.g., DISPLAY=\$DISPLAY).  This can be set in a file dmtcp\_env.txt.
    (default: disabled)

  \item[\Opt{--ib}, \Opt{--infiniband}]
    Enable InfiniBand plugin. (default: disabled)

  \item[\Opt{--disable-alloc-plugin} (environment variable DMTCP\_ALLOC\_PLUGIN=\Lbr01\Rbr)]
    Disable alloc plugin (default: enabled).

  \item[\Opt{--disable-dl-plugin} (environment variable DMTCP\_DL\_PLUGIN=\Lbr01\Rbr)]
    Disable dl plugin (default: enabled).

  \item[\Opt{--disable-all-plugins} (EXPERTS ONLY, FOR DEBUGGING)]
    Disable all plugins.
\end{Description}

\subsubsection{Other options}
\begin{Description}
  \item[\OptSArg{--prefix}{path}]
    Prefix where DMTCP is installed on remote nodes.

  \item[\OptSArg{--tmpdir}{path} (environment variable DMTCP\_TMPDIR)]
    Directory to store temporary files
    (default: \$TMDPIR/dmtcp-\$USER@\$HOST or /tmp/dmtcp-\$USER@\$HOST)

  \item[\Opt{-q}, \Opt{--quiet} (or set environment variable DMTCP\_QUIET = 0, 1, or 2)]
    Skip NOTE messages; if given twice, also skip WARNINGs

  \item[\Opt{--help}] Print this message and exit.

  \item[\Opt{--version}] Print version information and exit.
\end{Description}