On Fri, 7 Jan 2005, Oliver Hookins wrote:
I'd gladly submit a patch for squid_ldap_auth.8 (and probably squid_ldap_group while I'm at it) but I can't find any good (read: understandable) resources for editing man pages. Suggestions?
A good start is to use copy-paste from the existing text. The man syntax is a fairly simple text format.
If you want to read more about the syntax then start by the documentation included with your os. See "man 7 man"
Regards Henrik
OK here they are, both squid_ldap_auth.8 and squid_ldap_group.8. I haven't ever submitted a patch before so hopefully I got the diff options right.
Cheers, Oliver
--- squid_ldap_auth.8.orig 2004-07-18 01:00:12.000000000 +1000 +++ squid_ldap_auth.8 2005-01-13 13:31:47.000000000 +1100 @@ -1,4 +1,4 @@ -.TH squid_ldap_auth 8 "17 July 2004" "Squid LDAP Auth" +.TH squid_ldap_auth 8 "13 January 2005" "Squid LDAP Auth" . .SH NAME squid_ldap_auth - Squid LDAP authentication helper @@ -13,6 +13,10 @@ squid_ldap_auth - Squid LDAP authenticat .SH DESCRIPTION This helper allows Squid to connect to a LDAP directory to validate the user name and password of Basic HTTP authentication. +LDAP options are specified as parameters on the command line, +while the username(s) and password(s) to be checked against the +LDAP directory are specified on subsequent lines of input to the +helper, one username/password pair per line separated by a space. .P The program has two major modes of operation. In the default mode of operation the users DN is constructed using the base DN and
--- squid_ldap_group.8.orig 2004-07-18 01:00:12.000000000 +1000 +++ squid_ldap_group.8 2005-01-13 13:27:55.000000000 +1100 @@ -1,4 +1,4 @@ -.TH squid_ldap_group 8 "17 July 2004" "Squid LDAP Group" +.TH squid_ldap_group 8 "13 January 2005" "Squid LDAP Group" . .SH NAME squid_ldap_group - Squid LDAP external acl group helper @@ -9,6 +9,10 @@ squid_ldap_group -b "base DN" -f "LDAP s .SH DESCRIPTION This helper allows Squid to connect to a LDAP directory to authorize users via LDAP groups. +LDAP options are specified as parameters on the command line, +while the username(s) and group(s) to be checked against the +LDAP directory are specified on subsequent lines of input to the +helper, one username/password pair per line separated by a space. .P The program operates by searching with a search filter based on the users user name and requested group, and if a match
