From 4b919350b70451e1d93d6ecfe485bdaf3aace38b Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 31 Jan 2021 16:25:38 +0100 Subject: Add README and m fixes to man page MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 35 +++++++++++++++++++++++++++++++++++ asroot.8 | 7 +------ 2 files changed, 36 insertions(+), 6 deletions(-) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..01c8b13 --- /dev/null +++ b/README @@ -0,0 +1,35 @@ +NAME + asroot - run a process as the root user + +SYNOPSIS + asroot [-e] command [argument] ... + +DESCRIPTION + The asroot utility asks for the user's password and runs the specified + command with sanitised and updated environment variables. + + Only users in the wheel group are allowed to run the asroot utility, + unless it is installed with non-standard permissions. + +OPTIONS + The asroot utility conforms to the Base Definitions volume of + POSIX.1-2017, Section 12.2, Utility Syntax Guidelines. + + The following option is supported: + + -e Keep the environment variables as is. Neither sanitise nor + update them. + +OPERANDS + The following operands are supported: + + command + The command that shall be run with as the root user. This will + be both the process image and the process's zeroth command line + argument. + + argument ... + Command line arguments for the command to run. + +SEE ALSO + sudo(8), doas(1), su(1) diff --git a/asroot.8 b/asroot.8 index 4492fc1..3df9149 100644 --- a/asroot.8 +++ b/asroot.8 @@ -12,7 +12,7 @@ asroot - run a process as the root user .SH DESCRIPTION The .B asroot -utility as for the user's password and runs the +utility asks for the user's password and runs the specified .I command with sanitised and updated environment variables. @@ -117,11 +117,6 @@ None. .SH EXAMPLES None. -.SH CONFORMING TO -The -.B asroot -utility is non-standard utility. - .SH RATIONALE None. -- cgit v1.2.3-70-g09d2