]> git.armaanb.net Git - opendoas.git/blobdiff - doas.conf.5
bump version 0.3.1
[opendoas.git] / doas.conf.5
index dd006a584661d27b2695cce99035c624022e9968..1dfeaeec62f62c858b29ac28814f6a72df0fff36 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: doas.conf.5,v 1.9 2015/07/22 06:30:12 jmc Exp $
+.\" $OpenBSD: doas.conf.5,v 1.13 2015/07/27 21:44:11 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 22 2015 $
+.Dd $Mdocdate: July 27 2015 $
 .Dt DOAS.CONF 5
 .Os
 .Sh NAME
@@ -57,30 +57,35 @@ The default is to reset the environment, except for the variables
 .Ev USER
 and
 .Ev USERNAME .
-.It Ic keepenv { Oo variable names Oc Ic }
-Reset the environment, but keep the space-separated specified variables.
+.It Ic keepenv { Oo Ar variable ... Oc Ic }
+In addition to the variables mentioned above, keep the space-separated
+specified variables.
 .El
 .It Ar identity
 The username to match.
-Groups may be specified by prepending a colon (:).
+Groups may be specified by prepending a colon
+.Pq Sq \&: .
 Numeric IDs are also accepted.
 .It Ic as Ar target
 The target user the running user is allowed to run the command as.
-The default is root.
+The default is all users.
 .It Ic cmd Ar command
 The command the user is allowed or denied to run.
 The default is all commands.
-Be advised that it's best to specify absolute paths.
+Be advised that it is best to specify absolute paths.
+If a relative path is specified, only a restricted
+.Ev PATH
+will be searched.
 .It Ic args ...
 Arguments to command.
-If specified, the command arguments provided by the user
-need to match for the command to be successful.
-Specifying
+The command arguments provided by the user need to match those specified.
+The keyword
 .Ic args
-alone means that command should be run without any arguments.
+alone means that command must be run without any arguments.
 .El
 .Pp
 The last matching rule determines the action taken.
+If no rule matches, the action is denied.
 .Pp
 Comments can be put anywhere in the file using a hash mark
 .Pq Sq # ,
@@ -93,17 +98,17 @@ The text between a pair of double quotes
 .Pq Sq \&"
 is taken as is.
 .It
-The backslash
+The backslash character
 .Pq Sq \e
-escapes next character, including new line character, outside comment;
+escapes the next character, including new line characters, outside comments;
 as a result, comments may not be extended over multiple lines.
 .It
-If quotes or backslash are used in the word, this word won't be
-considered a keyword.
+If quotes or backslashes are used in a word,
+it isn't considered a keyword.
 .El
 .Sh EXAMPLES
 The following example permits users in group wsrc to build ports,
-wheel to execute commands as root while keeping the environment
+wheel to execute commands as any user while keeping the environment
 variables
 .Ev ENV ,
 .Ev PS1 ,
@@ -120,7 +125,7 @@ permit nopass keepenv { \e
         PKG_DESTDIR PKG_TMPDIR PORTSDIR RELEASEDIR SHARED_ONLY \e
         SUBPACKAGE WRKOBJDIR SUDO_PORT_V1 } :wsrc
 permit nopass keepenv { ENV PS1 SSH_AUTH_SOCK } :wheel
-permit nopass tedu cmd /usr/sbin/procmap
+permit nopass tedu as root cmd /usr/sbin/procmap
 .Ed
 .Sh SEE ALSO
 .Xr doas 1