~nabijaczleweli/febug

17052adf57fab0f3891c5bbfc61639b7d5e81ae4 — наб autouploader 8 months ago f9803d6
OpenBSD manpage update by job 401952
A OpenBSD/febug::FORMATTERS.3 => OpenBSD/febug::FORMATTERS.3 +1 -0
@@ 0,0 1,1 @@
libfebug.rs.3
\ No newline at end of file

A OpenBSD/febug::GLOBAL_CONTROLLED_SOCKET.3 => OpenBSD/febug::GLOBAL_CONTROLLED_SOCKET.3 +1 -0
@@ 0,0 1,1 @@
libfebug.rs.3
\ No newline at end of file

A OpenBSD/febug::StaticWrappable.3 => OpenBSD/febug::StaticWrappable.3 +1 -0
@@ 0,0 1,1 @@
libfebug.rs.3
\ No newline at end of file

A OpenBSD/febug::Wrappable.3 => OpenBSD/febug::Wrappable.3 +1 -0
@@ 0,0 1,1 @@
libfebug.rs.3
\ No newline at end of file

A OpenBSD/febug::Wrapper.3 => OpenBSD/febug::Wrapper.3 +1 -0
@@ 0,0 1,1 @@
libfebug.rs.3
\ No newline at end of file

M OpenBSD/index.0.html => OpenBSD/index.0.html +1 -1
@@ 329,7 329,7 @@ html {		--bg: #1E1F21;
    wrapper library</p>
<p class="Pp"><a class="Xr" href="libfebug++.3.html">libfebug++(3)</a> &#x2013; User-space debugfs ABI
    wrapper library for C++</p>
<p class="Pp"><a class="Xr">libfebug.rs(3)</a> &#x2013; User-space debugfs ABI
<p class="Pp"><a class="Xr" href="libfebug.rs.3.html">libfebug.rs(3)</a> &#x2013; User-space debugfs ABI
    wrapper library for Rust</p>
</section>
<section class="Sh">

M OpenBSD/libfebug++.3 => OpenBSD/libfebug++.3 +2 -1
@@ 55,7 55,8 @@ There are three compile-time macros that allow a program to customise its behavi
.br
If non-zero, all symbols become
\fBstatic\fR,
functions turn into no-ops, and therefore no symbols from libfebug++.a/.so are imported at link-time; this is intended as a way to easily disable
functions turn into no-ops, and therefore no symbols from libfebug++.a/.so are imported at link-time;
this is intended as a way to easily disable
febug(8)
integration completely on release builds.
.TP 8n

M OpenBSD/libfebug.3 => OpenBSD/libfebug.3 +2 -1
@@ 58,7 58,8 @@ There are three compile-time macros that allow a program to customise its behavi
.br
If non-zero, all symbols become
\fBstatic\fR,
functions turn into no-ops, and therefore no symbols from libfebug.a/.so are imported at link-time; this is intended as a way to easily disable
functions turn into no-ops, and therefore no symbols from libfebug.a/.so are imported at link-time;
this is intended as a way to easily disable
febug(8)
integration completely on release builds.
.TP 8n

M OpenBSD/libfebug.rs.3 => OpenBSD/libfebug.rs.3 +32 -5
@@ 4,9 4,12 @@
.nh
.if n .ad l
.SH "NAME"
\fBfebug::controlled_socket\fR,
\fBfebug::wrapper\fR,
\fIfebug::formatters\fR
\fBfebug::start\fR,
\fBfebug::Wrapper\fR,
\fBfebug::Wrappable\fR,
\fBfebug::StaticWrappable\fR,
\fIfebug::GLOBAL_CONTROLLED_SOCKET\fR,
\fIfebug::FORMATTERS\fR
\- User-space debugfs ABI wrapper library for Rust
.SH "SYNOPSIS"
.nf


@@ 75,6 78,31 @@ febug(8)
by presenting a high-level interface to
febug-abi(5).
.PP
There are three compile-time environment variables that allow a programmer to customise its behaviour:
.TP 8n
\fBFEBUG_DONT\fR
.br
If set, all functions turn into no-ops;
this is intended as a way to easily disable
febug(8)
integration completely on release builds.
.TP 8n
\fBFEBUG_SIGNUM\fR
.br
The signal to request from
febug(8)
when using
\fBfebug_wrap\fR().
Defaults to
\fRSIGUSR2\fR.
.TP 8n
\fBFEBUG_SOCKET\fR
.br
The path to connect to
febug(8)
on. Defaults to
\fI/var/run/febug.sock\fR.
.PP
There are two environment variables that allow a user to customise its behaviour:
.TP 8n
\fIFEBUG_DONT\fR


@@ 84,8 112,7 @@ so all library functions become no-ops.
.TP 8n
\fIFEBUG_SOCKET\fR
If set, use its value instead of
the argument to
\fBfebug::start_raw\fR()
\fBFEBUG_SOCKET\fR
to connect to
febug(8)
.PP

M OpenBSD/libfebug.rs.3.html => OpenBSD/libfebug.rs.3.html +31 -16
@@ 316,9 316,11 @@ html {		--bg: #1E1F21;
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><a class="permalink" href="#febug::controlled_socket"><b class="Sy" id="febug::controlled_socket">febug::controlled_socket</b></a>,
    <a class="permalink" href="#febug::wrapper"><b class="Sy" id="febug::wrapper">febug::wrapper</b></a>,
    <var class="Vt">febug::formatters</var> &#x2014; <span class="Nd">User-space
<p class="Pp"><b class="Sy">febug::start</b>, <b class="Sy">febug::Wrapper</b>,
    <b class="Sy">febug::Wrappable</b>,
    <b class="Sy">febug::StaticWrappable</b>,
    <var class="Vt">febug::GLOBAL_CONTROLLED_SOCKET</var>,
    <var class="Vt">febug::FORMATTERS</var> &#x2014; <span class="Nd">User-space
    debugfs ABI wrapper library for Rust</span></p>
</section>
<section class="Sh">


@@ 407,6 409,23 @@ febug = &quot;0.0.0&quot;
    allows a programmer to simplify writing Rust programs debuggable with
    <a class="Xr" href="febug.8.html">febug(8)</a> by presenting a high-level interface to
    <a class="Xr" href="febug-abi.5.html">febug-abi(5)</a>.</p>
<p class="Pp">There are three compile-time environment variables that allow a
    programmer to customise its behaviour:</p>
<dl class="Bl-tag">
  <dt></dt>
  <dd><code class="Fd">FEBUG_DONT</code> If set, all functions turn into no-ops;
      this is intended as a way to easily disable <a class="Xr" href="febug.8.html">febug(8)</a>
      integration completely on release builds.</dd>
  <dt id="febug_wrap"></dt>
  <dd><code class="Fd">FEBUG_SIGNUM</code> The signal to request from
      <a class="Xr" href="febug.8.html">febug(8)</a> when using
      <a class="permalink" href="#febug_wrap"><code class="Fn">febug_wrap</code></a>().
      Defaults to <code class="Li">SIGUSR2</code>.</dd>
  <dt></dt>
  <dd><code class="Fd">FEBUG_SOCKET</code> The path to connect to
      <a class="Xr" href="febug.8.html">febug(8)</a> on. Defaults to
      <span class="Pa">/var/run/febug.sock</span>.</dd>
</dl>
<p class="Pp">There are two environment variables that allow a user to customise
    its behaviour:</p>
<dl class="Bl-tag">


@@ 414,13 433,12 @@ febug = &quot;0.0.0&quot;
  <dd>If set, don't try to connect to <a class="Xr" href="febug.8.html">febug(8)</a>, so all library
      functions become no-ops.</dd>
  <dt id="FEBUG_SOCKET"><a class="permalink" href="#FEBUG_SOCKET"><i class="Em">FEBUG_SOCKET</i></a></dt>
  <dd>If set, use its value instead of the argument to
      <a class="permalink" href="#febug::start_raw"><code class="Fn" id="febug::start_raw">febug::start_raw</code></a>()
      to connect to <a class="Xr" href="febug.8.html">febug(8)</a></dd>
  <dd>If set, use its value instead of <b class="Sy">FEBUG_SOCKET</b> to connect
      to <a class="Xr" href="febug.8.html">febug(8)</a></dd>
</dl>
<p class="Pp" id="febug::start_raw~2">To be debugged, a program needs to, first,
<p class="Pp" id="febug::start_raw">To be debugged, a program needs to, first,
    call
    <a class="permalink" href="#febug::start_raw~2"><code class="Fn">febug::start_raw</code></a>()
    <a class="permalink" href="#febug::start_raw"><code class="Fn">febug::start_raw</code></a>()
    (likely via
    <a class="permalink" href="#febug::start"><code class="Fn" id="febug::start">febug::start</code></a>(),
    which simply passes <span class="Pa">b&quot;/var/run/febug.sock&quot;</span>


@@ 452,14 470,11 @@ febug = &quot;0.0.0&quot;
    lie here. The handler takes the write end of the pipe as the first argument,
    and the variable ID as the second. It's a no-op if
    <var class="Vt">febug::GLOBAL_CONTROLLED_SOCKET</var> is -1.</p>
<p class="Pp" id="febug::StaticWrappable">At any time, when the program wishes
    to expose a variable, it can construct <b class="Sy">febug::Wrapper</b>
    (likely via one of the convenience
    <a class="permalink" href="#febug::StaticWrappable"><b class="Sy">febug::StaticWrappable</b></a>
    or
    <a class="permalink" href="#febug::Wrappable"><b class="Sy" id="febug::Wrappable">febug::Wrappable</b></a>
    traits), which will send a
    <a class="permalink" href="#febug_message"><b class="Sy" id="febug_message">febug_message</b></a>
<p class="Pp" id="febug_message">At any time, when the program wishes to expose
    a variable, it can construct <b class="Sy">febug::Wrapper</b> (likely via
    one of the convenience <b class="Sy">febug::StaticWrappable</b> or
    <b class="Sy">febug::Wrappable</b> traits), which will send a
    <a class="permalink" href="#febug_message"><b class="Sy">febug_message</b></a>
    with the specified type and signal numbers (defaulting to
    <code class="Li">SIGUSR2 ),</code> ID equal to the address of the data
    argument, and name formatted. It's a no-op if