Implement quoting support in doas.conf. Now you can pass environment

[opendoas.git] / doas.conf.5

diff --git a/doas.conf.5 b/doas.conf.5
index 7510bd0b4ac0219f36d7e766307e9b9a29b337ea..dd006a584661d27b2695cce99035c624022e9968 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.9 2015/07/22 06:30:12 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 22 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:
@@ -73,11 +71,10 @@ The default is root.
 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 +82,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
+.Pq Sq \e
+escapes next character, including new line character, outside comment;
+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.
+.El
 .Sh EXAMPLES
 The following example permits users in group wsrc to build ports,
 wheel to execute commands as root while keeping the environment