From owner-svn-src-all@FreeBSD.ORG Thu Apr 10 10:18:30 2014 Return-Path: Delivered-To: svn-src-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id A81F51DF; Thu, 10 Apr 2014 10:18:30 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 93FF91E57; Thu, 10 Apr 2014 10:18:30 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s3AAIU3G067909; Thu, 10 Apr 2014 10:18:30 GMT (envelope-from brueffer@svn.freebsd.org) Received: (from brueffer@localhost) by svn.freebsd.org (8.14.8/8.14.8/Submit) id s3AAIUEX067908; Thu, 10 Apr 2014 10:18:30 GMT (envelope-from brueffer@svn.freebsd.org) Message-Id: <201404101018.s3AAIUEX067908@svn.freebsd.org> From: Christian Brueffer Date: Thu, 10 Apr 2014 10:18:30 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r264314 - head/usr.sbin/binmiscctl X-SVN-Group: head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.17 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 10 Apr 2014 10:18:30 -0000 Author: brueffer Date: Thu Apr 10 10:18:30 2014 New Revision: 264314 URL: http://svnweb.freebsd.org/changeset/base/264314 Log: More mdoc/spelling/grammar cleanup. Modified: head/usr.sbin/binmiscctl/binmiscctl.8 Modified: head/usr.sbin/binmiscctl/binmiscctl.8 ============================================================================== --- head/usr.sbin/binmiscctl/binmiscctl.8 Thu Apr 10 10:12:56 2014 (r264313) +++ head/usr.sbin/binmiscctl/binmiscctl.8 Thu Apr 10 10:18:30 2014 (r264314) @@ -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 w 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