<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/LocalProcessInfo.md - fork/wezterm @ termiz-0.23.3</title>
<meta name="description" content="docs/config/lua/LocalProcessInfo.md in fork/wezterm at termiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/LocalProcessInfo.md - fork/wezterm @ termiz-0.23.3">
<meta property="og:description" content="docs/config/lua/LocalProcessInfo.md in fork/wezterm at termiz-0.23.3.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="termiz-0.23.3" data-tip="4bf28e253c0167102f07bfc7e7199c13eed98012">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wez Furlong</span><span class="commit-message" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">docs: update a bunch of since lines to new macro</span><span class="snapshot-sha sha" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">40081cb57</span><time datetime="2023-03-20T22:01:24-07:00" title="2023-03-20 22:01:24 -0700">2023-03-20</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-0.23.3</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a class="current" href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/termiz-0.23.3/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.3/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termiz-0.23.3/tree/docs/config/lua/">lua</a> / <span class="cur">LocalProcessInfo.md</span></nav>
<span class="view-stats"><span>1.1 KiB</span><span>18 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/b9cca88630ca1d34db0f8ba0a4b8816be8627d6f/docs/config/lua/LocalProcessInfo.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1><code>LocalProcessInfo</code></h1>
<p>{{since('20220101-133340-7edc5b5a')}}</p>
<p><code>LocalProcessInfo</code> represents a process running on the local machine.</p>
<p>It has the following fields:</p>
<ul>
<li><code>pid</code> - the process id</li>
<li><code>ppid</code> - the parent process id</li>
<li><code>name</code> - a short name for the process. Due to platform limitations, this may be inaccurate and truncated; you probably should prefer to look at the <code>executable</code> or <code>argv</code> fields instead of this one</li>
<li><code>status</code> - a string holding the status of the process; it can be <code>Idle</code>, <code>Run</code>, <code>Sleep</code>, <code>Stop</code>, <code>Zombie</code>, <code>Tracing</code>, <code>Dead</code>, <code>Wakekill</code>, <code>Waking</code>, <code>Parked</code>, <code>LockBlocked</code>, <code>Unknown</code>.</li>
<li><code>argv</code> - a table holding the argument array for the process</li>
<li><code>executable</code> - the full path to the executable image for the process (may be empty)</li>
<li><code>cwd</code> - the current working directory for the process (may be empty)</li>
<li><code>children</code> - a table keyed by child process id and whose values are themselves <code>LocalProcessInfo</code> objects that describe the child processes</li>
</ul>
<p>See <a href="/fork/wezterm/ref/termiz-0.23.3/blob/docs/config/lua/mux-events/mux-is-process-stateful.md">mux-is-process-stateful</a> and <a href="/fork/wezterm/ref/termiz-0.23.3/blob/docs/config/lua/pane/get_foreground_process_info.md">pane:get_foreground_process_info()</a></p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>`LocalProcessInfo`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">{{since(&#39;20220101-133340-7edc5b5a&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">`LocalProcessInfo` represents a process running on the local machine.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">It has the following fields:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>* </a-p>`pid` - the process id</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>* </a-p>`ppid` - the parent process id</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>* </a-p>`name` - a short name for the process. Due to platform limitations, this may be inaccurate and truncated; you probably should prefer to look at the `executable` or `argv` fields instead of this one</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>* </a-p>`status` - a string holding the status of the process; it can be `Idle`, `Run`, `Sleep`, `Stop`, `Zombie`, `Tracing`, `Dead`, `Wakekill`, `Waking`, `Parked`, `LockBlocked`, `Unknown`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>* </a-p>`argv` - a table holding the argument array for the process</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>* </a-p>`executable` - the full path to the executable image for the process (may be empty)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>* </a-p>`cwd` - the current working directory for the process (may be empty)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>* </a-p>`children` - a table keyed by child process id and whose values are themselves `LocalProcessInfo` objects that describe the child processes</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">See [mux-is-process-stateful](mux-events/mux-is-process-stateful.md) and [pane:get_foreground_process_info()](pane/get_foreground_process_info.md)</span></span></pre></div></div>
</main>
</body>
</html>
