]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Fix man(8)/man(1) page syntax
authorAmos Jeffries <squid3@treenet.co.nz>
Fri, 31 Oct 2014 09:18:20 +0000 (02:18 -0700)
committerAmos Jeffries <squid3@treenet.co.nz>
Fri, 31 Oct 2014 09:18:20 +0000 (02:18 -0700)
It seems automated tools such as lroff are not able to parse the groff
syntax accurately for automated indexing of our man pages.

The if-conditional syntax was only used to simplify translators lives
so we can live with the tools preferred 1-liner syntax for the NAME
section.

21 files changed:
helpers/basic_auth/LDAP/basic_ldap_auth.8
helpers/basic_auth/NCSA/basic_ncsa_auth.8
helpers/basic_auth/PAM/basic_pam_auth.8
helpers/basic_auth/RADIUS/basic_radius_auth.8
helpers/basic_auth/SASL/basic_sasl_auth.8
helpers/basic_auth/SSPI/basic_sspi_auth.8
helpers/basic_auth/getpwnam/basic_getpwnam_auth.8
helpers/digest_auth/file/digest_file_auth.8
helpers/external_acl/AD_group/ext_ad_group_acl.8
helpers/external_acl/LDAP_group/ext_ldap_group_acl.8
helpers/external_acl/LM_group/ext_lm_group_acl.8
helpers/external_acl/eDirectory_userip/ext_edirectory_userip_acl.8
helpers/external_acl/file_userip/ext_file_userip_acl.8
helpers/external_acl/kerberos_ldap_group/ext_kerberos_ldap_group_acl.8
helpers/external_acl/session/ext_session_acl.8
helpers/external_acl/time_quota/ext_time_quota_acl.8
helpers/external_acl/unix_group/ext_unix_group_acl.8
helpers/negotiate_auth/kerberos/negotiate_kerberos_auth.8
helpers/ntlm_auth/SSPI/ntlm_sspi_auth.8
src/ssl/ssl_crtd.8
tools/squidclient.1

index eb648c5bb97f6e7dd1d2a8fa6703ce9cb6aaadf6..c0e366a090807afe6ee82ab6b02f8e6fc2593a74 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH basic_ldap_auth 8 "14 January 2005"
 .
 .SH NAME
-.if !'po4a'hide' .B basic_ldap_auth
-.if !'po4a'hide' \-
-LDAP authentication helper for Squid
+basic_ldap_auth \- LDAP authentication helper for Squid
 .
 .SH SYNOPSIS
 .if !'po4a'hide' .B basic_ldap_auth
index 1d7f32696b45ae5b9a875a6f4052410e849bbc16..1d2f79342331f763f1d136c4a1e7b2e1a6d61ae7 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH basic_ncsa_auth 8 "May 16, 2006"
 .
 .SH NAME
-.if !'po4a'hide' .B basic_ncsa_auth
-.if !'po4a'hide' \-
-NCSA httpd-style password file authentication helper for Squid
+basic_ncsa_auth \- NCSA httpd-style password file authentication helper for Squid
 .
 .SH SYNOPSIS
 .if !'po4a'hide' .B basic_ncsa_auth
index ff9508a420194639de9113aa01f7e2996683cd14..1c53794c4969c7ec6f210a11a095e1ac987dc057 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH basic_pam_auth 8 "5 Sep 2003"
 .
 .SH NAME
-.if !'po4a'hide' .B basic_pam_auth
-.if !'po4a'hide' \-
-Squid PAM Basic authentication helper
+basic_pam_auth \- PAM Basic authentication helper for Squid
 .
 .SH SYNOPSIS
 .if !'po4a'hide' .B "basic_pam_auth [\-n \""
index 7d5679489c3a1da1e703d92ae6241b7d4f71980c..c98d12c9e544d468fca92d97118792fd4f5cd661 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH basic_radius_auth 8 "7 August 2004"
 .
 .SH NAME
-.if !'po4a'hide' .B basic_radius_auth
-.if !'po4a'hide' \-
-Squid RADIUS authentication helper
+basic_radius_auth \- Squid RADIUS authentication helper
 .
 .SH SYNOPSIS
 .if !'po4a'hide' .B basic_radius_auth
index f551d15cde50dbc8e62e646645cb5d7906a55f64..b6b6817341d2e392e134e2e637df006c7bc41c2c 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH basic_sasl_auth 8
 .
 .SH NAME
-.if !'po4a'hide' .B basic_sasl_auth
-.if !'po4a'hide' \-
-Basic Authentication using SASL (specifically the cyrus-sasl authentication method)
+basic_sasl_auth \- Basic Authentication using SASL (specifically the cyrus-sasl authentication method)
 .PP
 Version 1.0
 .
index 284d2e849f4c61a81f4d2d2f10ea619ec0e9c47a..6c84b50d3d88f49a1ff51a1b36a3b4703a8591c0 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH basic_sspi_auth.exe 8
 .
 .SH NAME
-.if !'po4a'hide' .B basic_sspi_auth.exe
-.if !'po4a'hide' \-
-Basic authentication protocol 
+basic_sspi_auth.exe \- Basic authentication protocol 
 .PP
 Version 2.0
 .
index 2e84a6578108daae7332da0f797d41bd55d2e443..ce57ea85be81722f01ce5200d0dd655cd88fd264 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH basic_getpwnam_auth 8
 .
 .SH NAME
-.if !'po4a'hide' .B basic_getpwnam_auth
-.if !'po4a'hide' \-
-Local Users auth helper for Squid
+basic_getpwnam_auth \- Local Users auth helper for Squid
 .
 .SH SYNOPSIS
 .if !'po4a'hide' .B basic_getpwnam_auth
index 3342ef81bd165f497dfcf00683d8e3c2b6c330fd..dee7c8921db016fe05c60a9b42984eb285c4e046 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH digest_file_auth 8
 .
 .SH NAME
-.if !'po4a'hide' .B digest_file_auth
-.if !'po4a'hide' \-
-File based digest authentication helper for Squid.
+digest_file_auth \- File based digest authentication helper for Squid.
 .PP
 Version 1.0
 .
index 1c1984504669b0549da9f31d1b98b1b1837c2837..e3e23e83d736d5a30d4c88e1f7d5ea34a6ffacf3 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH ext_ad_group_acl.exe 8
 .
 .SH NAME
-.if !'po4a'hide' .B ext_ad_group_acl.exe 
-.if !'po4a'hide' \-
-Squid external ACL helper to check Windows users group membership.
+ext_ad_group_acl.exe \- Squid external ACL helper to check Windows users group membership.
 .PP
 Version 2.0
 .
index 1aab94b2a8f423f7844a39d48958e5c91711cc1f..628f63c6856908af9636d8e01065b56121d1ae87 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH ext_ldap_group_acl 8 "30 January 2005"
 .
 .SH NAME
-.if !'po4a'hide' .B ext_ldap_group_acl
-.if !'po4a'hide' \-
-Squid LDAP external acl group helper
+ext_ldap_group_acl \- Squid LDAP external acl group helper
 .PP
 Version 2.17
 .
index af3084d8f7563acea6ea8eecc3e55b62fb21df84..8b35f85381ce42657222aaed1e41ae06b9afe835 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH ext_lm_group_acl 8
 .
 .SH NAME
-.if !'po4a'hide' .B ext_lm_group_acl
-.if !'po4a'hide' \-
-Squid external ACL helper to check Windows users group membership.
+ext_lm_group_acl \- Squid external ACL helper to check Windows users group membership.
 .PP
 Version 1.22
 .
index 36b187e98c92ed24f58ba28aa07a128310a421a7..1bd83063391ebf6b8aa35d6295b01ac344d78a85 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH ext_edirectory_userip_acl 8
 .
 .SH NAME
-.if !'po4a'hide' .B ext_edirectory_userip_acl
-.if !'po4a'hide' \-
-Squid eDirectory IP Lookup Helper
+ext_edirectory_userip_acl \- Squid eDirectory IP Lookup Helper
 .PP
 Version 2.0
 .
index eec2d8fb492c3502ff3c67331e53da64f92a7741..5f273e44cc7a68a62ff4a7a3998e8370602fb94b 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH ext_file_userip_acl 8
 .
 .SH NAME
-.if !'po4a'hide' .B ext_file_userip_acl
-.if !'po4a'hide' \-
-Restrict users to certain IP addresses, using a text file backend.
+ext_file_userip_acl \- Restrict users to certain IP addresses, using a text file backend.
 .PP
 Version 1.0
 .
index 87b1d26b8aa0e909c9341c69b612b726fd819abc..2d76c9a8b538ebb4aa11c09b514dfcbe3fa8fde6 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH ext_kerberos_ldap_group_acl 8
 .
 .SH NAME
-.if !'po4a'hide' .B ext_kerberos_ldap_group_acl
-.if !'po4a'hide' \-
-Squid LDAP external acl group helper for Kerberos or NTLM credentials.
+ext_kerberos_ldap_group_acl \- Squid LDAP external acl group helper for Kerberos or NTLM credentials.
 .PP
 Version 1.3.0sq
 .
index aba3b0229fd61fe34347b2da49c6efb4768929c1..116199df3787b8387827a767f7b2710073b7019a 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH ext_session_acl 8 "9 October 2011"
 .
 .SH NAME
-.if !'po4a'hide' .B ext_session_acl
-.if !'po4a'hide' \-
-Squid session tracking external acl helper.
+ext_session_acl \- Squid session tracking external acl helper.
 .PP
 Version 1.2
 .
index c53f6a7a6985b672056f83b09d2f267187a731e6..cb9cb621a20ec0cf3791cc3806580f188c0925dc 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH ext_time_quota_acl 8 "22 March 2011"
 .
 .SH NAME
-.if !'po4a'hide' .B ext_time_quota_acl
-.if !'po4a'hide' \-
-Squid time quota external acl helper.
+ext_time_quota_acl \- Squid time quota external acl helper.
 .PP
 Version 1.0
 .
index 6ff4b182121d13bf02ccbd9a7aef5010abcac471..27ce24e6d852aaecbff67529f134de6e6f60733b 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH ext_unix_group_acl 8 "12 August 2002"
 .
 .SH NAME
-.if !'po4a'hide' .B ext_unix_group_acl
-.if !'po4a'hide' \-
-Squid UNIX Group ACL helper
+ext_unix_group_acl \- Squid UNIX Group ACL helper
 .
 .SH SYNOPSIS
 .if !'po4a'hide' .B "ext_unix_group_acl [\-d] [\-g "
index ad332c53fdad1b7738e155f16cd48dbc6207d4e8..3f96ff1a7838c18bd78e76972626c0e81473bbe4 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH negotiate_kerberos_auth 8
 .
 .SH NAME
-.if !'po4a'hide' .B negotiate_kerberos_auth
-.if !'po4a'hide' \-
-Squid kerberos based authentication helper
+negotiate_kerberos_auth \- Squid kerberos based authentication helper
 .PP
 Version 3.0.4sq
 .
index 0ff47745e214e3589a56e7d6df651e3e62ec9e46..961ee25430d6f778bafefbe408cfbea847f191da 100644 (file)
@@ -1,10 +1,7 @@
 .if !'po4a'hide' .TH ntlm_sspi_auth.exe 8
 .
 .SH NAME
-.if !'po4a'hide' .B ntlm_sspi_auth.exe
-.if !'po4a'hide' \-
-Native Windows NTLM/NTLMv2 authenticator for Squid with
-automatic support for NTLM NEGOTIATE packets.
+ntlm_sspi_auth.exe \- Native Windows NTLM/NTLMv2 authenticator for Squid
 .PP
 Version 1.22
 .
index 778f209f9283f67ac5421d5a69dc9754ffb00900..8db46f8349ad23c0b25749a0168984fac2c49caa 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH ssl_crtd 8
 .
 .SH NAME
-.if !'po4a'hide' .B ssl_crtd
-.if !'po4a'hide' \-
-SSL certificate generator.
+ssl_crtd \- SSL certificate generator for Squid.
 .PP
 Version 1.0
 .
index f34fe0fb67658e324cdedb9c2109173e58c6b25f..326a37790313023747eccd53cf376134a474bbfa 100644 (file)
@@ -1,9 +1,7 @@
 .if !'po4a'hide' .TH squidclient 1
 .
 .SH NAME
-.if !'po4a'hide' .B squidclient
-.if !'po4a'hide' \-
-A simple HTTP web client tool
+squidclient \- A simple HTTP web client tool
 .
 .SH SYNOPSIS
 .if !'po4a'hide' .B squidclient
@@ -185,10 +183,11 @@ Proxy authentication password
 WWW authentication password
 .
 .SH AUTHOR
-Derived from Harvest. Further developed by by numerous individuals from
-the internet community. Development is led by Duane Wessels of the
-National Laboratory for Applied Network Research and funded by
-the National Science Foundation.
+This program and manual was written by
+.if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
+.PP
+Based on original code derived from Harvest and further developed by
+numerous individuals from the internet community.
 .
 .SH COPYRIGHT
 Distributed under the GNU General Public License (GNU GPL) version 2 or later (GPLv2+).