[PATCH 08/42] doc: improve formatting of command synopses (1/2)

"G. Branden Robinson" <[email protected]> Tue, 18 Nov 2025 21:45:10 -0600

Newsgroups	gmane.comp.gnu.findutils.bugs
Message-ID	<20251119034510.uoewjkm2uw4ltgvg@illithid>

* find/find.1:
* locate/locate.1: Use `HP` hanging paragraph macro to indent
  non-initial lines of synopsis.  Temporarily disable adjustment.

An alternative approach would be to use groff man(7)'s `SY` and `YS`
extension macros; each man page would then need to define local versions
for portability to DWB 3.3, Plan 9, and Solaris 10 troffs.
---
 find/find.1     | 5 +++++
 locate/locate.1 | 5 +++++
 2 files changed, 10 insertions(+)

diff --git a/find/find.1 b/find/find.1
index 21036c89..191a6638 100644
--- a/find/find.1
+++ b/find/find.1
@@ -3,6 +3,9 @@
 .SH NAME
 find \- search for files in a directory hierarchy
 .SH SYNOPSIS
+.HP
+.nr sA \n(.j \" Save the adjustment mode.
+.na
 .B find
 .RB [ \-H ]
 .RB [ \-L ]
@@ -13,6 +16,8 @@ .SH SYNOPSIS
 .IR level ]
 .RI [ starting-point .\|.\|.]\&
 .RI [ expression ]
+.ad \n(sA \" Restore the adjustment mode.
+.rr sA
 .
 .SH DESCRIPTION
 This manual page
diff --git a/locate/locate.1 b/locate/locate.1
index c366daa2..25571fed 100644
--- a/locate/locate.1
+++ b/locate/locate.1
@@ -11,6 +11,9 @@ .SH NAME
 locate \- list files in databases that match a pattern
 .
 .SH SYNOPSIS
+.HP
+.nr sA \n(.j \" Save the adjustment mode.
+.na
 .B locate
 .RB [ \-d
 .I path
@@ -69,6 +72,8 @@ .SH SYNOPSIS
 .BR \*%\-\-print ]
 .RB \*%[ \-\-help ]
 .IR pattern .\|.\|.
+.ad \n(sA \" Restore the adjustment mode.
+.rr sA
 .
 .SH DESCRIPTION
 This manual page
-- 
2.30.2

signature.asc (application/pgp-signature, 833 B)