summaryrefslogtreecommitdiffstats
path: root/usr.sbin/btrace
diff options
context:
space:
mode:
authorkn <kn@openbsd.org>2020-03-20 12:07:48 +0000
committerkn <kn@openbsd.org>2020-03-20 12:07:48 +0000
commit5d3454a6980b35b09c9458708188629b44650610 (patch)
tree4ac6f71f4b17b83cbb6d02e4d01e7af329fd3e35 /usr.sbin/btrace
parentAdd bdpmic(4), a driver for the ROHM BD71837 and BD71847 Power (diff)
downloadwireguard-openbsd-5d3454a6980b35b09c9458708188629b44650610.tar.xz
wireguard-openbsd-5d3454a6980b35b09c9458708188629b44650610.zip
Document exit, zero and delete functions
While here, reword existing function descriptions a little. Feedback OK mpi jmc
Diffstat (limited to 'usr.sbin/btrace')
-rw-r--r--usr.sbin/btrace/bt.521
1 files changed, 16 insertions, 5 deletions
diff --git a/usr.sbin/btrace/bt.5 b/usr.sbin/btrace/bt.5
index 9b7a8d4a11e..1c273875f57 100644
--- a/usr.sbin/btrace/bt.5
+++ b/usr.sbin/btrace/bt.5
@@ -1,4 +1,4 @@
-.\" $OpenBSD: bt.5,v 1.3 2020/03/18 20:19:42 kn Exp $
+.\" $OpenBSD: bt.5,v 1.4 2020/03/20 12:07:48 kn Exp $
.\"
.\" Copyright (c) 2019 Martin Pieuchot <mpi@openbsd.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: March 18 2020 $
+.Dd $Mdocdate: March 20 2020 $
.Dt BT 5
.Os
.Sh NAME
@@ -107,12 +107,19 @@ of the corresponding probe
.Pp
Functions:
.Pp
-.Bl -tag -width "printf fmt ... " -compact
+.Bl -tag -width "delete(@map[key])" -compact
.It Fn clear "@map"
-Delete all (key, value) pairs from map
+Delete all (key, value) pairs from
.Va @map
+.It Fn delete "@map[key]"
+Delete the pair indexed by
+.Va key
+from
+.Va @map
+.It Fn exit
+Terminate execution with exit code 0
.It Fn print "@map"
-Print all (key, value) pairs from map
+Print all pairs from
.Va @map
.It Fn printf "fmt" ...
print formatted string
@@ -120,6 +127,10 @@ print formatted string
.It Fn time timefmt
print timestamps using
.Xr strftime 3
+.It Fn zero "@map"
+Set all values from
+.Va @map
+to 0
.El
.Sh SEE ALSO
.Xr awk 1 ,