From: Amos Jeffries <squid3@treenet.co.nz>
Date: Fri, 31 Oct 2014 08:02:57 +0000 (-0700)
Subject: Fix man(8)/man(1) page syntax
X-Git-Tag: merge-candidate-3-v1~518
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=d632afde8f332d8ee4a094a044e53b0575d9c054;p=thirdparty%2Fsquid.git

Fix man(8)/man(1) page syntax

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.
---

diff --git a/helpers/basic_auth/LDAP/basic_ldap_auth.8 b/helpers/basic_auth/LDAP/basic_ldap_auth.8
index 45376850a2..b873c9d563 100644
--- a/helpers/basic_auth/LDAP/basic_ldap_auth.8
+++ b/helpers/basic_auth/LDAP/basic_ldap_auth.8
@@ -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
diff --git a/helpers/basic_auth/NCSA/basic_ncsa_auth.8 b/helpers/basic_auth/NCSA/basic_ncsa_auth.8
index 407e45b808..c06a0d167a 100644
--- a/helpers/basic_auth/NCSA/basic_ncsa_auth.8
+++ b/helpers/basic_auth/NCSA/basic_ncsa_auth.8
@@ -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
diff --git a/helpers/basic_auth/PAM/basic_pam_auth.8 b/helpers/basic_auth/PAM/basic_pam_auth.8
index a9ba722803..7d7f37efd8 100644
--- a/helpers/basic_auth/PAM/basic_pam_auth.8
+++ b/helpers/basic_auth/PAM/basic_pam_auth.8
@@ -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 \""
diff --git a/helpers/basic_auth/RADIUS/basic_radius_auth.8 b/helpers/basic_auth/RADIUS/basic_radius_auth.8
index 6e549e46ef..189ce40cb4 100644
--- a/helpers/basic_auth/RADIUS/basic_radius_auth.8
+++ b/helpers/basic_auth/RADIUS/basic_radius_auth.8
@@ -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
diff --git a/helpers/basic_auth/SASL/basic_sasl_auth.8 b/helpers/basic_auth/SASL/basic_sasl_auth.8
index ef70630f4c..8eff2e535d 100644
--- a/helpers/basic_auth/SASL/basic_sasl_auth.8
+++ b/helpers/basic_auth/SASL/basic_sasl_auth.8
@@ -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
 .
diff --git a/helpers/basic_auth/SSPI/basic_sspi_auth.8 b/helpers/basic_auth/SSPI/basic_sspi_auth.8
index 8e94c9346d..a9779a910f 100644
--- a/helpers/basic_auth/SSPI/basic_sspi_auth.8
+++ b/helpers/basic_auth/SSPI/basic_sspi_auth.8
@@ -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
 .
diff --git a/helpers/basic_auth/getpwnam/basic_getpwnam_auth.8 b/helpers/basic_auth/getpwnam/basic_getpwnam_auth.8
index 1974a7cba4..48d9775b64 100644
--- a/helpers/basic_auth/getpwnam/basic_getpwnam_auth.8
+++ b/helpers/basic_auth/getpwnam/basic_getpwnam_auth.8
@@ -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
diff --git a/helpers/digest_auth/file/digest_file_auth.8 b/helpers/digest_auth/file/digest_file_auth.8
index 211718c4f2..4e05c9b274 100644
--- a/helpers/digest_auth/file/digest_file_auth.8
+++ b/helpers/digest_auth/file/digest_file_auth.8
@@ -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.1
 .
diff --git a/helpers/external_acl/AD_group/ext_ad_group_acl.8 b/helpers/external_acl/AD_group/ext_ad_group_acl.8
index 0b5d9a11a2..3d82f38ae3 100644
--- a/helpers/external_acl/AD_group/ext_ad_group_acl.8
+++ b/helpers/external_acl/AD_group/ext_ad_group_acl.8
@@ -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
 .
diff --git a/helpers/external_acl/LDAP_group/ext_ldap_group_acl.8 b/helpers/external_acl/LDAP_group/ext_ldap_group_acl.8
index 67e9d7cf37..76e6c6b3e7 100644
--- a/helpers/external_acl/LDAP_group/ext_ldap_group_acl.8
+++ b/helpers/external_acl/LDAP_group/ext_ldap_group_acl.8
@@ -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
 .
diff --git a/helpers/external_acl/LM_group/ext_lm_group_acl.8 b/helpers/external_acl/LM_group/ext_lm_group_acl.8
index 68601d646a..045c0a3b67 100644
--- a/helpers/external_acl/LM_group/ext_lm_group_acl.8
+++ b/helpers/external_acl/LM_group/ext_lm_group_acl.8
@@ -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
 .
diff --git a/helpers/external_acl/eDirectory_userip/ext_edirectory_userip_acl.8 b/helpers/external_acl/eDirectory_userip/ext_edirectory_userip_acl.8
index e8efc49c6b..8b2692a6dd 100644
--- a/helpers/external_acl/eDirectory_userip/ext_edirectory_userip_acl.8
+++ b/helpers/external_acl/eDirectory_userip/ext_edirectory_userip_acl.8
@@ -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
 .
diff --git a/helpers/external_acl/file_userip/ext_file_userip_acl.8 b/helpers/external_acl/file_userip/ext_file_userip_acl.8
index f017373993..e02f13c2c4 100644
--- a/helpers/external_acl/file_userip/ext_file_userip_acl.8
+++ b/helpers/external_acl/file_userip/ext_file_userip_acl.8
@@ -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
 .
diff --git a/helpers/external_acl/kerberos_ldap_group/ext_kerberos_ldap_group_acl.8 b/helpers/external_acl/kerberos_ldap_group/ext_kerberos_ldap_group_acl.8
index edb32ea125..6d3e4ee55d 100644
--- a/helpers/external_acl/kerberos_ldap_group/ext_kerberos_ldap_group_acl.8
+++ b/helpers/external_acl/kerberos_ldap_group/ext_kerberos_ldap_group_acl.8
@@ -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
 .
diff --git a/helpers/external_acl/session/ext_session_acl.8 b/helpers/external_acl/session/ext_session_acl.8
index af544b030e..3d2069d9f5 100644
--- a/helpers/external_acl/session/ext_session_acl.8
+++ b/helpers/external_acl/session/ext_session_acl.8
@@ -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
 .
diff --git a/helpers/external_acl/time_quota/ext_time_quota_acl.8 b/helpers/external_acl/time_quota/ext_time_quota_acl.8
index 9daaf96f1e..07a527c6d4 100644
--- a/helpers/external_acl/time_quota/ext_time_quota_acl.8
+++ b/helpers/external_acl/time_quota/ext_time_quota_acl.8
@@ -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
 .
diff --git a/helpers/external_acl/unix_group/ext_unix_group_acl.8 b/helpers/external_acl/unix_group/ext_unix_group_acl.8
index 2bbb4c0044..1ab23c8b25 100644
--- a/helpers/external_acl/unix_group/ext_unix_group_acl.8
+++ b/helpers/external_acl/unix_group/ext_unix_group_acl.8
@@ -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 "
diff --git a/helpers/negotiate_auth/kerberos/negotiate_kerberos_auth.8 b/helpers/negotiate_auth/kerberos/negotiate_kerberos_auth.8
index 3a5090f524..27d21bd6ef 100644
--- a/helpers/negotiate_auth/kerberos/negotiate_kerberos_auth.8
+++ b/helpers/negotiate_auth/kerberos/negotiate_kerberos_auth.8
@@ -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
 .
diff --git a/helpers/ntlm_auth/SSPI/ntlm_sspi_auth.8 b/helpers/ntlm_auth/SSPI/ntlm_sspi_auth.8
index dbe955ca37..53167b407d 100644
--- a/helpers/ntlm_auth/SSPI/ntlm_sspi_auth.8
+++ b/helpers/ntlm_auth/SSPI/ntlm_sspi_auth.8
@@ -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
 .
diff --git a/src/ssl/ssl_crtd.8 b/src/ssl/ssl_crtd.8
index c50f0a58ac..9f67f02dac 100644
--- a/src/ssl/ssl_crtd.8
+++ b/src/ssl/ssl_crtd.8
@@ -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
 .
diff --git a/tools/squidclient/squidclient.1 b/tools/squidclient/squidclient.1
index 5fb1d9576c..b0627674c1 100644
--- a/tools/squidclient/squidclient.1
+++ b/tools/squidclient/squidclient.1
@@ -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
@@ -227,10 +225,11 @@ iterations (default is to loop until interrupted).
 Ping interval in seconds (default 1 second).
 .
 .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
 .PP