~nabijaczleweli/febug

ref: 820d140cb61b486fe4a12352c02c6b85d69c37dd febug/OpenBSD/febug.8 -rw-r--r-- 2.9 KiB
820d140c — наб autouploader OpenBSD manpage update by job 451312 7 months ago
                                                                                
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
.\" Automatically generated from an mdoc input file.  Do not edit.
.\"" SPDX-License-Identifier: MIT
.TH "FEBUG" "8" "FEBUG" "OpenBSD 6.8" "System Manager's Manual"
.nh
.if n .ad l
.SH "NAME"
\fBfebug\fR
\- User-space debugfs filesystem driver
.SH "SYNOPSIS"
.HP 6n
\fBfebug\fR
[\fB\-hV\fR]
[\fBlibfuse options\fR]
\fImountpoint\fR
.SH "DESCRIPTION"
\fBfebug\fR
mounts a filesystem at
\fImountpoint\fR
that allows programs to register themselves and expose variables to be (relatively) non-intrusively inspected at run-time, inspired by
Linux's
\fIdebugfs\fR: \fBhttps://www.kernel.org/doc/html/latest/filesystems/debugfs.html\fR
filesystem.
.PP
See
febug-abi(8)
for implementation details. And the
\fIEXAMPLES\fR
section for an example debug session.
.SH "OPTIONS"
\fB\-h\fR \fBor\fR \fB\--help\fR
and
\fB\-V\fR \fBor\fR \fB\--version\fR
are self-explanatory.
.PP
\fB\-d\fR
enables debug output from both
\fBfebug\fR
and
\fBlibfuse\fR.
.PP
\fBfebug\fR
passes all arguments (which have to, therefore, include
\fImountpoint\fR)
to
fuse_main(3), with
\fB\-f\fR
(foreground) and
\fB\-o\fR \fBdefault_permissions\fR
appended.
If run with effective UID of 0, it also appends
\fB\-o\fR \fBallow_other\fR.
.SH "ENVIRONMENT"
\fIFEBUG_SOCKET\fR
the socket at which to listen for programs, or
\fI/var/run/febug.sock\fR
by default.
.SH "EXAMPLES"
.nf
.RS 6n
\&# rcctl start febug
$ mount | grep febug
fusefs on /var/run/febug type fuse (local)
$ ./out/examples/vector-sort &
[1] 1409
$ LD_LIBRARY_PATH=out ./out/examples/string-qsort &
[2] 1410
$ ls /var/run/febug/
1409 1410
$ ls -l /var/run/febug/
dr-xr-x--- 4 nabijaczleweli users 0 Jan 15 19:52 1409
dr-xr-x--- 3 nabijaczleweli users 0 Jan 15 19:52 1410
$ ls /var/run/febug/1409/
comparisons cool_data
$ cat /var/run/febug/1409/\&*
24
-3 -2 -3 -2 -3 -2 3 -1 -2 -3 0 1 2 3 -1 -2 -3 0 1 2 3 -1 -2 -3 0 1 2 3 -1 2 1 0 1 2 3 -1 0 -1 0 1 2 3
$ cat /var/run/febug/1409/\&*
45
-3 -2 -3 -2 -3 -2 -3 -2 -2 -3 -3 -2 -1 3 -1 1 0 0 1 2 3 2 -1 3 0 1 2 3 -1 2 1 0 1 2 3 -1 0 -1 0 1 2 3
$ grep . /var/run/febug/\&*/\&*
/var/run/febug/1409/comparisons:71
/var/run/febug/1409/cool_data:-3 -3 -3 -3 -3 -3 -2 -2 -2 -2 -2 -2 -1 3 -1 1 0 0 1 2 3 2 -1 3 0 1 2 3 -1 2 1 0 1 2 3 -1 0 -1 0 1 2 3
/var/run/febug/1410/cool_data:3012987654ACEFOLJKODNIEMIGHBPPbdWwnfTpXQcreRlVvUSitZQWjRTYUazuqwertyuiopoxyhmYsgkq
$ kill %1
$ ls /var/run/febug/
1410
.RE
.fi
.SH "SEE ALSO"
febug-abi(5)
\[u2014] the ABI used to connect with this filesystem.
.PP
libfebug(3)
\[u2014] a library wrapping this ABI.
.PP
libfebug++(3)
\[u2014] a C++ library wrapping this ABI.
.SH "AUTHORS"
Written by
\[u043D]\[u0430]\[u0431] <\fInabijaczleweli@nabijaczleweli.xyz\fR>
.SH "SPECIAL THANKS"
To all who support further development, in particular:
.PD 0
.TP 8n
\fB\(bu\fR
ThePhD
.TP 8n
\fB\(bu\fR
Embark Studios
.PD
.SH "REPORTING BUGS"
\fIfebug tracker\fR: \fBhttps://todo.sr.ht/~nabijaczleweli/febug\fR
.PP
febug mailing list:
<\fI~nabijaczleweli/febug@lists.sr.ht\fR>
archived at
\fBhttps://lists.sr.ht/~nabijaczleweli/febug\fR