Skip to content

Commit

Permalink
more man page/readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
rfht committed Sep 8, 2023
1 parent db15d27 commit e48a96a
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 24 deletions.
56 changes: 34 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,30 @@ promises for program execution

# DESCRIPTION

The
**abstain**
utility executes a
executes a
*binary*
with
(optional)
*arguments*
using
pledge(2)
*execpromises*.
By default, it will do so with all
Unlike
pledge(2)'s
syntax of specifying arguments for
*addition*,
**abstain**'s
*promises*
are listed for
*subtraction*.
This means that without any
**-p**
*promises*,
the maximal number of
pledge(2)
*promises*
allowed.
are permitted.
(This doesn't mean that no restrictions are imposed by
pledge(2).)
To disallow
Expand All @@ -39,6 +50,25 @@ in a comma-separated list and/or with multiple
**-p**
arguments.

**abstain**
imposes a
pledge(2)
*promise set*
on the application
*as a whole*.
Depending on the nature of the application, it could fail to launch or abort execution at a later stage when a
pledge(2)
violation occurs.

Due to the nature of
*execpromises*,
the restrictions will propagate to children of the application and new processes spawned by
execve(2)
(see the
make(1)
example below)
.

The
'error'
*promise*
Expand All @@ -58,24 +88,6 @@ execvp(3)
and the
*execpromises*.

**abstain**
imposes a
pledge(2)
*promise set*
on the application as a whole.
Depending on the nature of the application, it could fail to launch or abort execution at a later stage when a
pledge(2)
violation occurs.

Due to the nature of
*execpromises*,
the restrictions will propagate to children of the application and new processes spawned by
execve(2)
(see the
make(1)
example below)
.

# EXAMPLES

Prohibit file system modification:
Expand Down
3 changes: 1 addition & 2 deletions abstain.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ promises for program execution
.Op Fl p Ar promise Ns Op Ar ,promise,...
.Ar binary Op Ar arguments Ar ...
.Sh DESCRIPTION
The
.Nm
utility executes a
executes a
.Ar binary
with
.Pq optional
Expand Down

0 comments on commit e48a96a

Please sign in to comment.