summaryrefslogtreecommitdiffstats
path: root/usr.sbin/binmiscctl
diff options
context:
space:
mode:
authorbrueffer <brueffer@FreeBSD.org>2014-04-10 10:18:30 +0000
committerbrueffer <brueffer@FreeBSD.org>2014-04-10 10:18:30 +0000
commit94b813eeb99f1766c733ffb0f020f61c91e0c694 (patch)
treecc66af9fd0ccabee9ad3a03a16d9894cc96af2cd /usr.sbin/binmiscctl
parent37fe2a4bcbc8198435497350ed2624eed07cc63a (diff)
downloadFreeBSD-src-94b813eeb99f1766c733ffb0f020f61c91e0c694.zip
FreeBSD-src-94b813eeb99f1766c733ffb0f020f61c91e0c694.tar.gz
More mdoc/spelling/grammar cleanup.
Diffstat (limited to 'usr.sbin/binmiscctl')
-rw-r--r--usr.sbin/binmiscctl/binmiscctl.866
1 files changed, 36 insertions, 30 deletions
diff --git a/usr.sbin/binmiscctl/binmiscctl.8 b/usr.sbin/binmiscctl/binmiscctl.8
index 328ce9a..646a5a3 100644
--- a/usr.sbin/binmiscctl/binmiscctl.8
+++ b/usr.sbin/binmiscctl/binmiscctl.8
@@ -27,8 +27,8 @@
.\"
.\" Support for miscellaneous binary image activators
.\"
-.Dd April 8, 2014
-.Dt 8
+.Dd April 10, 2014
+.Dt BINMISCCTL 8
.Os
.Sh NAME
.Nm binmiscctl
@@ -43,9 +43,9 @@
.Ar magic
.Cm --size
.Ar size
-.Op --mask Ar mask
-.Op --offset Ar offset
-.Op --set-enabled
+.Op Cm --mask Ar mask
+.Op Cm --offset Ar offset
+.Op Cm --set-enabled
.Nm
.Cm remove
.Ar name
@@ -66,10 +66,10 @@ The
utility
is the management utility for configuring miscellaneous binaries image
activators in the kernel.
-It allows the adding, deleting, disabling,
+It allows adding, deleting, disabling,
enabling, and looking up interpreters.
Also, all the interpreters can
-be listed as well.
+be listed.
.Pp
The first argument on the command line indicates the operation to be
performed.
@@ -84,19 +84,19 @@ Operation must be one of the following:
.Ar magic
.Cm --size
.Ar size
-.Op --mask Ar mask
-.Op --offset Ar offset
-.Op --set-enabled
+.Op Cm --mask Ar mask
+.Op Cm --offset Ar offset
+.Op Cm --set-enabled
.Xc
Add a new activator entry in the kernel.
-You must specify an
+You must specify a
unique
.Ar name,
interpreter path and its arguments
.Ar path,
header
.Ar magic
-bytes that uniquely identifies a suitable binary for the activator,
+bytes that uniquely identify a suitable binary for the activator,
and the
.Ar size
of the
@@ -107,27 +107,29 @@ Optionally you may specify a
.Ar mask
to do a bitwise AND with the header bytes.
This effectively allows you to ignore fields in the binary header that
-do not uniquely indentify binary file's type.
+do not uniquely indentify the binary file's type.
.Pp
An
.Ar offset
may be specified for the magic bytes using the
-.Ar --offset
-argument.
+.Cm --offset
+option.
By default the
.Ar offset
is zero.
.Pp
-To set the activator entry enabled the
-.Ar --set-enabled
+To enable the activator entry the
+.Cm --set-enabled
option is used.
The activator default state is disabled.
.Pp
The interpreter
.Ar path
-may also arguments for the interpreter including
+may also contain arguments for the interpreter including
.Ar #a
-which gets replaced by the old argv0 value in the interpreter string.
+which gets replaced by the old
+.Dv argv0
+value in the interpreter string.
.It Cm remove Ar name
Remove the activator entry identified with
.Ar name .
@@ -138,43 +140,47 @@ Disable the activator entry identified with
Enable the activator entry identified with
.Ar name .
.It Cm lookup Ar name
-Lookup and print out the activator entry identified with
+Look up and print out the activator entry identified with
.Ar name .
.It Cm list
Take a snapshot and print all the activator entries currently configured.
.El
.Sh EXAMPLES
-.Dl binmiscctl add llvmbc --interpreter ''/usr/bin/lli --fake-argv0=#a''
---magic ''BC\\xc0\\xde''
---size 4 --set-enabled
+.Bl
+# binmiscctl add llvmbc --interpreter ''/usr/bin/lli --fake-argv0=#a'' \\
+ --magic ''BC\\xc0\\xde'' --size 4 --set-enabled
+.El
.Pp
-Add an image activator to run the the llvm interpreter (lli) on bitcode
+Add an image activator to run the LLVM interpreter (lli) on bitcode
compiled files.
.Ar #a
-gets replaced with the old argv0 value so that 'lli' can fake its argv0.
+gets replaced with the old
+.Dv argv0
+value so that 'lli' can fake its
+.Dv argv0 .
Set its state to enabled.
.Pp
-.Dl binmiscctl disable llvmbc
+.Dl # binmiscctl disable llvmbc
.Pp
Set the state of the
.Ar llvmbc
image activator to disabled.
.Pp
-.Dl binmiscctl enable llvmbc
+.Dl # binmiscctl enable llvmbc
.Pp
Set the state of the
.Ar llvmbc
image activator to enabled.
.Pp
-.Dl binmiscctl remove llvmbc
+.Dl # binmiscctl remove llvmbc
.Pp
Delete the
.Ar llvmbc
image activator.
.Pp
-.Dl binmiscctl lookup llvmbc
+.Dl # binmiscctl lookup llvmbc
.Pp
-Lookup and list the record for the
+Look up and list the record for the
.Ar llvmbc
image activator.
.Sh SEE ALSO
OpenPOWER on IntegriCloud