Skip to content

Commit 24aa8d6

Browse files
committed
extent man page description
1 parent f481d79 commit 24aa8d6

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,17 @@
3232
When not using the running kernel, extract swap information from
3333
the specified file.
3434

35+
The typical use case is:
36+
37+
o starts a long lived program.
38+
39+
o later, upgrades your packages via pkg_add -u.
40+
41+
o if the program is updated on disk, the running program is still the
42+
previous one (without security fixes for example).
43+
44+
o checkrestart will tell you which processes belong to this category.
45+
3546
# SEE ALSO
3647
fstat(1)
3748

@@ -42,3 +53,7 @@
4253
# AUTHORS
4354
checkrestart was written by Sebastien Marie <[email protected]>.
4455

56+
# CAVEATS
57+
Only VTEXT nodes are reported by checkrestart. Some programs using old
58+
libraries aren't reported due to lack of support in kernel.
59+

checkrestart.8

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,21 @@ running kernel.
5454
.It Fl W Ar swap
5555
When not using the running kernel, extract swap information from
5656
the specified file.
57-
.Ed
57+
.El
58+
.Pp
59+
The typical use case is:
60+
.Bl -bullet
61+
.It
62+
starts a long lived program.
63+
.It
64+
later, upgrades your packages via pkg_add -u.
65+
.It
66+
if the program is updated on disk, the running program is still
67+
the previous one (without security fixes for example).
68+
.It
69+
.Nm
70+
will tell you which processes belong to this category.
71+
.El
5872
.Sh SEE ALSO
5973
.Xr fstat 1
6074
.Sh HISTORY
@@ -70,3 +84,10 @@ for achieving the same purpose.
7084
.Nm
7185
was written by
7286
.An Sebastien Marie Aq Mt [email protected] .
87+
.Sh CAVEATS
88+
Only
89+
.Dv VTEXT
90+
nodes are reported by
91+
.Nm .
92+
Some programs using old libraries aren't reported
93+
due to lack of support in kernel.

0 commit comments

Comments
 (0)