Rename some variables and add few comments in keepenv handling code.

[opendoas.git] / doas.conf.5

diff --git a/doas.conf.5 b/doas.conf.5
index 7510bd0b4ac0219f36d7e766307e9b9a29b337ea..515598bc58317f9588109d99cef70fd2176d16a7 100644 (file)
--- a/doas.conf.5
+++ b/doas.conf.5
@@ -1,4 +1,4 @@
-.\" $OpenBSD: doas.conf.5,v 1.7 2015/07/20 20:18:45 tedu Exp $
+.\" $OpenBSD: doas.conf.5,v 1.12 2015/07/27 17:57:06 jmc 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 20 2015 $
+.Dd $Mdocdate: July 27 2015 $
 .Dt DOAS.CONF 5
 .Os
 .Sh NAME
@@ -33,9 +33,7 @@ The rules have the following format:
 .Op Ar options
 .Ar identity
 .Op Ic as Ar target
-.Oo
-.Ic cmd Ar command Op Ic args ...
-.Oc
+.Op Ic cmd Ar command Op Ic args ...
 .Ed
 .Pp
 Rules consist of the following parts:
@@ -59,25 +57,26 @@ 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.
-.It Ic args Op ...
+.It Ic args ...
 Arguments to command.
-If specified, the command arguments set provided by user and
-the command arguments set in rule should be the same for successful
-rule match.
+If specified, the command arguments provided by the user
+need to match for the command to be successful.
 Specifying
 .Ic args
 alone means that command should be run without any arguments.
@@ -85,11 +84,25 @@ alone means that command should be run without any arguments.
 .Pp
 The last matching rule determines the action taken.
 .Pp
-The current line can be extended over multiple lines using a backslash
-.Pq Sq \e .
 Comments can be put anywhere in the file using a hash mark
 .Pq Sq # ,
 and extend to the end of the current line.
+.Pp
+The following quoting rules apply:
+.Bl -dash
+.It
+The text between a pair of double quotes
+.Pq Sq \&"
+is taken as is.
+.It
+The backslash character
+.Pq Sq \e
+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 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