summaryrefslogtreecommitdiff
path: root/doc/pam_source.sgml
diff options
context:
space:
mode:
authorAndrew G. Morgan <morgan@kernel.org>2002-05-26 23:58:23 +0000
committerAndrew G. Morgan <morgan@kernel.org>2002-05-26 23:58:23 +0000
commit6daa9f4e4eecb8efb60879a5c98135aa0c4d4081 (patch)
treec671c12a42a99ed1d8626399156b49a48fe872ee /doc/pam_source.sgml
parent7b89c0b53be5361615639c5b3a5bf2cbb40f46bc (diff)
Relevant BUGIDs: 517064
Purpose of commit: feature Commit summary: --------------- document old feature and add '\]' parsing to make it a better feature. The feature is that we can accept spaces in module arguments by enclosing the whole argument inside square brackets. For example a module argument like this: "[hello [you\], this is me]" will be parsed as "hello [you], this is me" Not very interesting, but you get the idea. Thanks to Russell Kliese for requesting this.
Diffstat (limited to 'doc/pam_source.sgml')
-rw-r--r--doc/pam_source.sgml24
1 files changed, 22 insertions, 2 deletions
diff --git a/doc/pam_source.sgml b/doc/pam_source.sgml
index 92295126..7ed1e131 100644
--- a/doc/pam_source.sgml
+++ b/doc/pam_source.sgml
@@ -46,7 +46,7 @@ DAMAGE.
<title>The Linux-PAM System Administrators' Guide
<author>Andrew G. Morgan, <tt>morgan@kernel.org</tt>
-<date>DRAFT v0.76 2002/05/09
+<date>DRAFT v0.76 2002/05/26
<abstract>
This manual documents what a system-administrator needs to know about
the <bf>Linux-PAM</bf> library. It covers the correct syntax of the
@@ -366,7 +366,7 @@ A general configuration line of the <tt>/etc/pam.conf</tt> file has
the following form:
<tscreen>
<verb>
-service-name module-type control-flag module-path arguments
+service-name module-type control-flag module-path args
</verb>
</tscreen>
Below, we explain the meaning of each of these tokens. The second (and
@@ -575,6 +575,26 @@ encountering an invalid argument, the module is required to write an
error to <tt/syslog(3)/. For a list of <em/generic/ options see the
next section.
+Note, if you wish to include spaces in an argument, you should
+surround that argument with square brackets. For example:
+<tscreen>
+<verb>
+squid auth required pam_mysql.so user=passwd_query passwd=mada \
+ db=eminence [query=select user_name from internet_service where \
+ user_name='%u' and password=PASSWORD('%p') and \
+ service='web_proxy']
+</verb>
+</tscreen>
+Note, when using this convention, you can include `<tt/[/' characters
+inside the string, and if you wish to include a `<tt/]/' character
+inside the string that will survive the argument parsing, you should
+use `<tt/\[/'. In other words:
+<tscreen>
+<verb>
+[..[..\]..] --> ..[..]..
+</verb>
+</tscreen>
+
</descrip>
<p>