the environment handling code was showing its age. just because environ is a char...

[opendoas.git] / doas.1

diff --git a/doas.1 b/doas.1
index e075b6b68cd70c703627dea66c137c6cc837187c..dd98081cb0c971d56416d106e1e0a4f9a275bebb 100644 (file)
--- a/doas.1
+++ b/doas.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: doas.1,v 1.2 2015/07/17 17:11:18 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 17 2015 $
+.Dd $Mdocdate: July 26 2015 $
 .Dt DOAS 1
 .Os
 .Sh NAME
@@ -21,16 +21,52 @@
 .Nd execute commands as another user
 .Sh SYNOPSIS
 .Nm doas
+.Op Fl ns
+.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
+or
+.Fl s
+is specified.
 .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.
+In either case, 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
+or
+.Pa /etc/passwd .
 .It Fl u Ar user
 Execute the command as
 .Ar user .
@@ -42,13 +78,18 @@ 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