Handle empty argv

[opendoas.git] / doas.1

diff --git a/doas.1 b/doas.1
index 6d39505228770a0dd2b719fa9d7820763b2b6fff..a91705e8e3fea484990ccb0fbf45f22a1a83a635 100644 (file)
--- a/doas.1
+++ b/doas.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: doas.1,v 1.1 2015/07/16 20:44:21 tedu 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 16 2015 $
+.Dd $Mdocdate: January 16 2021 $
 .Dt DOAS 1
 .Os
 .Sh NAME
@@ -21,16 +21,82 @@
 .Nd execute commands as another user
 .Sh SYNOPSIS
 .Nm doas
+.Op Fl Lns
+.Op Fl C Ar config
 .Op Fl u Ar user
-command
+.Ar command
 .Op Ar args
 .Sh DESCRIPTION
 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
+.It Fl C Ar config
+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
+or
+.Pa /etc/passwd .
 .It Fl u Ar user
 Execute the command as
 .Ar user .
@@ -38,17 +104,22 @@ The default is root.
 .El
 .Sh EXIT STATUS
 .Ex -std doas
-It may fail because of one of the following reasons:
+It may fail for one of the following reasons:
 .Pp
 .Bl -bullet -compact
 .It
-The config file could not be parsed.
+The config file
+.Pa /etc/doas.conf
+could not be parsed.
 .It
 The user attempted to run a command which is not permitted.
 .It
 The password was incorrect.
+.It
+The specified command was not found or is not executable.
 .El
 .Sh SEE ALSO
+.Xr su 1 ,
 .Xr doas.conf 5
 .Sh HISTORY
 The