Handle empty argv

[opendoas.git] / doas.1

diff --git a/doas.1 b/doas.1
index 3e616198f0ce1e670250ef9f5b866075f9cd6f8a..a91705e8e3fea484990ccb0fbf45f22a1a83a635 100644 (file)
--- a/doas.1
+++ b/doas.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: doas.1,v 1.8 2015/07/21 11:04:06 zhuk Exp $
+.\" $OpenBSD: doas.1,v 1.25 2021/01/16 09:18:41 martijn 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: January 16 2021 $
 .Dt DOAS 1
 .Os
 .Sh NAME
@@ -21,8 +21,8 @@
 .Nd execute commands as another user
 .Sh SYNOPSIS
 .Nm doas
+.Op Fl Lns
 .Op Fl C Ar config
-.Op Fl s
 .Op Fl u Ar user
 .Ar command
 .Op Ar args
@@ -30,6 +30,39 @@
 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
+The user will be required to authenticate by entering their password,
+unless configured otherwise.
+.Pp
+By default, a new environment is created.
+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.
+.Ev DOAS_USER
+is set to the name of the user executing
+.Nm .
+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 +70,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 authentications from previous invocations,
+then immediately exit.
 No command is executed.
+.It Fl n
+Non interactive mode, fail if the matching rule doesn't have the
+.Ic nopass
+option.
 .It Fl s
 Execute the shell from
 .Ev SHELL
@@ -62,9 +116,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