more precisely describe what happens to the environment without keepenv; OK tedu@

[opendoas.git] / doas.1

diff --git a/doas.1 b/doas.1
index 5220eb59e8e4b1002e8e07c8404db2e1af5b2001..2ecc9925f8921ca41f7bbba72d52a3ca29089651 100644 (file)
--- a/doas.1
+++ b/doas.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: doas.1,v 1.9 2015/07/21 16:12:04 tedu Exp $
+.\" $OpenBSD: doas.1,v 1.13 2015/07/26 23:00:15 tedu Exp $
 .\"
 .\"Copyright (c) 2015 Ted Unangst <tedu@openbsd.org>
 .\"
@@ -13,7 +13,7 @@
 .\"WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\"ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\"OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-.Dd $Mdocdate: July 21 2015 $
+.Dd $Mdocdate: July 26 2015 $
 .Dt DOAS 1
 .Os
 .Sh NAME
@@ -21,7 +21,7 @@
 .Nd execute commands as another user
 .Sh SYNOPSIS
 .Nm doas
-.Op Fl s
+.Op Fl Lns
 .Op Fl C Ar config
 .Op Fl u Ar user
 .Ar command
@@ -30,6 +30,33 @@
 The
 .Nm
 utility executes the given command as another user.
+The
+.Ar command
+argument is mandatory unless
+.Fl C ,
+.Fl L ,
+or
+.Fl s
+is specified.
+.Pp
+By default, the environment is reset.
+The variables
+.Ev HOME ,
+.Ev LOGNAME ,
+.Ev PATH ,
+.Ev SHELL ,
+and
+.Ev USER
+and the
+.Xr umask 2
+are set to values appropriate for the target user.
+The variables
+.Ev DISPLAY
+and
+.Ev TERM
+are inherited from the current environment.
+This behavior may be modified by the config file.
+The working directory is not changed.
 .Pp
 The options are as follows:
 .Bl -tag -width tenletters
@@ -37,7 +64,28 @@ The options are as follows:
 Parse and check the configuration file
 .Ar config ,
 then exit.
+If
+.Ar command
+is supplied,
+.Nm
+will also perform command matching.
+In the latter case
+either
+.Sq permit ,
+.Sq permit nopass
+or
+.Sq deny
+will be printed on standard output, depending on command
+matching results.
 No command is executed.
+.It Fl L
+Clear any persisted authorizations from previous invocations,
+then immediately exit.
+No command is executed.
+.It Fl n
+Non interactive mode, fail if
+.Nm
+would prompt for password.
 .It Fl s
 Execute the shell from
 .Ev SHELL
@@ -62,9 +110,10 @@ The user attempted to run a command which is not permitted.
 .It
 The password was incorrect.
 .It
-The actual program is absent or not executable.
+The specified command was not found or is not executable.
 .El
 .Sh SEE ALSO
+.Xr su 1 ,
 .Xr doas.conf 5
 .Sh HISTORY
 The